JiwaAPI

<back to all web services

LandedCostShipmentCREATEFromPORequest

Requires Authentication
The following routes are available for this service:
POST/Shipments/FromPurchaseOrders/{OrderNos}Creates a shipment from the supplied purchase orders.
LandedCostShipmentCREATEFromPORequest Parameters:
NameParameterData TypeRequiredDescription
OrderNospathstring[]No
Shipment Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDformstringNo
ShipmentNoformstringNo
LastSavedDateTimeformDateTime?No
InitiatedDateformDateTime?No
DepartureDateformDateTime?No
ExpectedArrivalDateformDateTime?No
ScheduledArrivalDateformDateTime?No
ReceiptDateformDateTime?No
DeliveryNotesformstringNo
StatusformStatusType?No
WayBillNoformstringNo
VesselNameformstringNo
ContainerNoformstringNo
UseVOTIformbool?No
ShippingAgentCreditorIDformstringNo
ShippingAgentCreditorAccountNoformstringNo
ShippingAgentCreditorNameformstringNo
ImportCostClearingAccountformAccountNo
LinesformList<ShipmentLine>No
PurchaseOrdersformList<ShipmentPurchaseOrderReceived>No
ImportCostsformList<ShipmentImportCost>No
VOTIsformList<ShipmentVOTI>No
InvoicesformList<ShipmentInvoice>No
CustomFieldValuesformList<CustomFieldValue>No
Account Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
AccountNoformstringNo
DescriptionformstringNo
ShipmentLine Parameters:
NameParameterData TypeRequiredDescription
LineIDformstringNo
ItemNoformint?No
InventoryIDformstringNo
InventoryPartNoformstringNo
InventoryDescriptionformstringNo
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
SHInvoicesRecIDformstringNo
SHInvoicesInvoiceNoformstringNo
PurchaseOrderLineIDformstringNo
PurchaseOrderLineOrderLineNoformstringNo
PurchaseOrderLineOrderIDformstringNo
PurchaseOrderLineOrderNoformstringNo
PurchaseOrderLineQuantityformstringNo
PurchaseOrderLineQuantityDeliveredformstringNo
QuantityOrderedformdecimal?No
QuantityThisShipmentformdecimal?No
OrderedCostformdecimal?No
FXOrderedCostformdecimal?No
UnitCostExTaxformdecimal?No
FXRateformdecimal?No
FXUnitCostExTaxformdecimal?No
TaxRateformTaxRateNo
TaxAmountformdecimal?No
UnitCostIncTaxformdecimal?No
LineTotalExTaxformdecimal?No
LineTotalIncTaxformdecimal?No
FXLineTotalExTaxformdecimal?No
LandedCostLineTotalformdecimal?No
LandedCostformdecimal?No
TaxRate Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
TaxIDformstringNo
DescriptionformstringNo
GSTTaxGroupformTaxRateTypes?No
Rateformdecimal?No
IsDefaultRateformbool?No
BASCodeformdecimal?No
IsDefaultRateInGroupformbool?No
IsEnabledformbool?No
LedgerAccountformAccountNo
ShipmentPurchaseOrderReceived Parameters:
NameParameterData TypeRequiredDescription
PurchaseOrderReceivedIDformstringNo
OrderIDformstringNo
OrderNoformstringNo
OrderedDateformDateTime?No
ItemNoformint?No
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
ShipmentImportCost Parameters:
NameParameterData TypeRequiredDescription
ImportCostIDformstringNo
ItemNoformint?No
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
CostTypeformShipmentCostTypeNo
UseForwardCoverContractformbool?No
FXRateformdecimal?No
FXAmountformdecimal?No
HomeAmountformdecimal?No
TaxRateformTaxRateNo
TaxAmountformdecimal?No
TotalAmountformdecimal?No
ApportionedOnPurchaseOrdersformList<ShipmentApportionedCost>No
ApportionMethodformApportionMethods?No
Apportionedformbool?No
Invoicedformbool?No
InvoiceDateformDateTime?No
DueDateformDateTime?No
InvoiceNoformstringNo
ReferenceformstringNo
CR_TransIDformstringNo
LastSavedDateTimeformDateTime?No
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
ShipmentCostType Parameters:
NameParameterData TypeRequiredDescription
CostTypeIDformstringNo
NameformstringNo
DescriptionformstringNo
IsEnabledformbool?No
IsDefaultformbool?No
ShipmentApportionedCost Parameters:
NameParameterData TypeRequiredDescription
ApportionedCostIDformstringNo
ItemNoformint?No
OrdersUsedKeyformstringNo
OrderNoformstringNo
ShipmentVOTI Parameters:
NameParameterData TypeRequiredDescription
VOTIIDformstringNo
ItemNoformint?No
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
TaxRateformTaxRateNo
DescriptionformstringNo
InvoiceNoformstringNo
ReferenceformstringNo
Amountformdecimal?No
TaxAmountformdecimal?No
InvoiceDateformDateTime?No
DueDateformDateTime?No
CR_TransIDformstringNo
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
Invoicedformbool?No
ShipmentInvoice Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
InvoiceNoformstringNo
ItemNoformint?No
ReferenceformstringNo
RemarkformstringNo
InvoiceDateformDateTime?No
DueDateformDateTime?No
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
UseForwardCoverContractformbool?No
ForwardCoverContractsformList<ShipmentForwardCoverContract>No
CR_TransIDformstringNo
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
Invoicedformbool?No
FXRateformdecimal?No
ExpectedHomeAmountformdecimal?No
ExpectedFXAmountformdecimal?No
HomeAmountformdecimal?No
FXAmountformdecimal?No
TaxAmountformdecimal?No
AmountIncTaxformdecimal?No
ShipmentForwardCoverContract Parameters:
NameParameterData TypeRequiredDescription
LineKeyformstringNo
ForwardCoverContractTransactionIDformstringNo
ForwardCoverContractformForwardCoverContractNo
FXAmountformdecimal?No
HomeAmountformdecimal?No
ForwardCoverContract Parameters:
NameParameterData TypeRequiredDescription
ForwardCoverContractIDformstringNo
ContractNoformstringNo
DescriptionformstringNo
ReferenceformstringNo
CurrencyformCurrencyNo
FXRateformdecimal?No
FXContractAmountformdecimal?No
FXUsedAmountformdecimal?No
HomeContractAmountformdecimal?No
HomeUsedAmountformdecimal?No
InitiatedDateformDateTime?No
StartDateformDateTime?No
EndDateformDateTime?No
StatusformStatuses?No
LastSavedDateTimeformDateTime?No
Currency Parameters:
NameParameterData TypeRequiredDescription
CurrencyIDformstringNo
NameformstringNo
ShortNameformstringNo
DecimalPlacesformint?No
IsEnabledformbool?No
IsLocalformbool?No
LastSavedDateTimeformDateTime?No
RatesformList<CurrencyRate>No
CurrencyRate Parameters:
NameParameterData TypeRequiredDescription
RateIDformstringNo
DateEnteredformDateTime?No
EffectiveDateformDateTime?No
EffectiveDateEndformDateTime?No
TransactionRateformdecimal?No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Shipments/FromPurchaseOrders/{OrderNos} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"OrderNos":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ShipmentID":"String","ShipmentNo":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","InitiatedDate":"0001-01-01T00:00:00.0000000","DepartureDate":"0001-01-01T00:00:00.0000000","ExpectedArrivalDate":"0001-01-01T00:00:00.0000000","ScheduledArrivalDate":"0001-01-01T00:00:00.0000000","ReceiptDate":"0001-01-01T00:00:00.0000000","DeliveryNotes":"String","Status":"Entered","WayBillNo":"String","VesselName":"String","ContainerNo":"String","UseVOTI":false,"ShippingAgentCreditorID":"String","ShippingAgentCreditorAccountNo":"String","ShippingAgentCreditorName":"String","ImportCostClearingAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"},"Lines":[{"LineID":"String","ItemNo":0,"InventoryID":"String","InventoryPartNo":"String","InventoryDescription":"String","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","SHInvoicesRecID":"String","SHInvoicesInvoiceNo":"String","PurchaseOrderLineID":"String","PurchaseOrderLineOrderLineNo":"String","PurchaseOrderLineOrderID":"String","PurchaseOrderLineOrderNo":"String","PurchaseOrderLineQuantity":"String","PurchaseOrderLineQuantityDelivered":"String","QuantityOrdered":0,"QuantityThisShipment":0,"OrderedCost":0,"FXOrderedCost":0,"UnitCostExTax":0,"FXRate":0,"FXUnitCostExTax":0,"TaxRate":{"RecID":"String","TaxID":"String","Description":"String","GSTTaxGroup":"WST","Rate":0,"IsDefaultRate":false,"BASCode":0,"IsDefaultRateInGroup":false,"IsEnabled":false,"LedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"TaxAmount":0,"UnitCostIncTax":0,"LineTotalExTax":0,"LineTotalIncTax":0,"FXLineTotalExTax":0,"LandedCostLineTotal":0,"LandedCost":0}],"PurchaseOrders":[{"PurchaseOrderReceivedID":"String","OrderID":"String","OrderNo":"String","OrderedDate":"0001-01-01T00:00:00.0000000","ItemNo":0,"UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String"}],"ImportCosts":[{"ImportCostID":"String","ItemNo":0,"CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","CostType":{"CostTypeID":"String","Name":"String","Description":"String","IsEnabled":false,"IsDefault":false},"UseForwardCoverContract":false,"FXRate":0,"FXAmount":0,"HomeAmount":0,"TaxRate":{"RecID":"String","TaxID":"String","Description":"String","GSTTaxGroup":"WST","Rate":0,"IsDefaultRate":false,"BASCode":0,"IsDefaultRateInGroup":false,"IsEnabled":false,"LedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"TaxAmount":0,"TotalAmount":0,"ApportionedOnPurchaseOrders":[{"ApportionedCostID":"String","ItemNo":0,"OrdersUsedKey":"String","OrderNo":"String"}],"ApportionMethod":"Cost","Apportioned":false,"Invoiced":false,"InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","InvoiceNo":"String","Reference":"String","CR_TransID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String"}],"VOTIs":[{"VOTIID":"String","ItemNo":0,"CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","TaxRate":{"RecID":"String","TaxID":"String","Description":"String","GSTTaxGroup":"WST","Rate":0,"IsDefaultRate":false,"BASCode":0,"IsDefaultRateInGroup":false,"IsEnabled":false,"LedgerAccount":{"LedgerID":"String","AccountNo":"String","Description":"String"}},"Description":"String","InvoiceNo":"String","Reference":"String","Amount":0,"TaxAmount":0,"InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","CR_TransID":"String","UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String","Invoiced":false}],"Invoices":[{"InvoiceID":"String","InvoiceNo":"String","ItemNo":0,"Reference":"String","Remark":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","UseForwardCoverContract":false,"ForwardCoverContracts":[{"LineKey":"String","ForwardCoverContractTransactionID":"String","ForwardCoverContract":{"ForwardCoverContractID":"String","ContractNo":"String","Description":"String","Reference":"String","Currency":{"CurrencyID":"String","Name":"String","ShortName":"String","DecimalPlaces":0,"IsEnabled":false,"IsLocal":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","Rates":[{"RateID":"String","DateEntered":"0001-01-01T00:00:00.0000000","EffectiveDate":"0001-01-01T00:00:00.0000000","EffectiveDateEnd":"0001-01-01T00:00:00.0000000","TransactionRate":0}]},"FXRate":0,"FXContractAmount":0,"FXUsedAmount":0,"HomeContractAmount":0,"HomeUsedAmount":0,"InitiatedDate":"0001-01-01T00:00:00.0000000","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","Status":"Inactive","LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"FXAmount":0,"HomeAmount":0}],"CR_TransID":"String","UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String","Invoiced":false,"FXRate":0,"ExpectedHomeAmount":0,"ExpectedFXAmount":0,"HomeAmount":0,"FXAmount":0,"TaxAmount":0,"AmountIncTax":0}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}