GET api/Invoice?User={User}&Pass={Pass}&InvoiceNumber={InvoiceNumber}

Use this function to retrieve the data associated with a specific invoice. A seperate API has also been made available for retrieving an image rendition of the invoice.

Request Information

URI Parameters

Name	Description	Type	Additional information
User	Enter the Logon Code assigned to your account (1-8 characters)	string	Required
Pass	Enter the Password associated with your Logon Code	string	Required
InvoiceNumber	Enter the appropriate invoice number (value between 1 and 2147483647)	string	Required

Body Parameters

None.

Response Information

Resource Description

an XML or JSON representation of the invoice and its line item details.

Invoice

Name	Description	Type	Additional information
ErrorInfo	This field will be emtpy (blank) if the API Request was processed without error; Otherwise, information pertaining to the nature of the error(s) encountered will be included.	string	None.
Comment	Additional supporting information provided on successfully processing an API request; may include a total count for the number of invoice line items returned.	string	None.
InvoiceNumber	Documents the invoice number requested	string	None.
InvoiceDate	Shows the invoice date for the invoice requested	string	None.
InvoiceAmount	Shows the total original amount of charges for this invoice	string	None.
InvoiceBalance	Shows the remaining open balance for charges associated with this invoice	string	None.
InvoiceDetails	Contains a list of invoice details, provided in support of the Invoice Amount. (Drill-down for further details)	Collection of InvDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorInfo": "sample string 1",
  "Comment": "sample string 2",
  "InvoiceNumber": "sample string 3",
  "InvoiceDate": "sample string 4",
  "InvoiceAmount": "sample string 5",
  "InvoiceBalance": "sample string 6",
  "InvoiceDetails": [
    {
      "ProNumber": "sample string 1",
      "ProType": "sample string 2",
      "BOL": "sample string 3",
      "PONumber": "sample string 4",
      "InternalRef": "sample string 5",
      "SID": "sample string 6",
      "ShipperName": "sample string 7",
      "ShipperCity": "sample string 8",
      "ShipperState": "sample string 9",
      "ShipperZip": "sample string 10",
      "ConsigneeName": "sample string 11",
      "ConsigneeCity": "sample string 12",
      "ConsigneeState": "sample string 13",
      "ConsigneeZip": "sample string 14",
      "PickupDate": "sample string 15",
      "DeliveryDate": "sample string 16",
      "OriginalCharges": "sample string 17",
      "BalanceDue": "sample string 18"
    },
    {
      "ProNumber": "sample string 1",
      "ProType": "sample string 2",
      "BOL": "sample string 3",
      "PONumber": "sample string 4",
      "InternalRef": "sample string 5",
      "SID": "sample string 6",
      "ShipperName": "sample string 7",
      "ShipperCity": "sample string 8",
      "ShipperState": "sample string 9",
      "ShipperZip": "sample string 10",
      "ConsigneeName": "sample string 11",
      "ConsigneeCity": "sample string 12",
      "ConsigneeState": "sample string 13",
      "ConsigneeZip": "sample string 14",
      "PickupDate": "sample string 15",
      "DeliveryDate": "sample string 16",
      "OriginalCharges": "sample string 17",
      "BalanceDue": "sample string 18"
    }
  ]
}

application/xml, text/xml

Sample:

<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <Comment>sample string 2</Comment>
  <ErrorInfo>sample string 1</ErrorInfo>
  <InvoiceAmount>sample string 5</InvoiceAmount>
  <InvoiceBalance>sample string 6</InvoiceBalance>
  <InvoiceDate>sample string 4</InvoiceDate>
  <InvoiceDetails>
    <InvDetail>
      <BOL>sample string 3</BOL>
      <BalanceDue>sample string 18</BalanceDue>
      <ConsigneeCity>sample string 12</ConsigneeCity>
      <ConsigneeName>sample string 11</ConsigneeName>
      <ConsigneeState>sample string 13</ConsigneeState>
      <ConsigneeZip>sample string 14</ConsigneeZip>
      <DeliveryDate>sample string 16</DeliveryDate>
      <InternalRef>sample string 5</InternalRef>
      <OriginalCharges>sample string 17</OriginalCharges>
      <PONumber>sample string 4</PONumber>
      <PickupDate>sample string 15</PickupDate>
      <ProNumber>sample string 1</ProNumber>
      <ProType>sample string 2</ProType>
      <SID>sample string 6</SID>
      <ShipperCity>sample string 8</ShipperCity>
      <ShipperName>sample string 7</ShipperName>
      <ShipperState>sample string 9</ShipperState>
      <ShipperZip>sample string 10</ShipperZip>
    </InvDetail>
    <InvDetail>
      <BOL>sample string 3</BOL>
      <BalanceDue>sample string 18</BalanceDue>
      <ConsigneeCity>sample string 12</ConsigneeCity>
      <ConsigneeName>sample string 11</ConsigneeName>
      <ConsigneeState>sample string 13</ConsigneeState>
      <ConsigneeZip>sample string 14</ConsigneeZip>
      <DeliveryDate>sample string 16</DeliveryDate>
      <InternalRef>sample string 5</InternalRef>
      <OriginalCharges>sample string 17</OriginalCharges>
      <PONumber>sample string 4</PONumber>
      <PickupDate>sample string 15</PickupDate>
      <ProNumber>sample string 1</ProNumber>
      <ProType>sample string 2</ProType>
      <SID>sample string 6</SID>
      <ShipperCity>sample string 8</ShipperCity>
      <ShipperName>sample string 7</ShipperName>
      <ShipperState>sample string 9</ShipperState>
      <ShipperZip>sample string 10</ShipperZip>
    </InvDetail>
  </InvoiceDetails>
  <InvoiceNumber>sample string 3</InvoiceNumber>
</Invoice>