Get payment invoice

Retrieves the payment invoice for the specified shipment

GET /commerce/shipments/{shipmentNumber}/invoice

Error

A valid request URL is required to generate request examples

200

{
  "_links": {
    "empty": true
  },
  "currency": "<string>",
  "data": {},
  "invoiceDate": "2023-11-07T05:31:56Z",
  "invoiceNumber": "<string>",
  "lineItems": [
    {
      "data": {},
      "description": "<string>",
      "lineItemType": "<string>",
      "quantity": 123,
      "sku": "<string>",
      "totalPrice": 123,
      "unitPrice": 123
    }
  ],
  "rawEdiData": "<string>",
  "references": {
    "data": {},
    "orderNumber": 123,
    "purchaseOrderNumber": "<string>",
    "shipmentId": "<string>"
  },
  "taxes": [
    {
      "amount": 123,
      "data": {},
      "jurisdiction": "<string>",
      "rate": 123,
      "type": "<string>"
    }
  ],
  "terms": {
    "data": {},
    "dueDate": "2023-11-07T05:31:56Z",
    "paymentTerms": "<string>"
  },
  "totalAmount": 123,
  "vendor": {
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "address4": "<string>",
      "addressType": "Commercial",
      "attributes": {},
      "cityOrTown": "<string>",
      "countryCode": "<string>",
      "isValidated": true,
      "latitude": "<string>",
      "longitude": "<string>",
      "postalOrZipCode": "<string>",
      "stateOrProvince": "<string>"
    },
    "data": {},
    "name": "<string>",
    "taxId": "<string>",
    "vendorId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Headers

x-vol-site · integer<int32>

x-vol-tenant · integer<int32> · required

Path Parameters

shipmentNumber · integer<int32> · required

Shipment number

Response

200

application/hal+json

OK

_links · Links · object

Show child attributes

currency · string

data · object

invoiceDate · string<date-time>

invoiceNumber · string

lineItems · InvoiceLineItem · object[]

Show child attributes

rawEdiData · string

references · InvoiceReferences · object

Show child attributes

taxes · InvoiceTax · object[]

Show child attributes

terms · InvoiceTerms · object

Show child attributes

totalAmount · number

vendor · InvoiceVendor · object

Show child attributes