POST api/{siteCode}/ShippingInvoice/PostShippingInvoice
This call creates a commercial shipping invoice and packing list. Either a JobNumber or WHJobNumber is required to determine which shipment this record should be associated to.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteCode |
The site code. |
integer |
Required |
Body Parameters
The shipping invoice.
ShippingInvoiceRecordName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
InvoiceNumber | string |
None. |
|
CustomerName | string |
None. |
|
CustAccNum | string |
None. |
|
CustomerAddress | string |
None. |
|
SupplierName | string |
None. |
|
SupplierAccNum | string |
None. |
|
SupplierAddress | string |
None. |
|
InvoiceDate | date |
None. |
|
ShipmentDetails | string |
None. |
|
TotalPrice | decimal number |
None. |
|
InvCurrency | string |
None. |
|
NetWeight | decimal number |
None. |
|
GrossWeight | decimal number |
None. |
|
WeightUnit | string |
None. |
|
WHJobNumber | string |
None. |
|
JobNumber | string |
None. |
|
CustomerCountryCode | string |
None. |
|
CustomerPostCode | string |
None. |
|
CustomerVATNum | string |
None. |
|
ConsigneeAccNum | string |
None. |
|
ConsigneeName | string |
None. |
|
ConsigneeAddress | string |
None. |
|
ConsigneeCountryCode | string |
None. |
|
ConsigneePostCode | string |
None. |
|
ConsigneeVATNum | string |
None. |
|
NotifyAccNum | string |
None. |
|
NotifyName | string |
None. |
|
NotifyAddress | string |
None. |
|
NotifyCountryCode | string |
None. |
|
NotifyPostCode | string |
None. |
|
NotifyVATNum | string |
None. |
|
CountryOfOrigin | string |
None. |
|
CountryOfDespatch | string |
None. |
|
CountryOfDestination | string |
None. |
|
OrderNumber | string |
None. |
|
SellersReference | string |
None. |
|
PONumber | string |
None. |
|
OtherReference | string |
None. |
|
InvoiceCurrency | string |
None. |
|
PaymentTerms | string |
None. |
|
ShippingTerms | string |
None. |
|
Conveyance | string |
None. |
|
Carrier | string |
None. |
|
CarrierReference | string |
None. |
|
DepartureDate | date |
None. |
|
ShippingDate | date |
None. |
|
PortOfLoading | string |
None. |
|
PortOfDischarge | string |
None. |
|
PlaceOfDelivery | string |
None. |
|
MarksAndNumbers | string |
None. |
|
DescriptionOfGoods | string |
None. |
|
Cube | decimal number |
None. |
|
NOP | integer |
None. |
|
TermsOfDelivery | string |
None. |
|
StatementsAndClauses | string |
None. |
|
Signatory | string |
None. |
|
SignatoryTitle | string |
None. |
|
PlaceOfIssue | string |
None. |
|
DateOfIssue | date |
None. |
|
Hazardous | integer |
None. |
|
Radioactive | integer |
None. |
|
CargoAircraftOnly | integer |
None. |
|
Mode | string |
None. |
|
BuyerAccNum | string |
None. |
|
BuyerName | string |
None. |
|
BuyerAddress | string |
None. |
|
BuyerCountryCode | string |
None. |
|
BuyerPostCode | string |
None. |
|
BuyerVATNum | string |
None. |
|
ShippingInvoiceItems | Collection of ShippingInvoiceRecordItem |
None. |
Request Formats
application/json, text/json
{ "ID": 1, "InvoiceNumber": "sample string 2", "CustomerName": "sample string 3", "CustAccNum": "sample string 4", "CustomerAddress": "sample string 5", "SupplierName": "sample string 6", "SupplierAccNum": "sample string 7", "SupplierAddress": "sample string 8", "InvoiceDate": "2025-02-05T06:39:11.7718265+00:00", "ShipmentDetails": "sample string 9", "TotalPrice": 1.0, "InvCurrency": "sample string 10", "NetWeight": 1.1, "GrossWeight": 1.1, "WeightUnit": "sample string 11", "WHJobNumber": "sample string 12", "JobNumber": "sample string 13", "CustomerCountryCode": "sample string 14", "CustomerPostCode": "sample string 15", "CustomerVATNum": "sample string 16", "ConsigneeAccNum": "sample string 17", "ConsigneeName": "sample string 18", "ConsigneeAddress": "sample string 19", "ConsigneeCountryCode": "sample string 20", "ConsigneePostCode": "sample string 21", "ConsigneeVATNum": "sample string 22", "NotifyAccNum": "sample string 23", "NotifyName": "sample string 24", "NotifyAddress": "sample string 25", "NotifyCountryCode": "sample string 26", "NotifyPostCode": "sample string 27", "NotifyVATNum": "sample string 28", "CountryOfOrigin": "sample string 29", "CountryOfDespatch": "sample string 30", "CountryOfDestination": "sample string 31", "OrderNumber": "sample string 32", "SellersReference": "sample string 33", "PONumber": "sample string 34", "OtherReference": "sample string 35", "InvoiceCurrency": "sample string 36", "PaymentTerms": "sample string 37", "ShippingTerms": "sample string 38", "Conveyance": "sample string 39", "Carrier": "sample string 40", "CarrierReference": "sample string 41", "DepartureDate": "2025-02-05T06:39:11.7718265+00:00", "ShippingDate": "2025-02-05T06:39:11.7718265+00:00", "PortOfLoading": "sample string 42", "PortOfDischarge": "sample string 43", "PlaceOfDelivery": "sample string 44", "MarksAndNumbers": "sample string 45", "DescriptionOfGoods": "sample string 46", "Cube": 1.1, "NOP": 1, "TermsOfDelivery": "sample string 47", "StatementsAndClauses": "sample string 48", "Signatory": "sample string 49", "SignatoryTitle": "sample string 50", "PlaceOfIssue": "sample string 51", "DateOfIssue": "2025-02-05T06:39:11.7718265+00:00", "Hazardous": 1, "Radioactive": 1, "CargoAircraftOnly": 1, "Mode": "sample string 52", "BuyerAccNum": "sample string 53", "BuyerName": "sample string 54", "BuyerAddress": "sample string 55", "BuyerCountryCode": "sample string 56", "BuyerPostCode": "sample string 57", "BuyerVATNum": "sample string 58", "ShippingInvoiceItems": [ { "InvoiceNumber": "sample string 1", "InvoiceID": 1, "PONumber": "sample string 2", "PartNumber": "sample string 3", "Description": "sample string 4", "UnitPrice": 1.0, "Quantity": 1.1, "FinalPrice": 1.0, "ItemCurrency": "sample string 5", "NetWeight": 1.1, "GrossWeight": 1.1, "OriginCountry": "sample string 6", "HSCode": "sample string 7", "CaseNumber": "sample string 8", "ItemNumber": "sample string 9", "RateUnit": "sample string 10", "UnitOfMeasure": "sample string 11", "LinePrice": 1.0, "DespatchDate": "2025-02-05T06:39:11.7718265+00:00", "Hazardous": 1, "Radioactive": 1, "CargoAircraftOnly": 1, "DGFlashpoint": "sample string 12", "DGIndexNumber": "sample string 13", "DGShippingName": "sample string 14", "DGClass": "sample string 15", "DGSubsidiaryRisk": "sample string 16", "DGTunnelCode": "sample string 17", "DGUNNumber": "sample string 18", "DGLabel1": "sample string 19", "DGLabel2": "sample string 20", "DGPackingGroup": "sample string 21", "DGMarinePollutant": 1, "DGAirRestrictions": "sample string 22", "OrderNumber": "sample string 23", "PackingInstruction": "sample string 24", "PackingType": "sample string 25", "Qfactor": 1.1, "ItemCountry": "sample string 26", "ShippingInvoiceItemPacking": [ { "OrderNumber": "sample string 2", "InvoiceNumber": "sample string 3", "ItemNumber": "sample string 4", "ContainerPartNumber": "sample string 5", "ContainerDescription": "sample string 6", "ContainerNominalTareKG": 1.1, "ContainerNominalCapacityLT": 1.1, "ContainerTargetNettKG": 1.1, "ContainerCount": 1, "NetWeight": 1.1, "Cube": 1.1, "Length": 1.1, "Width": 1.1, "Height": 1.1, "LoadingMetres": 1.1, "PalletNumber": 1 }, { "OrderNumber": "sample string 2", "InvoiceNumber": "sample string 3", "ItemNumber": "sample string 4", "ContainerPartNumber": "sample string 5", "ContainerDescription": "sample string 6", "ContainerNominalTareKG": 1.1, "ContainerNominalCapacityLT": 1.1, "ContainerTargetNettKG": 1.1, "ContainerCount": 1, "NetWeight": 1.1, "Cube": 1.1, "Length": 1.1, "Width": 1.1, "Height": 1.1, "LoadingMetres": 1.1, "PalletNumber": 1 } ] }, { "InvoiceNumber": "sample string 1", "InvoiceID": 1, "PONumber": "sample string 2", "PartNumber": "sample string 3", "Description": "sample string 4", "UnitPrice": 1.0, "Quantity": 1.1, "FinalPrice": 1.0, "ItemCurrency": "sample string 5", "NetWeight": 1.1, "GrossWeight": 1.1, "OriginCountry": "sample string 6", "HSCode": "sample string 7", "CaseNumber": "sample string 8", "ItemNumber": "sample string 9", "RateUnit": "sample string 10", "UnitOfMeasure": "sample string 11", "LinePrice": 1.0, "DespatchDate": "2025-02-05T06:39:11.7718265+00:00", "Hazardous": 1, "Radioactive": 1, "CargoAircraftOnly": 1, "DGFlashpoint": "sample string 12", "DGIndexNumber": "sample string 13", "DGShippingName": "sample string 14", "DGClass": "sample string 15", "DGSubsidiaryRisk": "sample string 16", "DGTunnelCode": "sample string 17", "DGUNNumber": "sample string 18", "DGLabel1": "sample string 19", "DGLabel2": "sample string 20", "DGPackingGroup": "sample string 21", "DGMarinePollutant": 1, "DGAirRestrictions": "sample string 22", "OrderNumber": "sample string 23", "PackingInstruction": "sample string 24", "PackingType": "sample string 25", "Qfactor": 1.1, "ItemCountry": "sample string 26", "ShippingInvoiceItemPacking": [ { "OrderNumber": "sample string 2", "InvoiceNumber": "sample string 3", "ItemNumber": "sample string 4", "ContainerPartNumber": "sample string 5", "ContainerDescription": "sample string 6", "ContainerNominalTareKG": 1.1, "ContainerNominalCapacityLT": 1.1, "ContainerTargetNettKG": 1.1, "ContainerCount": 1, "NetWeight": 1.1, "Cube": 1.1, "Length": 1.1, "Width": 1.1, "Height": 1.1, "LoadingMetres": 1.1, "PalletNumber": 1 }, { "OrderNumber": "sample string 2", "InvoiceNumber": "sample string 3", "ItemNumber": "sample string 4", "ContainerPartNumber": "sample string 5", "ContainerDescription": "sample string 6", "ContainerNominalTareKG": 1.1, "ContainerNominalCapacityLT": 1.1, "ContainerTargetNettKG": 1.1, "ContainerCount": 1, "NetWeight": 1.1, "Cube": 1.1, "Length": 1.1, "Width": 1.1, "Height": 1.1, "LoadingMetres": 1.1, "PalletNumber": 1 } ] } ] }
application/xml, text/xml
<ShippingInvoiceRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ID>1</ID> <InvoiceNumber>sample string 2</InvoiceNumber> <CustomerName>sample string 3</CustomerName> <CustAccNum>sample string 4</CustAccNum> <CustomerAddress>sample string 5</CustomerAddress> <SupplierName>sample string 6</SupplierName> <SupplierAccNum>sample string 7</SupplierAccNum> <SupplierAddress>sample string 8</SupplierAddress> <InvoiceDate>2025-02-05T06:39:11.7718265+00:00</InvoiceDate> <ShipmentDetails>sample string 9</ShipmentDetails> <TotalPrice>1</TotalPrice> <InvCurrency>sample string 10</InvCurrency> <NetWeight>1.1</NetWeight> <GrossWeight>1.1</GrossWeight> <WeightUnit>sample string 11</WeightUnit> <WHJobNumber>sample string 12</WHJobNumber> <JobNumber>sample string 13</JobNumber> <CustomerCountryCode>sample string 14</CustomerCountryCode> <CustomerPostCode>sample string 15</CustomerPostCode> <CustomerVATNum>sample string 16</CustomerVATNum> <ConsigneeAccNum>sample string 17</ConsigneeAccNum> <ConsigneeName>sample string 18</ConsigneeName> <ConsigneeAddress>sample string 19</ConsigneeAddress> <ConsigneeCountryCode>sample string 20</ConsigneeCountryCode> <ConsigneePostCode>sample string 21</ConsigneePostCode> <ConsigneeVATNum>sample string 22</ConsigneeVATNum> <NotifyAccNum>sample string 23</NotifyAccNum> <NotifyName>sample string 24</NotifyName> <NotifyAddress>sample string 25</NotifyAddress> <NotifyCountryCode>sample string 26</NotifyCountryCode> <NotifyPostCode>sample string 27</NotifyPostCode> <NotifyVATNum>sample string 28</NotifyVATNum> <CountryOfOrigin>sample string 29</CountryOfOrigin> <CountryOfDespatch>sample string 30</CountryOfDespatch> <CountryOfDestination>sample string 31</CountryOfDestination> <OrderNumber>sample string 32</OrderNumber> <SellersReference>sample string 33</SellersReference> <PONumber>sample string 34</PONumber> <OtherReference>sample string 35</OtherReference> <InvoiceCurrency>sample string 36</InvoiceCurrency> <PaymentTerms>sample string 37</PaymentTerms> <ShippingTerms>sample string 38</ShippingTerms> <Conveyance>sample string 39</Conveyance> <Carrier>sample string 40</Carrier> <CarrierReference>sample string 41</CarrierReference> <DepartureDate>2025-02-05T06:39:11.7718265+00:00</DepartureDate> <ShippingDate>2025-02-05T06:39:11.7718265+00:00</ShippingDate> <PortOfLoading>sample string 42</PortOfLoading> <PortOfDischarge>sample string 43</PortOfDischarge> <PlaceOfDelivery>sample string 44</PlaceOfDelivery> <MarksAndNumbers>sample string 45</MarksAndNumbers> <DescriptionOfGoods>sample string 46</DescriptionOfGoods> <Cube>1.1</Cube> <NOP>1</NOP> <TermsOfDelivery>sample string 47</TermsOfDelivery> <StatementsAndClauses>sample string 48</StatementsAndClauses> <Signatory>sample string 49</Signatory> <SignatoryTitle>sample string 50</SignatoryTitle> <PlaceOfIssue>sample string 51</PlaceOfIssue> <DateOfIssue>2025-02-05T06:39:11.7718265+00:00</DateOfIssue> <Hazardous>1</Hazardous> <Radioactive>1</Radioactive> <CargoAircraftOnly>1</CargoAircraftOnly> <Mode>sample string 52</Mode> <BuyerAccNum>sample string 53</BuyerAccNum> <BuyerName>sample string 54</BuyerName> <BuyerAddress>sample string 55</BuyerAddress> <BuyerCountryCode>sample string 56</BuyerCountryCode> <BuyerPostCode>sample string 57</BuyerPostCode> <BuyerVATNum>sample string 58</BuyerVATNum> <ShippingInvoiceItems> <ShippingInvoiceRecordItem> <InvoiceNumber>sample string 1</InvoiceNumber> <InvoiceID>1</InvoiceID> <PONumber>sample string 2</PONumber> <PartNumber>sample string 3</PartNumber> <Description>sample string 4</Description> <UnitPrice>1</UnitPrice> <Quantity>1.1</Quantity> <FinalPrice>1</FinalPrice> <ItemCurrency>sample string 5</ItemCurrency> <NetWeight>1.1</NetWeight> <GrossWeight>1.1</GrossWeight> <OriginCountry>sample string 6</OriginCountry> <HSCode>sample string 7</HSCode> <CaseNumber>sample string 8</CaseNumber> <ItemNumber>sample string 9</ItemNumber> <RateUnit>sample string 10</RateUnit> <UnitOfMeasure>sample string 11</UnitOfMeasure> <LinePrice>1</LinePrice> <DespatchDate>2025-02-05T06:39:11.7718265+00:00</DespatchDate> <Hazardous>1</Hazardous> <Radioactive>1</Radioactive> <CargoAircraftOnly>1</CargoAircraftOnly> <DGFlashpoint>sample string 12</DGFlashpoint> <DGIndexNumber>sample string 13</DGIndexNumber> <DGShippingName>sample string 14</DGShippingName> <DGClass>sample string 15</DGClass> <DGSubsidiaryRisk>sample string 16</DGSubsidiaryRisk> <DGTunnelCode>sample string 17</DGTunnelCode> <DGUNNumber>sample string 18</DGUNNumber> <DGLabel1>sample string 19</DGLabel1> <DGLabel2>sample string 20</DGLabel2> <DGPackingGroup>sample string 21</DGPackingGroup> <DGMarinePollutant>1</DGMarinePollutant> <DGAirRestrictions>sample string 22</DGAirRestrictions> <OrderNumber>sample string 23</OrderNumber> <PackingInstruction>sample string 24</PackingInstruction> <PackingType>sample string 25</PackingType> <Qfactor>1.1</Qfactor> <ItemCountry>sample string 26</ItemCountry> <ShippingInvoiceItemPacking> <ShippingInvoiceRecordItemPacking> <ID>1</ID> <OrderNumber>sample string 2</OrderNumber> <InvoiceNumber>sample string 3</InvoiceNumber> <ItemNumber>sample string 4</ItemNumber> <ContainerPartNumber>sample string 5</ContainerPartNumber> <ContainerDescription>sample string 6</ContainerDescription> <ContainerNominalTareKG>1.1</ContainerNominalTareKG> <ContainerNominalCapacityLT>1.1</ContainerNominalCapacityLT> <ContainerTargetNettKG>1.1</ContainerTargetNettKG> <ContainerCount>1</ContainerCount> <OrderContainerLineUniqueID>sample string 7</OrderContainerLineUniqueID> <NetWeight>1.1</NetWeight> <Cube>1.1</Cube> <Length>1.1</Length> <Width>1.1</Width> <Height>1.1</Height> <LoadingMetres>1.1</LoadingMetres> <PalletNumber>1</PalletNumber> </ShippingInvoiceRecordItemPacking> <ShippingInvoiceRecordItemPacking> <ID>1</ID> <OrderNumber>sample string 2</OrderNumber> <InvoiceNumber>sample string 3</InvoiceNumber> <ItemNumber>sample string 4</ItemNumber> <ContainerPartNumber>sample string 5</ContainerPartNumber> <ContainerDescription>sample string 6</ContainerDescription> <ContainerNominalTareKG>1.1</ContainerNominalTareKG> <ContainerNominalCapacityLT>1.1</ContainerNominalCapacityLT> <ContainerTargetNettKG>1.1</ContainerTargetNettKG> <ContainerCount>1</ContainerCount> <OrderContainerLineUniqueID>sample string 7</OrderContainerLineUniqueID> <NetWeight>1.1</NetWeight> <Cube>1.1</Cube> <Length>1.1</Length> <Width>1.1</Width> <Height>1.1</Height> <LoadingMetres>1.1</LoadingMetres> <PalletNumber>1</PalletNumber> </ShippingInvoiceRecordItemPacking> </ShippingInvoiceItemPacking> </ShippingInvoiceRecordItem> <ShippingInvoiceRecordItem> <InvoiceNumber>sample string 1</InvoiceNumber> <InvoiceID>1</InvoiceID> <PONumber>sample string 2</PONumber> <PartNumber>sample string 3</PartNumber> <Description>sample string 4</Description> <UnitPrice>1</UnitPrice> <Quantity>1.1</Quantity> <FinalPrice>1</FinalPrice> <ItemCurrency>sample string 5</ItemCurrency> <NetWeight>1.1</NetWeight> <GrossWeight>1.1</GrossWeight> <OriginCountry>sample string 6</OriginCountry> <HSCode>sample string 7</HSCode> <CaseNumber>sample string 8</CaseNumber> <ItemNumber>sample string 9</ItemNumber> <RateUnit>sample string 10</RateUnit> <UnitOfMeasure>sample string 11</UnitOfMeasure> <LinePrice>1</LinePrice> <DespatchDate>2025-02-05T06:39:11.7718265+00:00</DespatchDate> <Hazardous>1</Hazardous> <Radioactive>1</Radioactive> <CargoAircraftOnly>1</CargoAircraftOnly> <DGFlashpoint>sample string 12</DGFlashpoint> <DGIndexNumber>sample string 13</DGIndexNumber> <DGShippingName>sample string 14</DGShippingName> <DGClass>sample string 15</DGClass> <DGSubsidiaryRisk>sample string 16</DGSubsidiaryRisk> <DGTunnelCode>sample string 17</DGTunnelCode> <DGUNNumber>sample string 18</DGUNNumber> <DGLabel1>sample string 19</DGLabel1> <DGLabel2>sample string 20</DGLabel2> <DGPackingGroup>sample string 21</DGPackingGroup> <DGMarinePollutant>1</DGMarinePollutant> <DGAirRestrictions>sample string 22</DGAirRestrictions> <OrderNumber>sample string 23</OrderNumber> <PackingInstruction>sample string 24</PackingInstruction> <PackingType>sample string 25</PackingType> <Qfactor>1.1</Qfactor> <ItemCountry>sample string 26</ItemCountry> <ShippingInvoiceItemPacking> <ShippingInvoiceRecordItemPacking> <ID>1</ID> <OrderNumber>sample string 2</OrderNumber> <InvoiceNumber>sample string 3</InvoiceNumber> <ItemNumber>sample string 4</ItemNumber> <ContainerPartNumber>sample string 5</ContainerPartNumber> <ContainerDescription>sample string 6</ContainerDescription> <ContainerNominalTareKG>1.1</ContainerNominalTareKG> <ContainerNominalCapacityLT>1.1</ContainerNominalCapacityLT> <ContainerTargetNettKG>1.1</ContainerTargetNettKG> <ContainerCount>1</ContainerCount> <OrderContainerLineUniqueID>sample string 7</OrderContainerLineUniqueID> <NetWeight>1.1</NetWeight> <Cube>1.1</Cube> <Length>1.1</Length> <Width>1.1</Width> <Height>1.1</Height> <LoadingMetres>1.1</LoadingMetres> <PalletNumber>1</PalletNumber> </ShippingInvoiceRecordItemPacking> <ShippingInvoiceRecordItemPacking> <ID>1</ID> <OrderNumber>sample string 2</OrderNumber> <InvoiceNumber>sample string 3</InvoiceNumber> <ItemNumber>sample string 4</ItemNumber> <ContainerPartNumber>sample string 5</ContainerPartNumber> <ContainerDescription>sample string 6</ContainerDescription> <ContainerNominalTareKG>1.1</ContainerNominalTareKG> <ContainerNominalCapacityLT>1.1</ContainerNominalCapacityLT> <ContainerTargetNettKG>1.1</ContainerTargetNettKG> <ContainerCount>1</ContainerCount> <OrderContainerLineUniqueID>sample string 7</OrderContainerLineUniqueID> <NetWeight>1.1</NetWeight> <Cube>1.1</Cube> <Length>1.1</Length> <Width>1.1</Width> <Height>1.1</Height> <LoadingMetres>1.1</LoadingMetres> <PalletNumber>1</PalletNumber> </ShippingInvoiceRecordItemPacking> </ShippingInvoiceItemPacking> </ShippingInvoiceRecordItem> </ShippingInvoiceItems> </ShippingInvoiceRecord>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage. The Response value contains the invoice number, order number and record ID if successful
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |