GET api/Charge/{auth}/{ShipmentGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required
ShipmentGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentChargeResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Charges	Collection of ShipmentChargeItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Charges": [
    {
      "ChargeID": 1,
      "ShipmentGUID": "sample string 2",
      "ChargeTypeID": 3,
      "ChargeCode": "sample string 4",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Amount": 7.0,
      "TaxAmount": 8.0,
      "NetAmount": 9.0,
      "LockFlag": true,
      "LockUserID": 1,
      "LockUserName": "sample string 11",
      "LockDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "LockDescription": "sample string 12",
      "LockIcon": "sample string 13",
      "CustomerID": 14,
      "AccountNumber": "sample string 15",
      "AccountName": "sample string 16",
      "AccountNumberAndName": "sample string 17",
      "InvoiceNumber": 1,
      "InvoiceGUID": "sample string 18",
      "InvoiceFormID": 1,
      "GlAcctNumber": "sample string 19",
      "CurrencyID": "sample string 20",
      "SortOrder": 21,
      "EditStatus": "sample string 22",
      "EditStatusDescription": "sample string 23",
      "EditStatusIcon": "sample string 24",
      "ApplyFuelSurcharge": true,
      "ApplyCurrencySurcharge": true,
      "ApplySecuritySurcharge": true,
      "Taxable": true,
      "Discountable": true,
      "TaxCode": "sample string 30",
      "Status": "sample string 31",
      "StatusName": "sample string 32",
      "BillingRunGUID": "sample string 33",
      "BillingRunUserID": 1,
      "BillingRunDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "BillingRunDescription": "sample string 34",
      "InsertUserID": 35,
      "InsertUserName": "sample string 36",
      "InsertDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "ConversionFactor": 1.0,
      "NetAmountToCurrency": 1.0,
      "CustomerCurrencyID": "sample string 38",
      "CustomerConversionFactor": 39.0,
      "CustomerAmount": 40.0,
      "CustomerTaxAmount": 41.0,
      "CustomerNetAmount": 42.0
    },
    {
      "ChargeID": 1,
      "ShipmentGUID": "sample string 2",
      "ChargeTypeID": 3,
      "ChargeCode": "sample string 4",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Amount": 7.0,
      "TaxAmount": 8.0,
      "NetAmount": 9.0,
      "LockFlag": true,
      "LockUserID": 1,
      "LockUserName": "sample string 11",
      "LockDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "LockDescription": "sample string 12",
      "LockIcon": "sample string 13",
      "CustomerID": 14,
      "AccountNumber": "sample string 15",
      "AccountName": "sample string 16",
      "AccountNumberAndName": "sample string 17",
      "InvoiceNumber": 1,
      "InvoiceGUID": "sample string 18",
      "InvoiceFormID": 1,
      "GlAcctNumber": "sample string 19",
      "CurrencyID": "sample string 20",
      "SortOrder": 21,
      "EditStatus": "sample string 22",
      "EditStatusDescription": "sample string 23",
      "EditStatusIcon": "sample string 24",
      "ApplyFuelSurcharge": true,
      "ApplyCurrencySurcharge": true,
      "ApplySecuritySurcharge": true,
      "Taxable": true,
      "Discountable": true,
      "TaxCode": "sample string 30",
      "Status": "sample string 31",
      "StatusName": "sample string 32",
      "BillingRunGUID": "sample string 33",
      "BillingRunUserID": 1,
      "BillingRunDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "BillingRunDescription": "sample string 34",
      "InsertUserID": 35,
      "InsertUserName": "sample string 36",
      "InsertDateTime": "2024-12-28T09:18:14.4754789+00:00",
      "ConversionFactor": 1.0,
      "NetAmountToCurrency": 1.0,
      "CustomerCurrencyID": "sample string 38",
      "CustomerConversionFactor": 39.0,
      "CustomerAmount": 40.0,
      "CustomerTaxAmount": 41.0,
      "CustomerNetAmount": 42.0
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentChargeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Charges>
    <ShipmentChargeItem>
      <AccountName>sample string 16</AccountName>
      <AccountNumber>sample string 15</AccountNumber>
      <AccountNumberAndName>sample string 17</AccountNumberAndName>
      <Amount>7</Amount>
      <ApplyCurrencySurcharge>true</ApplyCurrencySurcharge>
      <ApplyFuelSurcharge>true</ApplyFuelSurcharge>
      <ApplySecuritySurcharge>true</ApplySecuritySurcharge>
      <BillingRunDateTime>2024-12-28T09:18:14.4754789+00:00</BillingRunDateTime>
      <BillingRunDescription>sample string 34</BillingRunDescription>
      <BillingRunGUID>sample string 33</BillingRunGUID>
      <BillingRunUserID>1</BillingRunUserID>
      <ChargeCode>sample string 4</ChargeCode>
      <ChargeID>1</ChargeID>
      <ChargeTypeID>3</ChargeTypeID>
      <ConversionFactor>1</ConversionFactor>
      <CurrencyID>sample string 20</CurrencyID>
      <CustomerAmount>40</CustomerAmount>
      <CustomerConversionFactor>39</CustomerConversionFactor>
      <CustomerCurrencyID>sample string 38</CustomerCurrencyID>
      <CustomerID>14</CustomerID>
      <CustomerNetAmount>42</CustomerNetAmount>
      <CustomerTaxAmount>41</CustomerTaxAmount>
      <Description>sample string 6</Description>
      <Discountable>true</Discountable>
      <EditStatus>sample string 22</EditStatus>
      <EditStatusDescription>sample string 23</EditStatusDescription>
      <EditStatusIcon>sample string 24</EditStatusIcon>
      <GlAcctNumber>sample string 19</GlAcctNumber>
      <InsertDateTime>2024-12-28T09:18:14.4754789+00:00</InsertDateTime>
      <InsertUserID>35</InsertUserID>
      <InsertUserName>sample string 36</InsertUserName>
      <InvoiceFormID>1</InvoiceFormID>
      <InvoiceGUID>sample string 18</InvoiceGUID>
      <InvoiceNumber>1</InvoiceNumber>
      <LockDateTime>2024-12-28T09:18:14.4754789+00:00</LockDateTime>
      <LockDescription>sample string 12</LockDescription>
      <LockFlag>true</LockFlag>
      <LockIcon>sample string 13</LockIcon>
      <LockUserID>1</LockUserID>
      <LockUserName>sample string 11</LockUserName>
      <Name>sample string 5</Name>
      <NetAmount>9</NetAmount>
      <NetAmountToCurrency>1</NetAmountToCurrency>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <SortOrder>21</SortOrder>
      <Status>sample string 31</Status>
      <StatusName>sample string 32</StatusName>
      <TaxAmount>8</TaxAmount>
      <TaxCode>sample string 30</TaxCode>
      <Taxable>true</Taxable>
    </ShipmentChargeItem>
    <ShipmentChargeItem>
      <AccountName>sample string 16</AccountName>
      <AccountNumber>sample string 15</AccountNumber>
      <AccountNumberAndName>sample string 17</AccountNumberAndName>
      <Amount>7</Amount>
      <ApplyCurrencySurcharge>true</ApplyCurrencySurcharge>
      <ApplyFuelSurcharge>true</ApplyFuelSurcharge>
      <ApplySecuritySurcharge>true</ApplySecuritySurcharge>
      <BillingRunDateTime>2024-12-28T09:18:14.4754789+00:00</BillingRunDateTime>
      <BillingRunDescription>sample string 34</BillingRunDescription>
      <BillingRunGUID>sample string 33</BillingRunGUID>
      <BillingRunUserID>1</BillingRunUserID>
      <ChargeCode>sample string 4</ChargeCode>
      <ChargeID>1</ChargeID>
      <ChargeTypeID>3</ChargeTypeID>
      <ConversionFactor>1</ConversionFactor>
      <CurrencyID>sample string 20</CurrencyID>
      <CustomerAmount>40</CustomerAmount>
      <CustomerConversionFactor>39</CustomerConversionFactor>
      <CustomerCurrencyID>sample string 38</CustomerCurrencyID>
      <CustomerID>14</CustomerID>
      <CustomerNetAmount>42</CustomerNetAmount>
      <CustomerTaxAmount>41</CustomerTaxAmount>
      <Description>sample string 6</Description>
      <Discountable>true</Discountable>
      <EditStatus>sample string 22</EditStatus>
      <EditStatusDescription>sample string 23</EditStatusDescription>
      <EditStatusIcon>sample string 24</EditStatusIcon>
      <GlAcctNumber>sample string 19</GlAcctNumber>
      <InsertDateTime>2024-12-28T09:18:14.4754789+00:00</InsertDateTime>
      <InsertUserID>35</InsertUserID>
      <InsertUserName>sample string 36</InsertUserName>
      <InvoiceFormID>1</InvoiceFormID>
      <InvoiceGUID>sample string 18</InvoiceGUID>
      <InvoiceNumber>1</InvoiceNumber>
      <LockDateTime>2024-12-28T09:18:14.4754789+00:00</LockDateTime>
      <LockDescription>sample string 12</LockDescription>
      <LockFlag>true</LockFlag>
      <LockIcon>sample string 13</LockIcon>
      <LockUserID>1</LockUserID>
      <LockUserName>sample string 11</LockUserName>
      <Name>sample string 5</Name>
      <NetAmount>9</NetAmount>
      <NetAmountToCurrency>1</NetAmountToCurrency>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <SortOrder>21</SortOrder>
      <Status>sample string 31</Status>
      <StatusName>sample string 32</StatusName>
      <TaxAmount>8</TaxAmount>
      <TaxCode>sample string 30</TaxCode>
      <Taxable>true</Taxable>
    </ShipmentChargeItem>
  </Charges>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ShipmentChargeResp>