GET api/v2/invoice
Returns invoice and tracking information for orders
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderNumber |
A list of customer assigned idenfiers for the orders. |
Collection of string |
None. |
| InvoiceNumber | Collection of string |
None. |
|
| Filters | Collection of AdvancedInvoiceFilters |
None. |
Response Information
Resource Description
InvoiceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Invoices |
List of order statuses |
Collection of Invoice |
None. |
Response Formats
Sample:
{
"Invoices": [
{
"OrderNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"PurchaseOrderNumber": "sample string 3",
"ShipToAccountNumber": "sample string 4",
"ShipToAddress1": "sample string 5",
"ShipToAddress2": "sample string 6",
"ShipToAddress3": "sample string 7",
"ShipToCity": "sample string 8",
"ShipToState": "sample string 9",
"ShipToZip": "sample string 10",
"ShipToProvince": "sample string 11",
"ShipToCountry": "sample string 12",
"Status": "sample string 13",
"OrderTotal": 1.0,
"InvoiceTotal": 1.0,
"TotalDue": 1.0,
"SalesTax": 1.0,
"PostageAndHandling": 1.0,
"InvoiceDate": "2024-04-27T23:09:24.9322846-05:00",
"OrderDate": "2024-04-27T23:09:24.9322846-05:00",
"ShipMethod": "sample string 14",
"TrackingNumber": "sample string 15",
"TrackingLink": "sample string 16",
"GoldMarketRate": 17.0,
"GoldMarketBase": 18.0,
"GoldMarketAdder": "sample string 19",
"PlatinumMarketRate": 20.0,
"SilverMarketRate": 23.0,
"PlatinumMarketBase": 21.0,
"SilverMarketBase": 24.0,
"PlatinumMarketAdder": "sample string 22",
"SilverMarketAdder": "sample string 25",
"InvoiceDetails": [
{
"LineNumber": 1,
"CustomerLineReference": "sample string 2",
"ItemNumber": "sample string 3",
"ItemDescription": "sample string 4",
"ShipQuantity": 5.0,
"BackOrderedQuantity": 6,
"LaborOtherCharges": "sample string 7",
"TotalWeight": "sample string 8",
"UnitPrice": 9.0,
"LineTotal": 10.0,
"CustomerNotes": "sample string 11",
"UnitPriceUnitOfMeasure": "sample string 12"
},
{
"LineNumber": 1,
"CustomerLineReference": "sample string 2",
"ItemNumber": "sample string 3",
"ItemDescription": "sample string 4",
"ShipQuantity": 5.0,
"BackOrderedQuantity": 6,
"LaborOtherCharges": "sample string 7",
"TotalWeight": "sample string 8",
"UnitPrice": 9.0,
"LineTotal": 10.0,
"CustomerNotes": "sample string 11",
"UnitPriceUnitOfMeasure": "sample string 12"
}
]
},
{
"OrderNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"PurchaseOrderNumber": "sample string 3",
"ShipToAccountNumber": "sample string 4",
"ShipToAddress1": "sample string 5",
"ShipToAddress2": "sample string 6",
"ShipToAddress3": "sample string 7",
"ShipToCity": "sample string 8",
"ShipToState": "sample string 9",
"ShipToZip": "sample string 10",
"ShipToProvince": "sample string 11",
"ShipToCountry": "sample string 12",
"Status": "sample string 13",
"OrderTotal": 1.0,
"InvoiceTotal": 1.0,
"TotalDue": 1.0,
"SalesTax": 1.0,
"PostageAndHandling": 1.0,
"InvoiceDate": "2024-04-27T23:09:24.9322846-05:00",
"OrderDate": "2024-04-27T23:09:24.9322846-05:00",
"ShipMethod": "sample string 14",
"TrackingNumber": "sample string 15",
"TrackingLink": "sample string 16",
"GoldMarketRate": 17.0,
"GoldMarketBase": 18.0,
"GoldMarketAdder": "sample string 19",
"PlatinumMarketRate": 20.0,
"SilverMarketRate": 23.0,
"PlatinumMarketBase": 21.0,
"SilverMarketBase": 24.0,
"PlatinumMarketAdder": "sample string 22",
"SilverMarketAdder": "sample string 25",
"InvoiceDetails": [
{
"LineNumber": 1,
"CustomerLineReference": "sample string 2",
"ItemNumber": "sample string 3",
"ItemDescription": "sample string 4",
"ShipQuantity": 5.0,
"BackOrderedQuantity": 6,
"LaborOtherCharges": "sample string 7",
"TotalWeight": "sample string 8",
"UnitPrice": 9.0,
"LineTotal": 10.0,
"CustomerNotes": "sample string 11",
"UnitPriceUnitOfMeasure": "sample string 12"
},
{
"LineNumber": 1,
"CustomerLineReference": "sample string 2",
"ItemNumber": "sample string 3",
"ItemDescription": "sample string 4",
"ShipQuantity": 5.0,
"BackOrderedQuantity": 6,
"LaborOtherCharges": "sample string 7",
"TotalWeight": "sample string 8",
"UnitPrice": 9.0,
"LineTotal": 10.0,
"CustomerNotes": "sample string 11",
"UnitPriceUnitOfMeasure": "sample string 12"
}
]
}
]
}
Sample:
<InvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Invoices>
<Invoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<OrderNumber>sample string 1</OrderNumber>
<PurchaseOrderNumber>sample string 3</PurchaseOrderNumber>
<ShipToAccountNumber>sample string 4</ShipToAccountNumber>
<ShipToAddress1>sample string 5</ShipToAddress1>
<ShipToAddress2>sample string 6</ShipToAddress2>
<ShipToAddress3>sample string 7</ShipToAddress3>
<ShipToCity>sample string 8</ShipToCity>
<ShipToState>sample string 9</ShipToState>
<ShipToZip>sample string 10</ShipToZip>
<ShipToProvince>sample string 11</ShipToProvince>
<ShipToCountry>sample string 12</ShipToCountry>
<Status>sample string 13</Status>
<OrderTotal>1</OrderTotal>
<InvoiceTotal>1</InvoiceTotal>
<TotalDue>1</TotalDue>
<SalesTax>1</SalesTax>
<PostageAndHandling>1</PostageAndHandling>
<InvoiceDate>2024-04-27T23:09:24.9322846-05:00</InvoiceDate>
<OrderDate>2024-04-27T23:09:24.9322846-05:00</OrderDate>
<ShipMethod>sample string 14</ShipMethod>
<TrackingNumber>sample string 15</TrackingNumber>
<TrackingLink>sample string 16</TrackingLink>
<GoldMarketRate>17</GoldMarketRate>
<GoldMarketBase>18</GoldMarketBase>
<GoldMarketAdder>sample string 19</GoldMarketAdder>
<PlatinumMarketRate>20</PlatinumMarketRate>
<SilverMarketRate>23</SilverMarketRate>
<PlatinumMarketBase>21</PlatinumMarketBase>
<SilverMarketBase>24</SilverMarketBase>
<PlatinumMarketAdder>sample string 22</PlatinumMarketAdder>
<SilverMarketAdder>sample string 25</SilverMarketAdder>
<InvoiceDetails>
<InvoiceDetail>
<LineNumber>1</LineNumber>
<CustomerLineReference>sample string 2</CustomerLineReference>
<ItemNumber>sample string 3</ItemNumber>
<ItemDescription>sample string 4</ItemDescription>
<ShipQuantity>5</ShipQuantity>
<BackOrderedQuantity>6</BackOrderedQuantity>
<LaborOtherCharges>sample string 7</LaborOtherCharges>
<TotalWeight>sample string 8</TotalWeight>
<UnitPrice>9</UnitPrice>
<LineTotal>10</LineTotal>
<CustomerNotes>sample string 11</CustomerNotes>
<UnitPriceUnitOfMeasure>sample string 12</UnitPriceUnitOfMeasure>
</InvoiceDetail>
<InvoiceDetail>
<LineNumber>1</LineNumber>
<CustomerLineReference>sample string 2</CustomerLineReference>
<ItemNumber>sample string 3</ItemNumber>
<ItemDescription>sample string 4</ItemDescription>
<ShipQuantity>5</ShipQuantity>
<BackOrderedQuantity>6</BackOrderedQuantity>
<LaborOtherCharges>sample string 7</LaborOtherCharges>
<TotalWeight>sample string 8</TotalWeight>
<UnitPrice>9</UnitPrice>
<LineTotal>10</LineTotal>
<CustomerNotes>sample string 11</CustomerNotes>
<UnitPriceUnitOfMeasure>sample string 12</UnitPriceUnitOfMeasure>
</InvoiceDetail>
</InvoiceDetails>
</Invoice>
<Invoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<OrderNumber>sample string 1</OrderNumber>
<PurchaseOrderNumber>sample string 3</PurchaseOrderNumber>
<ShipToAccountNumber>sample string 4</ShipToAccountNumber>
<ShipToAddress1>sample string 5</ShipToAddress1>
<ShipToAddress2>sample string 6</ShipToAddress2>
<ShipToAddress3>sample string 7</ShipToAddress3>
<ShipToCity>sample string 8</ShipToCity>
<ShipToState>sample string 9</ShipToState>
<ShipToZip>sample string 10</ShipToZip>
<ShipToProvince>sample string 11</ShipToProvince>
<ShipToCountry>sample string 12</ShipToCountry>
<Status>sample string 13</Status>
<OrderTotal>1</OrderTotal>
<InvoiceTotal>1</InvoiceTotal>
<TotalDue>1</TotalDue>
<SalesTax>1</SalesTax>
<PostageAndHandling>1</PostageAndHandling>
<InvoiceDate>2024-04-27T23:09:24.9322846-05:00</InvoiceDate>
<OrderDate>2024-04-27T23:09:24.9322846-05:00</OrderDate>
<ShipMethod>sample string 14</ShipMethod>
<TrackingNumber>sample string 15</TrackingNumber>
<TrackingLink>sample string 16</TrackingLink>
<GoldMarketRate>17</GoldMarketRate>
<GoldMarketBase>18</GoldMarketBase>
<GoldMarketAdder>sample string 19</GoldMarketAdder>
<PlatinumMarketRate>20</PlatinumMarketRate>
<SilverMarketRate>23</SilverMarketRate>
<PlatinumMarketBase>21</PlatinumMarketBase>
<SilverMarketBase>24</SilverMarketBase>
<PlatinumMarketAdder>sample string 22</PlatinumMarketAdder>
<SilverMarketAdder>sample string 25</SilverMarketAdder>
<InvoiceDetails>
<InvoiceDetail>
<LineNumber>1</LineNumber>
<CustomerLineReference>sample string 2</CustomerLineReference>
<ItemNumber>sample string 3</ItemNumber>
<ItemDescription>sample string 4</ItemDescription>
<ShipQuantity>5</ShipQuantity>
<BackOrderedQuantity>6</BackOrderedQuantity>
<LaborOtherCharges>sample string 7</LaborOtherCharges>
<TotalWeight>sample string 8</TotalWeight>
<UnitPrice>9</UnitPrice>
<LineTotal>10</LineTotal>
<CustomerNotes>sample string 11</CustomerNotes>
<UnitPriceUnitOfMeasure>sample string 12</UnitPriceUnitOfMeasure>
</InvoiceDetail>
<InvoiceDetail>
<LineNumber>1</LineNumber>
<CustomerLineReference>sample string 2</CustomerLineReference>
<ItemNumber>sample string 3</ItemNumber>
<ItemDescription>sample string 4</ItemDescription>
<ShipQuantity>5</ShipQuantity>
<BackOrderedQuantity>6</BackOrderedQuantity>
<LaborOtherCharges>sample string 7</LaborOtherCharges>
<TotalWeight>sample string 8</TotalWeight>
<UnitPrice>9</UnitPrice>
<LineTotal>10</LineTotal>
<CustomerNotes>sample string 11</CustomerNotes>
<UnitPriceUnitOfMeasure>sample string 12</UnitPriceUnitOfMeasure>
</InvoiceDetail>
</InvoiceDetails>
</Invoice>
</Invoices>
</InvoiceResponse>