GET invoice/summary/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&invoiceNumber={invoiceNumber}&poNumber={poNumber}&fromDate={fromDate}&toDate={toDate}
Get Invoice Summary allows customers to get a paged list of invoices. Search parameters can be specified to search by serial numbers and mac addresses within a given date range
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerNumber |
Your Customer Number |
string |
None. |
page |
Page Number |
integer |
Default value is 1 |
pageSize |
Number of results per page |
integer |
Default value is 100 |
salesOrderNumber |
Sales Order Number |
string |
None. |
invoiceNumber |
Invoice Number |
string |
None. |
poNumber |
Purchase Order Number |
string |
None. |
fromDate |
Start date range |
string |
None. |
toDate |
End date range |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of InvoiceSummaryName | Description | Type | Additional information |
---|---|---|---|
OrderNumber |
Sales Order Number |
string |
None. |
InvoiceNumber |
Invoice Number |
string |
None. |
PONumber |
Your Purchase Order Number |
string |
None. |
DocType |
Document Type |
string |
None. |
Total |
Total order amount |
decimal number |
None. |
ShippingOption |
Shipping option |
string |
None. |
ShippingOptionDescription |
Shipping option description |
string |
None. |
DateEntered |
Date stamp when invoice was created |
string |
None. |
LastChanged |
Date stamp for when invoice was last updated |
string |
None. |
Response Formats
application/json, text/json
[ { "OrderNumber": "sample string 1", "InvoiceNumber": "sample string 2", "PONumber": "sample string 3", "DocType": "sample string 4", "Total": 5.0, "ShippingOption": "sample string 6", "ShippingOptionDescription": "sample string 7", "DateEntered": "sample string 8", "LastChanged": "sample string 9" }, { "OrderNumber": "sample string 1", "InvoiceNumber": "sample string 2", "PONumber": "sample string 3", "DocType": "sample string 4", "Total": 5.0, "ShippingOption": "sample string 6", "ShippingOptionDescription": "sample string 7", "DateEntered": "sample string 8", "LastChanged": "sample string 9" } ]
application/xml, text/xml
<ArrayOfInvoiceSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <InvoiceSummary> <OrderNumber>sample string 1</OrderNumber> <InvoiceNumber>sample string 2</InvoiceNumber> <PONumber>sample string 3</PONumber> <DocType>sample string 4</DocType> <Total>5</Total> <ShippingOption>sample string 6</ShippingOption> <ShippingOptionDescription>sample string 7</ShippingOptionDescription> <DateEntered>sample string 8</DateEntered> <LastChanged>sample string 9</LastChanged> </InvoiceSummary> <InvoiceSummary> <OrderNumber>sample string 1</OrderNumber> <InvoiceNumber>sample string 2</InvoiceNumber> <PONumber>sample string 3</PONumber> <DocType>sample string 4</DocType> <Total>5</Total> <ShippingOption>sample string 6</ShippingOption> <ShippingOptionDescription>sample string 7</ShippingOptionDescription> <DateEntered>sample string 8</DateEntered> <LastChanged>sample string 9</LastChanged> </InvoiceSummary> </ArrayOfInvoiceSummary>