POST api/Operations/UpdateTaskReadyToInvoice
Request Information
URI Parameters
None.
Body Parameters
TaskReadyToInvoiceParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| ShipmentGUID | string |
None. |
|
| ButtonType | string |
None. |
|
| CustomerID | integer |
None. |
|
| ConsigneeCustomerID | integer |
None. |
|
| ThirdPartyCustomerID | integer |
None. |
|
| BillToType | string |
None. |
|
| ServiceID | integer |
None. |
|
| Pieces | integer |
None. |
|
| Weight | decimal number |
None. |
|
| DimWeight | decimal number |
None. |
|
| WeightUOM | string |
None. |
|
| DeclaredValue | decimal number |
None. |
|
| DeclaredValueCurrencyID | string |
None. |
|
| TotalDistance | integer |
None. |
|
| TotalDistanceUOM | string |
None. |
|
| PuCountryID | string |
None. |
|
| PuStateProvID | string |
None. |
|
| PuCityName | string |
None. |
|
| PuPostalCode | string |
None. |
|
| PuAddressCode | string |
None. |
|
| PuAirportID | string |
None. |
|
| SchedPickupDateTime | date |
None. |
|
| ActualPickupArrival | date |
None. |
|
| PuDistance | integer |
None. |
|
| PuDistanceUOM | string |
None. |
|
| PuWaitingTime | integer |
None. |
|
| PuAttemptCount | integer |
None. |
|
| PuActualDistance | integer |
None. |
|
| PuActualDistanceUOM | string |
None. |
|
| PuActualWaitingTime | integer |
None. |
|
| PuActualAttemptCount | integer |
None. |
|
| PuActualWeight | decimal number |
None. |
|
| PuActualWeightUOM | string |
None. |
|
| DelCountryID | string |
None. |
|
| DelStateProvID | string |
None. |
|
| DelCityName | string |
None. |
|
| DelPostalCode | string |
None. |
|
| DelAddressCode | string |
None. |
|
| DelAirportID | string |
None. |
|
| SchedDeliveryDateTime | date |
None. |
|
| ActualDeliveryArrival | date |
None. |
|
| DelDistance | integer |
None. |
|
| DelDistanceUOM | string |
None. |
|
| DelWaitingTime | integer |
None. |
|
| DelAttemptCount | integer |
None. |
|
| DelActualDistance | integer |
None. |
|
| DelActualDistanceUOM | string |
None. |
|
| DelActualWaitingTime | integer |
None. |
|
| DelActualAttemptCount | integer |
None. |
|
| DelActualWeight | decimal number |
None. |
|
| DelActualWeightUOM | string |
None. |
|
| FuelSurchargePercent | decimal number |
None. |
|
| SecuritySurchargePercent | decimal number |
None. |
|
| CurrencySurchargePercent | decimal number |
None. |
|
| TaxPercent | decimal number |
None. |
|
| TaxCode | string |
None. |
|
| DiscountPercent | decimal number |
None. |
|
| BillToAttention | string |
None. |
|
| Length | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| SizeUOM | string |
None. |
|
| Contents | string |
None. |
|
| Reference | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"ShipmentGUID": "sample string 2",
"ButtonType": "sample string 3",
"CustomerID": 4,
"ConsigneeCustomerID": 1,
"ThirdPartyCustomerID": 1,
"BillToType": "sample string 5",
"ServiceID": 6,
"Pieces": 7,
"Weight": 1.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 8",
"DeclaredValue": 1.0,
"DeclaredValueCurrencyID": "sample string 9",
"TotalDistance": 10,
"TotalDistanceUOM": "sample string 11",
"PuCountryID": "sample string 12",
"PuStateProvID": "sample string 13",
"PuCityName": "sample string 14",
"PuPostalCode": "sample string 15",
"PuAddressCode": "sample string 16",
"PuAirportID": "sample string 17",
"SchedPickupDateTime": "2025-12-03T12:33:23.6647905+00:00",
"ActualPickupArrival": "2025-12-03T12:33:23.6647905+00:00",
"PuDistance": 20,
"PuDistanceUOM": "sample string 21",
"PuWaitingTime": 1,
"PuAttemptCount": 1,
"PuActualDistance": 22,
"PuActualDistanceUOM": "sample string 23",
"PuActualWaitingTime": 1,
"PuActualAttemptCount": 1,
"PuActualWeight": 1.0,
"PuActualWeightUOM": "sample string 24",
"DelCountryID": "sample string 25",
"DelStateProvID": "sample string 26",
"DelCityName": "sample string 27",
"DelPostalCode": "sample string 28",
"DelAddressCode": "sample string 29",
"DelAirportID": "sample string 30",
"SchedDeliveryDateTime": "2025-12-03T12:33:23.6647905+00:00",
"ActualDeliveryArrival": "2025-12-03T12:33:23.6647905+00:00",
"DelDistance": 31,
"DelDistanceUOM": "sample string 32",
"DelWaitingTime": 1,
"DelAttemptCount": 1,
"DelActualDistance": 33,
"DelActualDistanceUOM": "sample string 34",
"DelActualWaitingTime": 1,
"DelActualAttemptCount": 1,
"DelActualWeight": 1.0,
"DelActualWeightUOM": "sample string 35",
"FuelSurchargePercent": 1.0,
"SecuritySurchargePercent": 1.0,
"CurrencySurchargePercent": 1.0,
"TaxPercent": 1.0,
"TaxCode": "sample string 36",
"DiscountPercent": 1.0,
"BillToAttention": "sample string 37",
"Length": 1,
"Width": 1,
"Height": 1,
"SizeUOM": "sample string 38",
"Contents": "sample string 39",
"Reference": "sample string 40"
}
application/xml, text/xml
Sample:
<TaskReadyToInvoiceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ActualDeliveryArrival>2025-12-03T12:33:23.6647905+00:00</ActualDeliveryArrival> <ActualPickupArrival>2025-12-03T12:33:23.6647905+00:00</ActualPickupArrival> <BillToAttention>sample string 37</BillToAttention> <BillToType>sample string 5</BillToType> <ButtonType>sample string 3</ButtonType> <ConsigneeCustomerID>1</ConsigneeCustomerID> <Contents>sample string 39</Contents> <CurrencySurchargePercent>1</CurrencySurchargePercent> <CustomerID>4</CustomerID> <DeclaredValue>1</DeclaredValue> <DeclaredValueCurrencyID>sample string 9</DeclaredValueCurrencyID> <DelActualAttemptCount>1</DelActualAttemptCount> <DelActualDistance>33</DelActualDistance> <DelActualDistanceUOM>sample string 34</DelActualDistanceUOM> <DelActualWaitingTime>1</DelActualWaitingTime> <DelActualWeight>1</DelActualWeight> <DelActualWeightUOM>sample string 35</DelActualWeightUOM> <DelAddressCode>sample string 29</DelAddressCode> <DelAirportID>sample string 30</DelAirportID> <DelAttemptCount>1</DelAttemptCount> <DelCityName>sample string 27</DelCityName> <DelCountryID>sample string 25</DelCountryID> <DelDistance>31</DelDistance> <DelDistanceUOM>sample string 32</DelDistanceUOM> <DelPostalCode>sample string 28</DelPostalCode> <DelStateProvID>sample string 26</DelStateProvID> <DelWaitingTime>1</DelWaitingTime> <DimWeight>1</DimWeight> <DiscountPercent>1</DiscountPercent> <FuelSurchargePercent>1</FuelSurchargePercent> <Height>1</Height> <Length>1</Length> <Pieces>7</Pieces> <PuActualAttemptCount>1</PuActualAttemptCount> <PuActualDistance>22</PuActualDistance> <PuActualDistanceUOM>sample string 23</PuActualDistanceUOM> <PuActualWaitingTime>1</PuActualWaitingTime> <PuActualWeight>1</PuActualWeight> <PuActualWeightUOM>sample string 24</PuActualWeightUOM> <PuAddressCode>sample string 16</PuAddressCode> <PuAirportID>sample string 17</PuAirportID> <PuAttemptCount>1</PuAttemptCount> <PuCityName>sample string 14</PuCityName> <PuCountryID>sample string 12</PuCountryID> <PuDistance>20</PuDistance> <PuDistanceUOM>sample string 21</PuDistanceUOM> <PuPostalCode>sample string 15</PuPostalCode> <PuStateProvID>sample string 13</PuStateProvID> <PuWaitingTime>1</PuWaitingTime> <Reference>sample string 40</Reference> <SchedDeliveryDateTime>2025-12-03T12:33:23.6647905+00:00</SchedDeliveryDateTime> <SchedPickupDateTime>2025-12-03T12:33:23.6647905+00:00</SchedPickupDateTime> <SecuritySurchargePercent>1</SecuritySurchargePercent> <ServiceID>6</ServiceID> <ShipmentGUID>sample string 2</ShipmentGUID> <SizeUOM>sample string 38</SizeUOM> <TaxCode>sample string 36</TaxCode> <TaxPercent>1</TaxPercent> <ThirdPartyCustomerID>1</ThirdPartyCustomerID> <TotalDistance>10</TotalDistance> <TotalDistanceUOM>sample string 11</TotalDistanceUOM> <Weight>1</Weight> <WeightUOM>sample string 8</WeightUOM> <Width>1</Width> <auth>sample string 1</auth> </TaskReadyToInvoiceParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>