GET api/audBackBill?fromDate={fromDate}&toDate={toDate}&displayOption={displayOption}
Returns data used in BackBill summary
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| fromDate | date |
Required |
|
| toDate | date |
Required |
|
| displayOption | string |
Default value is open |
Body Parameters
None.
Response Information
Resource Description
Collection of audBackBillSummary| Name | Description | Type | Additional information |
|---|---|---|---|
| ChargeID | integer |
None. |
|
| ClientID | integer |
None. |
|
| SurchargeTypeID | integer |
None. |
|
| SurchargeTypeName | string |
None. |
|
| ChargeDescription | string |
None. |
|
| ServiceDescription | string |
None. |
|
| CarrierCharges | decimal number |
None. |
|
| CarrierRate | decimal number |
None. |
|
| IsAdditionalCharge | boolean |
None. |
|
| BilledCharges | decimal number |
None. |
|
| Margin | decimal number |
None. |
|
| PackageMargin | decimal number |
None. |
|
| BulkBackBill | boolean |
None. |
|
| DefaultBackBillMargin | decimal number |
None. |
|
| DefaultBillOption | string |
None. |
|
| DefaultAddAmount | decimal number |
None. |
|
| DefaultAddPercent | decimal number |
None. |
|
| WarehouseID | integer |
None. |
|
| PackageID | integer |
None. |
|
| TrackingNumber | string |
None. |
|
| AuditPackageTrackingNumber | string |
None. |
|
| AuditCarrierID | integer |
None. |
|
| ShipPackageID | integer |
None. |
|
| ShipOrderID | integer |
None. |
|
| ImportPackageID | integer |
None. |
|
| ManifestPackageID | integer |
None. |
|
| ManifestShipmentID | integer |
None. |
|
| CarrierName | string |
None. |
|
| ServiceCode | string |
None. |
|
| Service | string |
None. |
|
| ClientName | string |
None. |
|
| PaymentType | string |
None. |
|
| ShipDiscount | decimal number |
None. |
|
| Shipper | string |
None. |
|
| Consignee | string |
None. |
|
| DateShipped | date |
None. |
|
| InvoiceNumber | string |
None. |
|
| InvoiceDate | date |
None. |
|
| PackageNumber | integer |
None. |
|
| ActualWeight | decimal number |
None. |
|
| ShipWeight | decimal number |
None. |
|
| BilledWeight | decimal number |
None. |
|
| ShipDims | string |
None. |
|
| BilledDims | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ChargeID": 1,
"ClientID": 2,
"SurchargeTypeID": 3,
"SurchargeTypeName": "sample string 4",
"ChargeDescription": "sample string 5",
"ServiceDescription": "sample string 6",
"CarrierCharges": 7.0,
"CarrierRate": 8.0,
"IsAdditionalCharge": true,
"BilledCharges": 10.0,
"Margin": 11.0,
"PackageMargin": 12.0,
"BulkBackBill": true,
"DefaultBackBillMargin": 14.0,
"DefaultBillOption": "sample string 15",
"DefaultAddAmount": 16.0,
"DefaultAddPercent": 17.0,
"WarehouseID": 18,
"PackageID": 19,
"TrackingNumber": "sample string 20",
"AuditPackageTrackingNumber": "sample string 21",
"AuditCarrierID": 22,
"ShipPackageID": 23,
"ShipOrderID": 24,
"ImportPackageID": 25,
"ManifestPackageID": 26,
"ManifestShipmentID": 27,
"CarrierName": "sample string 28",
"ServiceCode": "sample string 29",
"Service": "sample string 30",
"ClientName": "sample string 31",
"PaymentType": "sample string 32",
"ShipDiscount": 33.0,
"Shipper": "sample string 34",
"Consignee": "sample string 35",
"DateShipped": "2025-12-06T23:39:42.6325205+00:00",
"InvoiceNumber": "sample string 36",
"InvoiceDate": "2025-12-06T23:39:42.6325205+00:00",
"PackageNumber": 37,
"ActualWeight": 38.0,
"ShipWeight": 39.0,
"BilledWeight": 40.0,
"ShipDims": "sample string 41",
"BilledDims": "sample string 42"
},
{
"ChargeID": 1,
"ClientID": 2,
"SurchargeTypeID": 3,
"SurchargeTypeName": "sample string 4",
"ChargeDescription": "sample string 5",
"ServiceDescription": "sample string 6",
"CarrierCharges": 7.0,
"CarrierRate": 8.0,
"IsAdditionalCharge": true,
"BilledCharges": 10.0,
"Margin": 11.0,
"PackageMargin": 12.0,
"BulkBackBill": true,
"DefaultBackBillMargin": 14.0,
"DefaultBillOption": "sample string 15",
"DefaultAddAmount": 16.0,
"DefaultAddPercent": 17.0,
"WarehouseID": 18,
"PackageID": 19,
"TrackingNumber": "sample string 20",
"AuditPackageTrackingNumber": "sample string 21",
"AuditCarrierID": 22,
"ShipPackageID": 23,
"ShipOrderID": 24,
"ImportPackageID": 25,
"ManifestPackageID": 26,
"ManifestShipmentID": 27,
"CarrierName": "sample string 28",
"ServiceCode": "sample string 29",
"Service": "sample string 30",
"ClientName": "sample string 31",
"PaymentType": "sample string 32",
"ShipDiscount": 33.0,
"Shipper": "sample string 34",
"Consignee": "sample string 35",
"DateShipped": "2025-12-06T23:39:42.6325205+00:00",
"InvoiceNumber": "sample string 36",
"InvoiceDate": "2025-12-06T23:39:42.6325205+00:00",
"PackageNumber": 37,
"ActualWeight": 38.0,
"ShipWeight": 39.0,
"BilledWeight": 40.0,
"ShipDims": "sample string 41",
"BilledDims": "sample string 42"
}
]
application/xml, text/xml
Sample:
<ArrayOfaudBackBillSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
<audBackBillSummary>
<ActualWeight>38</ActualWeight>
<AuditCarrierID>22</AuditCarrierID>
<AuditPackageTrackingNumber>sample string 21</AuditPackageTrackingNumber>
<BilledDims>sample string 42</BilledDims>
<BilledWeight>40</BilledWeight>
<CarrierName>sample string 28</CarrierName>
<ClientName>sample string 31</ClientName>
<Consignee>sample string 35</Consignee>
<DateShipped>2025-12-06T23:39:42.6325205+00:00</DateShipped>
<ImportPackageID>25</ImportPackageID>
<InvoiceDate>2025-12-06T23:39:42.6325205+00:00</InvoiceDate>
<InvoiceNumber>sample string 36</InvoiceNumber>
<ManifestPackageID>26</ManifestPackageID>
<ManifestShipmentID>27</ManifestShipmentID>
<PackageID>19</PackageID>
<PackageNumber>37</PackageNumber>
<PaymentType>sample string 32</PaymentType>
<Service>sample string 30</Service>
<ServiceCode>sample string 29</ServiceCode>
<ShipDims>sample string 41</ShipDims>
<ShipDiscount>33</ShipDiscount>
<ShipOrderID>24</ShipOrderID>
<ShipPackageID>23</ShipPackageID>
<ShipWeight>39</ShipWeight>
<Shipper>sample string 34</Shipper>
<TrackingNumber>sample string 20</TrackingNumber>
<BilledCharges>10</BilledCharges>
<BulkBackBill>true</BulkBackBill>
<CarrierCharges>7</CarrierCharges>
<CarrierRate>8</CarrierRate>
<ChargeDescription>sample string 5</ChargeDescription>
<ChargeID>1</ChargeID>
<ClientID>2</ClientID>
<DefaultAddAmount>16</DefaultAddAmount>
<DefaultAddPercent>17</DefaultAddPercent>
<DefaultBackBillMargin>14</DefaultBackBillMargin>
<DefaultBillOption>sample string 15</DefaultBillOption>
<IsAdditionalCharge>true</IsAdditionalCharge>
<Margin>11</Margin>
<PackageMargin>12</PackageMargin>
<ServiceDescription>sample string 6</ServiceDescription>
<SurchargeTypeID>3</SurchargeTypeID>
<SurchargeTypeName>sample string 4</SurchargeTypeName>
<WarehouseID>18</WarehouseID>
</audBackBillSummary>
<audBackBillSummary>
<ActualWeight>38</ActualWeight>
<AuditCarrierID>22</AuditCarrierID>
<AuditPackageTrackingNumber>sample string 21</AuditPackageTrackingNumber>
<BilledDims>sample string 42</BilledDims>
<BilledWeight>40</BilledWeight>
<CarrierName>sample string 28</CarrierName>
<ClientName>sample string 31</ClientName>
<Consignee>sample string 35</Consignee>
<DateShipped>2025-12-06T23:39:42.6325205+00:00</DateShipped>
<ImportPackageID>25</ImportPackageID>
<InvoiceDate>2025-12-06T23:39:42.6325205+00:00</InvoiceDate>
<InvoiceNumber>sample string 36</InvoiceNumber>
<ManifestPackageID>26</ManifestPackageID>
<ManifestShipmentID>27</ManifestShipmentID>
<PackageID>19</PackageID>
<PackageNumber>37</PackageNumber>
<PaymentType>sample string 32</PaymentType>
<Service>sample string 30</Service>
<ServiceCode>sample string 29</ServiceCode>
<ShipDims>sample string 41</ShipDims>
<ShipDiscount>33</ShipDiscount>
<ShipOrderID>24</ShipOrderID>
<ShipPackageID>23</ShipPackageID>
<ShipWeight>39</ShipWeight>
<Shipper>sample string 34</Shipper>
<TrackingNumber>sample string 20</TrackingNumber>
<BilledCharges>10</BilledCharges>
<BulkBackBill>true</BulkBackBill>
<CarrierCharges>7</CarrierCharges>
<CarrierRate>8</CarrierRate>
<ChargeDescription>sample string 5</ChargeDescription>
<ChargeID>1</ChargeID>
<ClientID>2</ClientID>
<DefaultAddAmount>16</DefaultAddAmount>
<DefaultAddPercent>17</DefaultAddPercent>
<DefaultBackBillMargin>14</DefaultBackBillMargin>
<DefaultBillOption>sample string 15</DefaultBillOption>
<IsAdditionalCharge>true</IsAdditionalCharge>
<Margin>11</Margin>
<PackageMargin>12</PackageMargin>
<ServiceDescription>sample string 6</ServiceDescription>
<SurchargeTypeID>3</SurchargeTypeID>
<SurchargeTypeName>sample string 4</SurchargeTypeName>
<WarehouseID>18</WarehouseID>
</audBackBillSummary>
</ArrayOfaudBackBillSummary>