GET api/Operations/SelectTaskReadyToInvoice/{auth}/{EntityGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required
EntityGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

TaskReadyToInvoiceResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
ShipmentGUID	string	None.
ShipmentNumber	integer	None.
PickupGUID	string	None.
DeliveryGUID	string	None.
CompanyID	integer	None.
CustomerID	integer	None.
AccountNumber	string	None.
CustomerName	string	None.
ConsigneeCustomerID	integer	None.
ConsigneeAccountNumber	string	None.
ConsigneeCustomerName	string	None.
ThirdPartyCustomerID	integer	None.
ThirdPartyAccountNumber	string	None.
ThirdPartyCustomerName	string	None.
BillToCustomerID	integer	None.
BillToType	string	None.
BillToAttention	string	None.
ServiceID	integer	None.
WorkflowID	string	None.
OrderDateTime	date	None.
Pieces	integer	None.
Weight	decimal number	None.
DimWeight	decimal number	None.
WeightUOM	string	None.
Length	integer	None.
Width	integer	None.
Height	integer	None.
SizeUOM	string	None.
DeclaredValue	decimal number	None.
DeclaredValueCurrencyID	string	None.
TotalDistance	integer	None.
TotalDistanceUOM	string	None.
PuCompanyName	string	None.
PuAddress1	string	None.
PuAddress2	string	None.
PuAddress3	string	None.
PuStateProvID	string	None.
PuCityName	string	None.
PuPostalCode	string	None.
PuCountryID	string	None.
PuTimezoneID	string	None.
PuAddressCode	string	None.
PuAirportID	string	None.
PuPersonToSee	string	None.
PuPhoneNumber	string	None.
PuAfterHoursNumber	string	None.
PuInstructions	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.
PuCourierID	integer	None.
PuCourierServiceID	integer	None.
PuCourierInfo	string	None.
DelCompanyName	string	None.
DelAddress1	string	None.
DelAddress2	string	None.
DelAddress3	string	None.
DelCountryID	string	None.
DelTimezoneID	string	None.
DelStateProvID	string	None.
DelCityName	string	None.
DelPostalCode	string	None.
DelAddressCode	string	None.
DelAirportID	string	None.
DelAttention	string	None.
DelPhoneNumber	string	None.
DelAfterHoursNumber	string	None.
DelInstructions	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.
DelCourierID	integer	None.
DelCourierServiceID	integer	None.
DelCourierInfo	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.
HoldForPickup	boolean	None.
PodSignature	string	None.
LockCostPickup	boolean	None.
LockCostDelivery	boolean	None.
LockCostShipment	boolean	None.
LockCharge	boolean	None.
Reference	string	None.
Contents	string	None.
PuHoldOverNight	boolean	None.
DelHoldOverNight	boolean	None.
PuBonded	boolean	None.
DelBonded	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "ShipmentGUID": "sample string 3",
  "ShipmentNumber": 4,
  "PickupGUID": "sample string 5",
  "DeliveryGUID": "sample string 6",
  "CompanyID": 7,
  "CustomerID": 8,
  "AccountNumber": "sample string 9",
  "CustomerName": "sample string 10",
  "ConsigneeCustomerID": 1,
  "ConsigneeAccountNumber": "sample string 11",
  "ConsigneeCustomerName": "sample string 12",
  "ThirdPartyCustomerID": 1,
  "ThirdPartyAccountNumber": "sample string 13",
  "ThirdPartyCustomerName": "sample string 14",
  "BillToCustomerID": 15,
  "BillToType": "sample string 16",
  "BillToAttention": "sample string 17",
  "ServiceID": 18,
  "WorkflowID": "sample string 19",
  "OrderDateTime": "2024-12-28T09:00:25.0675436+00:00",
  "Pieces": 21,
  "Weight": 1.0,
  "DimWeight": 1.0,
  "WeightUOM": "sample string 22",
  "Length": 1,
  "Width": 1,
  "Height": 1,
  "SizeUOM": "sample string 23",
  "DeclaredValue": 1.0,
  "DeclaredValueCurrencyID": "sample string 24",
  "TotalDistance": 25,
  "TotalDistanceUOM": "sample string 26",
  "PuCompanyName": "sample string 27",
  "PuAddress1": "sample string 28",
  "PuAddress2": "sample string 29",
  "PuAddress3": "sample string 30",
  "PuStateProvID": "sample string 31",
  "PuCityName": "sample string 32",
  "PuPostalCode": "sample string 33",
  "PuCountryID": "sample string 34",
  "PuTimezoneID": "sample string 35",
  "PuAddressCode": "sample string 36",
  "PuAirportID": "sample string 37",
  "PuPersonToSee": "sample string 38",
  "PuPhoneNumber": "sample string 39",
  "PuAfterHoursNumber": "sample string 40",
  "PuInstructions": "sample string 41",
  "SchedPickupDateTime": "2024-12-28T09:00:25.0675436+00:00",
  "ActualPickupArrival": "2024-12-28T09:00:25.0675436+00:00",
  "PuDistance": 43,
  "PuDistanceUOM": "sample string 44",
  "PuWaitingTime": 1,
  "PuAttemptCount": 1,
  "PuActualDistance": 45,
  "PuActualDistanceUOM": "sample string 46",
  "PuActualWaitingTime": 1,
  "PuActualAttemptCount": 1,
  "PuActualWeight": 1.0,
  "PuActualWeightUOM": "sample string 47",
  "PuCourierID": 1,
  "PuCourierServiceID": 1,
  "PuCourierInfo": "sample string 48",
  "DelCompanyName": "sample string 49",
  "DelAddress1": "sample string 50",
  "DelAddress2": "sample string 51",
  "DelAddress3": "sample string 52",
  "DelCountryID": "sample string 53",
  "DelTimezoneID": "sample string 54",
  "DelStateProvID": "sample string 55",
  "DelCityName": "sample string 56",
  "DelPostalCode": "sample string 57",
  "DelAddressCode": "sample string 58",
  "DelAirportID": "sample string 59",
  "DelAttention": "sample string 60",
  "DelPhoneNumber": "sample string 61",
  "DelAfterHoursNumber": "sample string 62",
  "DelInstructions": "sample string 63",
  "SchedDeliveryDateTime": "2024-12-28T09:00:25.0675436+00:00",
  "ActualDeliveryArrival": "2024-12-28T09:00:25.0675436+00:00",
  "DelDistance": 64,
  "DelDistanceUOM": "sample string 65",
  "DelWaitingTime": 1,
  "DelAttemptCount": 1,
  "DelActualDistance": 66,
  "DelActualDistanceUOM": "sample string 67",
  "DelActualWaitingTime": 1,
  "DelActualAttemptCount": 1,
  "DelActualWeight": 1.0,
  "DelActualWeightUOM": "sample string 68",
  "DelCourierID": 1,
  "DelCourierServiceID": 1,
  "DelCourierInfo": "sample string 69",
  "FuelSurchargePercent": 1.0,
  "SecuritySurchargePercent": 1.0,
  "CurrencySurchargePercent": 1.0,
  "TaxPercent": 1.0,
  "TaxCode": "sample string 70",
  "DiscountPercent": 1.0,
  "HoldForPickup": true,
  "PodSignature": "sample string 72",
  "LockCostPickup": true,
  "LockCostDelivery": true,
  "LockCostShipment": true,
  "LockCharge": true,
  "Reference": "sample string 77",
  "Contents": "sample string 78",
  "PuHoldOverNight": true,
  "DelHoldOverNight": true,
  "PuBonded": true,
  "DelBonded": true
}

application/xml, text/xml

Sample:

<TaskReadyToInvoiceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AccountNumber>sample string 9</AccountNumber>
  <ActualDeliveryArrival>2024-12-28T09:00:25.0675436+00:00</ActualDeliveryArrival>
  <ActualPickupArrival>2024-12-28T09:00:25.0675436+00:00</ActualPickupArrival>
  <BillToAttention>sample string 17</BillToAttention>
  <BillToCustomerID>15</BillToCustomerID>
  <BillToType>sample string 16</BillToType>
  <CompanyID>7</CompanyID>
  <ConsigneeAccountNumber>sample string 11</ConsigneeAccountNumber>
  <ConsigneeCustomerID>1</ConsigneeCustomerID>
  <ConsigneeCustomerName>sample string 12</ConsigneeCustomerName>
  <Contents>sample string 78</Contents>
  <CurrencySurchargePercent>1</CurrencySurchargePercent>
  <CustomerID>8</CustomerID>
  <CustomerName>sample string 10</CustomerName>
  <DeclaredValue>1</DeclaredValue>
  <DeclaredValueCurrencyID>sample string 24</DeclaredValueCurrencyID>
  <DelActualAttemptCount>1</DelActualAttemptCount>
  <DelActualDistance>66</DelActualDistance>
  <DelActualDistanceUOM>sample string 67</DelActualDistanceUOM>
  <DelActualWaitingTime>1</DelActualWaitingTime>
  <DelActualWeight>1</DelActualWeight>
  <DelActualWeightUOM>sample string 68</DelActualWeightUOM>
  <DelAddress1>sample string 50</DelAddress1>
  <DelAddress2>sample string 51</DelAddress2>
  <DelAddress3>sample string 52</DelAddress3>
  <DelAddressCode>sample string 58</DelAddressCode>
  <DelAfterHoursNumber>sample string 62</DelAfterHoursNumber>
  <DelAirportID>sample string 59</DelAirportID>
  <DelAttemptCount>1</DelAttemptCount>
  <DelAttention>sample string 60</DelAttention>
  <DelBonded>true</DelBonded>
  <DelCityName>sample string 56</DelCityName>
  <DelCompanyName>sample string 49</DelCompanyName>
  <DelCountryID>sample string 53</DelCountryID>
  <DelCourierID>1</DelCourierID>
  <DelCourierInfo>sample string 69</DelCourierInfo>
  <DelCourierServiceID>1</DelCourierServiceID>
  <DelDistance>64</DelDistance>
  <DelDistanceUOM>sample string 65</DelDistanceUOM>
  <DelHoldOverNight>true</DelHoldOverNight>
  <DelInstructions>sample string 63</DelInstructions>
  <DelPhoneNumber>sample string 61</DelPhoneNumber>
  <DelPostalCode>sample string 57</DelPostalCode>
  <DelStateProvID>sample string 55</DelStateProvID>
  <DelTimezoneID>sample string 54</DelTimezoneID>
  <DelWaitingTime>1</DelWaitingTime>
  <DeliveryGUID>sample string 6</DeliveryGUID>
  <DimWeight>1</DimWeight>
  <DiscountPercent>1</DiscountPercent>
  <ErrorMessage>sample string 2</ErrorMessage>
  <FuelSurchargePercent>1</FuelSurchargePercent>
  <Height>1</Height>
  <HoldForPickup>true</HoldForPickup>
  <IsSuccessful>true</IsSuccessful>
  <Length>1</Length>
  <LockCharge>true</LockCharge>
  <LockCostDelivery>true</LockCostDelivery>
  <LockCostPickup>true</LockCostPickup>
  <LockCostShipment>true</LockCostShipment>
  <OrderDateTime>2024-12-28T09:00:25.0675436+00:00</OrderDateTime>
  <PickupGUID>sample string 5</PickupGUID>
  <Pieces>21</Pieces>
  <PodSignature>sample string 72</PodSignature>
  <PuActualAttemptCount>1</PuActualAttemptCount>
  <PuActualDistance>45</PuActualDistance>
  <PuActualDistanceUOM>sample string 46</PuActualDistanceUOM>
  <PuActualWaitingTime>1</PuActualWaitingTime>
  <PuActualWeight>1</PuActualWeight>
  <PuActualWeightUOM>sample string 47</PuActualWeightUOM>
  <PuAddress1>sample string 28</PuAddress1>
  <PuAddress2>sample string 29</PuAddress2>
  <PuAddress3>sample string 30</PuAddress3>
  <PuAddressCode>sample string 36</PuAddressCode>
  <PuAfterHoursNumber>sample string 40</PuAfterHoursNumber>
  <PuAirportID>sample string 37</PuAirportID>
  <PuAttemptCount>1</PuAttemptCount>
  <PuBonded>true</PuBonded>
  <PuCityName>sample string 32</PuCityName>
  <PuCompanyName>sample string 27</PuCompanyName>
  <PuCountryID>sample string 34</PuCountryID>
  <PuCourierID>1</PuCourierID>
  <PuCourierInfo>sample string 48</PuCourierInfo>
  <PuCourierServiceID>1</PuCourierServiceID>
  <PuDistance>43</PuDistance>
  <PuDistanceUOM>sample string 44</PuDistanceUOM>
  <PuHoldOverNight>true</PuHoldOverNight>
  <PuInstructions>sample string 41</PuInstructions>
  <PuPersonToSee>sample string 38</PuPersonToSee>
  <PuPhoneNumber>sample string 39</PuPhoneNumber>
  <PuPostalCode>sample string 33</PuPostalCode>
  <PuStateProvID>sample string 31</PuStateProvID>
  <PuTimezoneID>sample string 35</PuTimezoneID>
  <PuWaitingTime>1</PuWaitingTime>
  <Reference>sample string 77</Reference>
  <SchedDeliveryDateTime>2024-12-28T09:00:25.0675436+00:00</SchedDeliveryDateTime>
  <SchedPickupDateTime>2024-12-28T09:00:25.0675436+00:00</SchedPickupDateTime>
  <SecuritySurchargePercent>1</SecuritySurchargePercent>
  <ServiceID>18</ServiceID>
  <ShipmentGUID>sample string 3</ShipmentGUID>
  <ShipmentNumber>4</ShipmentNumber>
  <SizeUOM>sample string 23</SizeUOM>
  <TaxCode>sample string 70</TaxCode>
  <TaxPercent>1</TaxPercent>
  <ThirdPartyAccountNumber>sample string 13</ThirdPartyAccountNumber>
  <ThirdPartyCustomerID>1</ThirdPartyCustomerID>
  <ThirdPartyCustomerName>sample string 14</ThirdPartyCustomerName>
  <TotalDistance>25</TotalDistance>
  <TotalDistanceUOM>sample string 26</TotalDistanceUOM>
  <Weight>1</Weight>
  <WeightUOM>sample string 22</WeightUOM>
  <Width>1</Width>
  <WorkflowID>sample string 19</WorkflowID>
</TaskReadyToInvoiceResp>