GET invoice/detail/{customerNumber}/{invoiceNumber}?excludeSerialTracking={excludeSerialTracking}

Invoice Detail - returns details about an invoice including serial and tracking numbers

Request Information

URI Parameters

Name	Description	Type	Additional information
customerNumber	Your Customer Number	string	None.
invoiceNumber	Invoice Number	string	None.
excludeSerialTracking	Optional flag to exclude serial/Tracking #s in detail response	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

SalesOrder

Invoice

Name	Description	Type	Additional information
InvoiceNumber	Invoice Number	string	None.
SalesOrderNumber	Sales Order Number	string	None.
BillingAddress	Billing Address	Address	None.
ShippingAddress	Shipping Address	Address	None.
PONumber	Purchase Order Number	string	None.
EndUserPO	End User Purchase Order Number	string	None.
ReferenceNumber	ReferenceNumber	string	None.
ShipDate	Ship Date Time	date	None.
Cancelled	Cancelled Date Time	date	None.
DocType	Document Type	string	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 InvoiceLine	None.
TrackingNumbers	List of tracking #s	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "InvoiceNumber": "sample string 1",
  "SalesOrderNumber": "sample string 2",
  "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"
  },
  "PONumber": "sample string 3",
  "EndUserPO": "sample string 4",
  "ReferenceNumber": "sample string 5",
  "ShipDate": "2024-04-19T14:09:59.3991272-04:00",
  "Cancelled": "2024-04-19T14:09:59.3991272-04:00",
  "DocType": "sample string 7",
  "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": 2.0,
      "POLineNumber": 1.0,
      "ReferenceLineNumber": "sample string 3",
      "ItemNumber": "sample string 4",
      "ProductMfrPart": "sample string 5",
      "ItemDescription": "sample string 6",
      "ItemCatCode": "sample string 7",
      "Ordered": 8.0,
      "Committed": 9.0,
      "BackOrdered": 10.0,
      "Shipped": 11.0,
      "Price": 12.0,
      "Currency": "sample string 13",
      "DeliveryNumber": "sample string 14",
      "DeliveryLineNumber": 1,
      "SerialNumbers": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "LineNumber": 2.0,
      "POLineNumber": 1.0,
      "ReferenceLineNumber": "sample string 3",
      "ItemNumber": "sample string 4",
      "ProductMfrPart": "sample string 5",
      "ItemDescription": "sample string 6",
      "ItemCatCode": "sample string 7",
      "Ordered": 8.0,
      "Committed": 9.0,
      "BackOrdered": 10.0,
      "Shipped": 11.0,
      "Price": 12.0,
      "Currency": "sample string 13",
      "DeliveryNumber": "sample string 14",
      "DeliveryLineNumber": 1,
      "SerialNumbers": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "TrackingNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<Invoice xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <SalesOrderNumber>sample string 2</SalesOrderNumber>
  <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>
  <PONumber>sample string 3</PONumber>
  <EndUserPO>sample string 4</EndUserPO>
  <ReferenceNumber>sample string 5</ReferenceNumber>
  <ShipDate>2024-04-19T14:09:59.3991272-04:00</ShipDate>
  <Cancelled>2024-04-19T14:09:59.3991272-04:00</Cancelled>
  <DocType>sample string 7</DocType>
  <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>
    <InvoiceLine>
      <Id>1</Id>
      <LineNumber>2</LineNumber>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>sample string 3</ReferenceLineNumber>
      <ItemNumber>sample string 4</ItemNumber>
      <ProductMfrPart>sample string 5</ProductMfrPart>
      <ItemDescription>sample string 6</ItemDescription>
      <ItemCatCode>sample string 7</ItemCatCode>
      <Ordered>8</Ordered>
      <Committed>9</Committed>
      <BackOrdered>10</BackOrdered>
      <Shipped>11</Shipped>
      <Price>12</Price>
      <Currency>sample string 13</Currency>
      <DeliveryNumber>sample string 14</DeliveryNumber>
      <DeliveryLineNumber>1</DeliveryLineNumber>
      <SerialNumbers>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SerialNumbers>
    </InvoiceLine>
    <InvoiceLine>
      <Id>1</Id>
      <LineNumber>2</LineNumber>
      <POLineNumber>1</POLineNumber>
      <ReferenceLineNumber>sample string 3</ReferenceLineNumber>
      <ItemNumber>sample string 4</ItemNumber>
      <ProductMfrPart>sample string 5</ProductMfrPart>
      <ItemDescription>sample string 6</ItemDescription>
      <ItemCatCode>sample string 7</ItemCatCode>
      <Ordered>8</Ordered>
      <Committed>9</Committed>
      <BackOrdered>10</BackOrdered>
      <Shipped>11</Shipped>
      <Price>12</Price>
      <Currency>sample string 13</Currency>
      <DeliveryNumber>sample string 14</DeliveryNumber>
      <DeliveryLineNumber>1</DeliveryLineNumber>
      <SerialNumbers>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SerialNumbers>
    </InvoiceLine>
  </InvoiceLines>
  <TrackingNumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </TrackingNumbers>
</Invoice>