GET invoice/list/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&invoiceNumber={invoiceNumber}&poNumber={poNumber}&fromDate={fromDate}&toDate={toDate}
Get Invoice List allows customers to get a paged list of invoices with details.
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 InvoiceListName | Description | Type | Additional information |
---|---|---|---|
InvoiceNumber |
Invoice Number |
string |
None. |
SalesOrderNumber |
Sales Order Number |
string |
None. |
PONumber |
Your Purchase Order Number |
string |
None. |
EndUserPO |
End User Purchase Order Number |
string |
None. |
ReferenceNumber |
ReferenceNumber |
string |
None. |
DocType |
Document Type |
string |
None. |
BillingAddress |
Billing Address |
Address |
None. |
ShippingAddress |
Shipping Address |
Address |
None. |
ShipDate |
Ship Date Time |
date |
None. |
SalesRepCode |
SalesRepCode |
string |
None. |
SalesRepName |
SalesRepName |
string |
None. |
SalesRepEmail |
SalesRepEmail |
string |
None. |
FreightAmount |
Freight Amount |
decimal number |
Data type: Currency |
TaxAmount |
Tax Amount |
decimal number |
Data type: Currency |
InsuranceAmount |
Insurance Amount |
decimal number |
Data type: Currency |
Total |
Total Order Amount |
decimal number |
Data type: Currency |
Currency |
Currency code for amounts. USD – US Dollars, CAD- Canadian Dollars, EUR- Euro, GBP- British Pound |
string |
None. |
EnteredByEmail |
email address of user that create order if specified |
string |
None. |
ShippingOption |
Shipping option |
string |
None. |
ShippingOptionDescription |
Shipping option description |
string |
None. |
InvoiceLines |
List of lines |
Collection of InvoiceListLine |
None. |
TrackingNumbers |
List of tracking #s |
Collection of string |
None. |
Response Formats
application/json, text/json
[ { "InvoiceNumber": "sample string 1", "SalesOrderNumber": "sample string 2", "PONumber": "sample string 3", "EndUserPO": "sample string 4", "ReferenceNumber": "sample string 5", "DocType": "sample string 6", "BillingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "ShippingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "ShipDate": "2025-01-18T00:01:32.1653975-05:00", "SalesRepCode": "sample string 8", "SalesRepName": "sample string 9", "SalesRepEmail": "sample string 10", "FreightAmount": 11.0, "TaxAmount": 12.0, "InsuranceAmount": 13.0, "Total": 14.0, "Currency": "sample string 15", "EnteredByEmail": "sample string 16", "ShippingOption": "sample string 17", "ShippingOptionDescription": "sample string 18", "InvoiceLines": [ { "LineNumber": 1.0, "POLineNumber": 1.0, "ReferenceLineNumber": "sample string 2", "ItemNumber": "sample string 3", "ProductMfrPart": "sample string 4", "ItemDescription": "sample string 5", "Ordered": 6.0, "Committed": 7.0, "BackOrdered": 8.0, "Shipped": 9.0, "Price": 10.0, "Currency": "sample string 11", "SerialNumbers": [ "sample string 1", "sample string 2" ] }, { "LineNumber": 1.0, "POLineNumber": 1.0, "ReferenceLineNumber": "sample string 2", "ItemNumber": "sample string 3", "ProductMfrPart": "sample string 4", "ItemDescription": "sample string 5", "Ordered": 6.0, "Committed": 7.0, "BackOrdered": 8.0, "Shipped": 9.0, "Price": 10.0, "Currency": "sample string 11", "SerialNumbers": [ "sample string 1", "sample string 2" ] } ], "TrackingNumbers": [ "sample string 1", "sample string 2" ] }, { "InvoiceNumber": "sample string 1", "SalesOrderNumber": "sample string 2", "PONumber": "sample string 3", "EndUserPO": "sample string 4", "ReferenceNumber": "sample string 5", "DocType": "sample string 6", "BillingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "ShippingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "ShipDate": "2025-01-18T00:01:32.1653975-05:00", "SalesRepCode": "sample string 8", "SalesRepName": "sample string 9", "SalesRepEmail": "sample string 10", "FreightAmount": 11.0, "TaxAmount": 12.0, "InsuranceAmount": 13.0, "Total": 14.0, "Currency": "sample string 15", "EnteredByEmail": "sample string 16", "ShippingOption": "sample string 17", "ShippingOptionDescription": "sample string 18", "InvoiceLines": [ { "LineNumber": 1.0, "POLineNumber": 1.0, "ReferenceLineNumber": "sample string 2", "ItemNumber": "sample string 3", "ProductMfrPart": "sample string 4", "ItemDescription": "sample string 5", "Ordered": 6.0, "Committed": 7.0, "BackOrdered": 8.0, "Shipped": 9.0, "Price": 10.0, "Currency": "sample string 11", "SerialNumbers": [ "sample string 1", "sample string 2" ] }, { "LineNumber": 1.0, "POLineNumber": 1.0, "ReferenceLineNumber": "sample string 2", "ItemNumber": "sample string 3", "ProductMfrPart": "sample string 4", "ItemDescription": "sample string 5", "Ordered": 6.0, "Committed": 7.0, "BackOrdered": 8.0, "Shipped": 9.0, "Price": 10.0, "Currency": "sample string 11", "SerialNumbers": [ "sample string 1", "sample string 2" ] } ], "TrackingNumbers": [ "sample string 1", "sample string 2" ] } ]
application/xml, text/xml
<ArrayOfInvoiceList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <InvoiceList> <InvoiceNumber>sample string 1</InvoiceNumber> <SalesOrderNumber>sample string 2</SalesOrderNumber> <PONumber>sample string 3</PONumber> <EndUserPO>sample string 4</EndUserPO> <ReferenceNumber>sample string 5</ReferenceNumber> <DocType>sample string 6</DocType> <BillingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </BillingAddress> <ShippingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </ShippingAddress> <ShipDate>2025-01-18T00:01:32.1653975-05:00</ShipDate> <SalesRepCode>sample string 8</SalesRepCode> <SalesRepName>sample string 9</SalesRepName> <SalesRepEmail>sample string 10</SalesRepEmail> <FreightAmount>11</FreightAmount> <TaxAmount>12</TaxAmount> <InsuranceAmount>13</InsuranceAmount> <Total>14</Total> <Currency>sample string 15</Currency> <EnteredByEmail>sample string 16</EnteredByEmail> <ShippingOption>sample string 17</ShippingOption> <ShippingOptionDescription>sample string 18</ShippingOptionDescription> <InvoiceLines> <InvoiceListLine> <LineNumber>1</LineNumber> <POLineNumber>1</POLineNumber> <ReferenceLineNumber>sample string 2</ReferenceLineNumber> <ItemNumber>sample string 3</ItemNumber> <ProductMfrPart>sample string 4</ProductMfrPart> <ItemDescription>sample string 5</ItemDescription> <Ordered>6</Ordered> <Committed>7</Committed> <BackOrdered>8</BackOrdered> <Shipped>9</Shipped> <Price>10</Price> <Currency>sample string 11</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> </InvoiceListLine> <InvoiceListLine> <LineNumber>1</LineNumber> <POLineNumber>1</POLineNumber> <ReferenceLineNumber>sample string 2</ReferenceLineNumber> <ItemNumber>sample string 3</ItemNumber> <ProductMfrPart>sample string 4</ProductMfrPart> <ItemDescription>sample string 5</ItemDescription> <Ordered>6</Ordered> <Committed>7</Committed> <BackOrdered>8</BackOrdered> <Shipped>9</Shipped> <Price>10</Price> <Currency>sample string 11</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> </InvoiceListLine> </InvoiceLines> <TrackingNumbers> <string>sample string 1</string> <string>sample string 2</string> </TrackingNumbers> </InvoiceList> <InvoiceList> <InvoiceNumber>sample string 1</InvoiceNumber> <SalesOrderNumber>sample string 2</SalesOrderNumber> <PONumber>sample string 3</PONumber> <EndUserPO>sample string 4</EndUserPO> <ReferenceNumber>sample string 5</ReferenceNumber> <DocType>sample string 6</DocType> <BillingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </BillingAddress> <ShippingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </ShippingAddress> <ShipDate>2025-01-18T00:01:32.1653975-05:00</ShipDate> <SalesRepCode>sample string 8</SalesRepCode> <SalesRepName>sample string 9</SalesRepName> <SalesRepEmail>sample string 10</SalesRepEmail> <FreightAmount>11</FreightAmount> <TaxAmount>12</TaxAmount> <InsuranceAmount>13</InsuranceAmount> <Total>14</Total> <Currency>sample string 15</Currency> <EnteredByEmail>sample string 16</EnteredByEmail> <ShippingOption>sample string 17</ShippingOption> <ShippingOptionDescription>sample string 18</ShippingOptionDescription> <InvoiceLines> <InvoiceListLine> <LineNumber>1</LineNumber> <POLineNumber>1</POLineNumber> <ReferenceLineNumber>sample string 2</ReferenceLineNumber> <ItemNumber>sample string 3</ItemNumber> <ProductMfrPart>sample string 4</ProductMfrPart> <ItemDescription>sample string 5</ItemDescription> <Ordered>6</Ordered> <Committed>7</Committed> <BackOrdered>8</BackOrdered> <Shipped>9</Shipped> <Price>10</Price> <Currency>sample string 11</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> </InvoiceListLine> <InvoiceListLine> <LineNumber>1</LineNumber> <POLineNumber>1</POLineNumber> <ReferenceLineNumber>sample string 2</ReferenceLineNumber> <ItemNumber>sample string 3</ItemNumber> <ProductMfrPart>sample string 4</ProductMfrPart> <ItemDescription>sample string 5</ItemDescription> <Ordered>6</Ordered> <Committed>7</Committed> <BackOrdered>8</BackOrdered> <Shipped>9</Shipped> <Price>10</Price> <Currency>sample string 11</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> </InvoiceListLine> </InvoiceLines> <TrackingNumbers> <string>sample string 1</string> <string>sample string 2</string> </TrackingNumbers> </InvoiceList> </ArrayOfInvoiceList>