POST api/Invoice/InvoiceLineList

Returns a list of invoice line details

Request Information

URI Parameters

None.

Body Parameters

Invoice Line Request

InvoiceLineRequest
Name Type Description Additional information
PageNumber integer

PageSize integer

InvoiceRefNumber string

Invoice number

BillingShipDateStart string

BillingShipDateEnd string

OrderOrTrackingNumbers Collection of string

Order or tracking numbers to search by

BillingEventTypes Collection of string

Billing event types. Values: Fulfillment, InvoiceAdjustment, Logistics, Production, Shipping, Storage, VolumeDiscount

Carriers Collection of string

Carriers

Zones Collection of string

Zones

ShipToPostalCodes Collection of string

Ship to postal codes

ShipToCountries Collection of string

Ship to countries

ChargeTypes Collection of string

Charge types: Values: Accessorial, Adjustment, BaseRate, CaseFee, ClaimRefundOther, ClaimRefundFedEx, ClaimRefundUPS, ClaimRefundUSPS, CorrugatedMfg, Credit, FinanceCharge, FuelSurcharge, Labor, LessThanTruckload, LineFee, ManagementFee, MarkupPercent, Miscellaneous, NonConformance, NotBillable, OrderFee, OrderFeeDiscount, OtherMode, Packaging, PackingMaterials, ProductionKitting, ProductionOrder, Receipt, ReturnLine, ReturnOrder, ReturnUnit, RoutingGuide, ServiceCharge, SmallLocationCost, Storage, Tax, ThirdParty, TransactionFee, Truckload, UnitFee, WorkOrders

Categories Collection of string

Categories

SubCategories Collection of string

Sub Categories

ServiceTypes Collection of string

Service Types

WarehouseLocations Collection of string

Warehouses: Values: Atlanta, Memphis, WestChester, WestJordan, WestValley, Columbia, Denver, Emporia, Fife, Irving, LosAngeles, Orlando, Ringgold, StGeorge, ThirdParty, WileyPost

Request Formats

application/json, text/json

Sample: 
{
  "PageNumber": 1,
  "PageSize": 1,
  "InvoiceRefNumber": "sample string 1",
  "BillingShipDateStart": "sample string 2",
  "BillingShipDateEnd": "sample string 3",
  "OrderOrTrackingNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "BillingEventTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Carriers": [
    "sample string 1",
    "sample string 2"
  ],
  "Zones": [
    "sample string 1",
    "sample string 2"
  ],
  "ShipToPostalCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "ShipToCountries": [
    "sample string 1",
    "sample string 2"
  ],
  "ChargeTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Categories": [
    "sample string 1",
    "sample string 2"
  ],
  "SubCategories": [
    "sample string 1",
    "sample string 2"
  ],
  "ServiceTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "WarehouseLocations": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<InvoiceLineRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <InvoiceRefNumber>sample string 1</InvoiceRefNumber>
  <BillingShipDateStart>sample string 2</BillingShipDateStart>
  <BillingShipDateEnd>sample string 3</BillingShipDateEnd>
  <OrderOrTrackingNumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </OrderOrTrackingNumbers>
  <BillingEventTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </BillingEventTypes>
  <Carriers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Carriers>
  <Zones>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Zones>
  <ShipToPostalCodes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ShipToPostalCodes>
  <ShipToCountries>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ShipToCountries>
  <ChargeTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ChargeTypes>
  <Categories>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Categories>
  <SubCategories>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </SubCategories>
  <ServiceTypes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ServiceTypes>
  <WarehouseLocations>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </WarehouseLocations>
</InvoiceLineRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Invoice Line Details

InvoiceLinePageResponse
Name Type Description Additional information
IsSuccessful boolean

Message string

PagePublishedAmount decimal number

TotalPublishedAmount decimal number

PageDiscountAmount integer

TotalDiscountAmount integer

PageInvoicedAmount decimal number

TotalInvoicedAmount decimal number

Page integer

Count integer

TotalPage integer

TotalCount integer

List Collection of InvoiceLineResponse

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "Message": "sample string 2",
  "PagePublishedAmount": 3.0,
  "TotalPublishedAmount": 4.0,
  "PageDiscountAmount": 5,
  "TotalDiscountAmount": 6,
  "PageInvoicedAmount": 7.0,
  "TotalInvoicedAmount": 8.0,
  "Page": 9,
  "Count": 10,
  "TotalPage": 11,
  "TotalCount": 12,
  "List": [
    {
      "InvoiceRefNumber": "sample string 1",
      "InvoiceStatus": "sample string 2",
      "BillingEventType": "sample string 3",
      "BillingShipDate": "2025-01-18T05:05:16.8786932+00:00",
      "BillingInvoiceDate": "2025-01-18T05:05:16.8786932+00:00",
      "BillingEventGuid": "sample string 4",
      "BillingEventParentGuid": "sample string 5",
      "BusinessUnit": "sample string 6",
      "WarehouseLocation": "sample string 7",
      "InternalOrderNumber": "sample string 8",
      "ExternalOrderNumber": "sample string 9",
      "Category": "sample string 10",
      "SubCategory": "sample string 11",
      "Description": "sample string 12",
      "TotalPublishedAmount": 13.0,
      "TotalDiscountAmount": 14,
      "TotalInvoicedAmount": 15.0,
      "Quantity": 16,
      "Carrier": "sample string 17",
      "ServiceType": "sample string 18",
      "Accessorial": "sample string 19",
      "ChargeType": "sample string 20",
      "TrackingNumber": "sample string 21",
      "RatedWeight": "sample string 22",
      "RatedWeightUOM": "sample string 23",
      "PackageDimLength": "sample string 24",
      "PackageDimHeight": "sample string 25",
      "PackageDimWidth": "sample string 26",
      "PackageDimUOM": "sample string 27",
      "IsRatedDimensionalWeight": "sample string 28",
      "IsCubic": "sample string 29",
      "CubicValue": "sample string 30",
      "Zone": "sample string 31",
      "ShipFromPostalCode": "sample string 32",
      "ShipFromCountry": "sample string 33",
      "ShipToPostalCode": "sample string 34",
      "ShipToCountry": "sample string 35",
      "TMSOfficeLocation": "sample string 36",
      "TMSLoadId": "sample string 37",
      "TMSBilledAmount": "sample string 38",
      "TMSPickupDate": "2025-01-18T05:05:16.8786932+00:00",
      "TMSDeliveryDate": "2025-01-18T05:05:16.8786932+00:00",
      "TMSCarrierId": "sample string 39",
      "TMSCarrier": "sample string 40",
      "TMSReference": "sample string 41",
      "TMSNMFC": "sample string 42",
      "TMSProNumber": "sample string 43",
      "TMSWeight": "sample string 44",
      "TMSPieceCount": "sample string 45",
      "TMSPalletCount": "sample string 46",
      "TMSClass": "sample string 47",
      "TMSPayerID": "sample string 48",
      "TMSPONumber": "sample string 49",
      "TMSShipper": "sample string 50",
      "TMSShipFromAddress1": "sample string 51",
      "TMSShipFromAddress2": "sample string 52",
      "TMSShipFromCity": "sample string 53",
      "TMSShipFromState": "sample string 54",
      "TMSShipFromZip": "sample string 55",
      "TMSShipFromCountry": "sample string 56",
      "TMSConsignee": "sample string 57",
      "TMSShipToAddress1": "sample string 58",
      "TMSShipToAddress2": "sample string 59",
      "TMSShipToCity": "sample string 60",
      "TMSShipToState": "sample string 61",
      "TMSShipToZip": "sample string 62",
      "TMSShipToCountry": "sample string 63",
      "TMSShipperNumber": "sample string 64",
      "TMSContainerNumber": "sample string 65",
      "TMSOceanBol": "sample string 66",
      "TMSPickupNumber": "sample string 67",
      "TMSBolNumber": "sample string 68",
      "TMSTrailerNumber": "sample string 69"
    },
    {
      "InvoiceRefNumber": "sample string 1",
      "InvoiceStatus": "sample string 2",
      "BillingEventType": "sample string 3",
      "BillingShipDate": "2025-01-18T05:05:16.8786932+00:00",
      "BillingInvoiceDate": "2025-01-18T05:05:16.8786932+00:00",
      "BillingEventGuid": "sample string 4",
      "BillingEventParentGuid": "sample string 5",
      "BusinessUnit": "sample string 6",
      "WarehouseLocation": "sample string 7",
      "InternalOrderNumber": "sample string 8",
      "ExternalOrderNumber": "sample string 9",
      "Category": "sample string 10",
      "SubCategory": "sample string 11",
      "Description": "sample string 12",
      "TotalPublishedAmount": 13.0,
      "TotalDiscountAmount": 14,
      "TotalInvoicedAmount": 15.0,
      "Quantity": 16,
      "Carrier": "sample string 17",
      "ServiceType": "sample string 18",
      "Accessorial": "sample string 19",
      "ChargeType": "sample string 20",
      "TrackingNumber": "sample string 21",
      "RatedWeight": "sample string 22",
      "RatedWeightUOM": "sample string 23",
      "PackageDimLength": "sample string 24",
      "PackageDimHeight": "sample string 25",
      "PackageDimWidth": "sample string 26",
      "PackageDimUOM": "sample string 27",
      "IsRatedDimensionalWeight": "sample string 28",
      "IsCubic": "sample string 29",
      "CubicValue": "sample string 30",
      "Zone": "sample string 31",
      "ShipFromPostalCode": "sample string 32",
      "ShipFromCountry": "sample string 33",
      "ShipToPostalCode": "sample string 34",
      "ShipToCountry": "sample string 35",
      "TMSOfficeLocation": "sample string 36",
      "TMSLoadId": "sample string 37",
      "TMSBilledAmount": "sample string 38",
      "TMSPickupDate": "2025-01-18T05:05:16.8786932+00:00",
      "TMSDeliveryDate": "2025-01-18T05:05:16.8786932+00:00",
      "TMSCarrierId": "sample string 39",
      "TMSCarrier": "sample string 40",
      "TMSReference": "sample string 41",
      "TMSNMFC": "sample string 42",
      "TMSProNumber": "sample string 43",
      "TMSWeight": "sample string 44",
      "TMSPieceCount": "sample string 45",
      "TMSPalletCount": "sample string 46",
      "TMSClass": "sample string 47",
      "TMSPayerID": "sample string 48",
      "TMSPONumber": "sample string 49",
      "TMSShipper": "sample string 50",
      "TMSShipFromAddress1": "sample string 51",
      "TMSShipFromAddress2": "sample string 52",
      "TMSShipFromCity": "sample string 53",
      "TMSShipFromState": "sample string 54",
      "TMSShipFromZip": "sample string 55",
      "TMSShipFromCountry": "sample string 56",
      "TMSConsignee": "sample string 57",
      "TMSShipToAddress1": "sample string 58",
      "TMSShipToAddress2": "sample string 59",
      "TMSShipToCity": "sample string 60",
      "TMSShipToState": "sample string 61",
      "TMSShipToZip": "sample string 62",
      "TMSShipToCountry": "sample string 63",
      "TMSShipperNumber": "sample string 64",
      "TMSContainerNumber": "sample string 65",
      "TMSOceanBol": "sample string 66",
      "TMSPickupNumber": "sample string 67",
      "TMSBolNumber": "sample string 68",
      "TMSTrailerNumber": "sample string 69"
    }
  ]
}

application/xml, text/xml

Sample: 
<InvoiceLinePageResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
  <PagePublishedAmount>3</PagePublishedAmount>
  <TotalPublishedAmount>4</TotalPublishedAmount>
  <PageDiscountAmount>5</PageDiscountAmount>
  <TotalDiscountAmount>6</TotalDiscountAmount>
  <PageInvoicedAmount>7</PageInvoicedAmount>
  <TotalInvoicedAmount>8</TotalInvoicedAmount>
  <Page>9</Page>
  <Count>10</Count>
  <TotalPage>11</TotalPage>
  <TotalCount>12</TotalCount>
  <List>
    <InvoiceLineResponse>
      <InvoiceRefNumber>sample string 1</InvoiceRefNumber>
      <InvoiceStatus>sample string 2</InvoiceStatus>
      <BillingEventType>sample string 3</BillingEventType>
      <BillingShipDate>2025-01-18T05:05:16.8786932+00:00</BillingShipDate>
      <BillingInvoiceDate>2025-01-18T05:05:16.8786932+00:00</BillingInvoiceDate>
      <BillingEventGuid>sample string 4</BillingEventGuid>
      <BillingEventParentGuid>sample string 5</BillingEventParentGuid>
      <BusinessUnit>sample string 6</BusinessUnit>
      <WarehouseLocation>sample string 7</WarehouseLocation>
      <InternalOrderNumber>sample string 8</InternalOrderNumber>
      <ExternalOrderNumber>sample string 9</ExternalOrderNumber>
      <Category>sample string 10</Category>
      <SubCategory>sample string 11</SubCategory>
      <Description>sample string 12</Description>
      <TotalPublishedAmount>13</TotalPublishedAmount>
      <TotalDiscountAmount>14</TotalDiscountAmount>
      <TotalInvoicedAmount>15</TotalInvoicedAmount>
      <Quantity>16</Quantity>
      <Carrier>sample string 17</Carrier>
      <ServiceType>sample string 18</ServiceType>
      <Accessorial>sample string 19</Accessorial>
      <ChargeType>sample string 20</ChargeType>
      <TrackingNumber>sample string 21</TrackingNumber>
      <RatedWeight>sample string 22</RatedWeight>
      <RatedWeightUom>sample string 23</RatedWeightUom>
      <PackageDimLength>sample string 24</PackageDimLength>
      <PackageDimHeight>sample string 25</PackageDimHeight>
      <PackageDimWidth>sample string 26</PackageDimWidth>
      <PackageDimUom>sample string 27</PackageDimUom>
      <IsRatedDimensionalWeight>sample string 28</IsRatedDimensionalWeight>
      <IsCubic>sample string 29</IsCubic>
      <CubicValue>sample string 30</CubicValue>
      <Zone>sample string 31</Zone>
      <ShipFromPostalCode>sample string 32</ShipFromPostalCode>
      <ShipFromCountry>sample string 33</ShipFromCountry>
      <ShipToPostalCode>sample string 34</ShipToPostalCode>
      <ShipToCountry>sample string 35</ShipToCountry>
      <TMSOfficeLocation>sample string 36</TMSOfficeLocation>
      <TmsLoadId>sample string 37</TmsLoadId>
      <TmsBilledAmount>sample string 38</TmsBilledAmount>
      <TmsPickupDate>2025-01-18T05:05:16.8786932+00:00</TmsPickupDate>
      <TmsDeliveryDate>2025-01-18T05:05:16.8786932+00:00</TmsDeliveryDate>
      <TmsCarrierId>sample string 39</TmsCarrierId>
      <TmsCarrier>sample string 40</TmsCarrier>
      <TmsReference>sample string 41</TmsReference>
      <Tmsnmfc>sample string 42</Tmsnmfc>
      <TmsProNumber>sample string 43</TmsProNumber>
      <TmsWeight>sample string 44</TmsWeight>
      <TmsPieceCount>sample string 45</TmsPieceCount>
      <TmsPalletCount>sample string 46</TmsPalletCount>
      <TmsClass>sample string 47</TmsClass>
      <TmsPayerId>sample string 48</TmsPayerId>
      <TmspoNumber>sample string 49</TmspoNumber>
      <TMSShipper>sample string 50</TMSShipper>
      <TmsShipFromAddress1>sample string 51</TmsShipFromAddress1>
      <TmsShipFromAddress2>sample string 52</TmsShipFromAddress2>
      <TmsShipFromCity>sample string 53</TmsShipFromCity>
      <TmsShipFromState>sample string 54</TmsShipFromState>
      <TmsShipFromZip>sample string 55</TmsShipFromZip>
      <TmsShipFromCountry>sample string 56</TmsShipFromCountry>
      <TmsConsignee>sample string 57</TmsConsignee>
      <TmsShipToAddress1>sample string 58</TmsShipToAddress1>
      <TmsShipToAddress2>sample string 59</TmsShipToAddress2>
      <TmsShipToCity>sample string 60</TmsShipToCity>
      <TmsShipToState>sample string 61</TmsShipToState>
      <TmsShipToZip>sample string 62</TmsShipToZip>
      <TmsShipToCountry>sample string 63</TmsShipToCountry>
      <TMSShipperNumber>sample string 64</TMSShipperNumber>
      <TMSContainerNumber>sample string 65</TMSContainerNumber>
      <TMSOceanBol>sample string 66</TMSOceanBol>
      <TMSPickupNumber>sample string 67</TMSPickupNumber>
      <TMSBolNumber>sample string 68</TMSBolNumber>
      <TMSTrailerNumber>sample string 69</TMSTrailerNumber>
    </InvoiceLineResponse>
    <InvoiceLineResponse>
      <InvoiceRefNumber>sample string 1</InvoiceRefNumber>
      <InvoiceStatus>sample string 2</InvoiceStatus>
      <BillingEventType>sample string 3</BillingEventType>
      <BillingShipDate>2025-01-18T05:05:16.8786932+00:00</BillingShipDate>
      <BillingInvoiceDate>2025-01-18T05:05:16.8786932+00:00</BillingInvoiceDate>
      <BillingEventGuid>sample string 4</BillingEventGuid>
      <BillingEventParentGuid>sample string 5</BillingEventParentGuid>
      <BusinessUnit>sample string 6</BusinessUnit>
      <WarehouseLocation>sample string 7</WarehouseLocation>
      <InternalOrderNumber>sample string 8</InternalOrderNumber>
      <ExternalOrderNumber>sample string 9</ExternalOrderNumber>
      <Category>sample string 10</Category>
      <SubCategory>sample string 11</SubCategory>
      <Description>sample string 12</Description>
      <TotalPublishedAmount>13</TotalPublishedAmount>
      <TotalDiscountAmount>14</TotalDiscountAmount>
      <TotalInvoicedAmount>15</TotalInvoicedAmount>
      <Quantity>16</Quantity>
      <Carrier>sample string 17</Carrier>
      <ServiceType>sample string 18</ServiceType>
      <Accessorial>sample string 19</Accessorial>
      <ChargeType>sample string 20</ChargeType>
      <TrackingNumber>sample string 21</TrackingNumber>
      <RatedWeight>sample string 22</RatedWeight>
      <RatedWeightUom>sample string 23</RatedWeightUom>
      <PackageDimLength>sample string 24</PackageDimLength>
      <PackageDimHeight>sample string 25</PackageDimHeight>
      <PackageDimWidth>sample string 26</PackageDimWidth>
      <PackageDimUom>sample string 27</PackageDimUom>
      <IsRatedDimensionalWeight>sample string 28</IsRatedDimensionalWeight>
      <IsCubic>sample string 29</IsCubic>
      <CubicValue>sample string 30</CubicValue>
      <Zone>sample string 31</Zone>
      <ShipFromPostalCode>sample string 32</ShipFromPostalCode>
      <ShipFromCountry>sample string 33</ShipFromCountry>
      <ShipToPostalCode>sample string 34</ShipToPostalCode>
      <ShipToCountry>sample string 35</ShipToCountry>
      <TMSOfficeLocation>sample string 36</TMSOfficeLocation>
      <TmsLoadId>sample string 37</TmsLoadId>
      <TmsBilledAmount>sample string 38</TmsBilledAmount>
      <TmsPickupDate>2025-01-18T05:05:16.8786932+00:00</TmsPickupDate>
      <TmsDeliveryDate>2025-01-18T05:05:16.8786932+00:00</TmsDeliveryDate>
      <TmsCarrierId>sample string 39</TmsCarrierId>
      <TmsCarrier>sample string 40</TmsCarrier>
      <TmsReference>sample string 41</TmsReference>
      <Tmsnmfc>sample string 42</Tmsnmfc>
      <TmsProNumber>sample string 43</TmsProNumber>
      <TmsWeight>sample string 44</TmsWeight>
      <TmsPieceCount>sample string 45</TmsPieceCount>
      <TmsPalletCount>sample string 46</TmsPalletCount>
      <TmsClass>sample string 47</TmsClass>
      <TmsPayerId>sample string 48</TmsPayerId>
      <TmspoNumber>sample string 49</TmspoNumber>
      <TMSShipper>sample string 50</TMSShipper>
      <TmsShipFromAddress1>sample string 51</TmsShipFromAddress1>
      <TmsShipFromAddress2>sample string 52</TmsShipFromAddress2>
      <TmsShipFromCity>sample string 53</TmsShipFromCity>
      <TmsShipFromState>sample string 54</TmsShipFromState>
      <TmsShipFromZip>sample string 55</TmsShipFromZip>
      <TmsShipFromCountry>sample string 56</TmsShipFromCountry>
      <TmsConsignee>sample string 57</TmsConsignee>
      <TmsShipToAddress1>sample string 58</TmsShipToAddress1>
      <TmsShipToAddress2>sample string 59</TmsShipToAddress2>
      <TmsShipToCity>sample string 60</TmsShipToCity>
      <TmsShipToState>sample string 61</TmsShipToState>
      <TmsShipToZip>sample string 62</TmsShipToZip>
      <TmsShipToCountry>sample string 63</TmsShipToCountry>
      <TMSShipperNumber>sample string 64</TMSShipperNumber>
      <TMSContainerNumber>sample string 65</TMSContainerNumber>
      <TMSOceanBol>sample string 66</TMSOceanBol>
      <TMSPickupNumber>sample string 67</TMSPickupNumber>
      <TMSBolNumber>sample string 68</TMSBolNumber>
      <TMSTrailerNumber>sample string 69</TMSTrailerNumber>
    </InvoiceLineResponse>
  </List>
</InvoiceLinePageResponse>