| POST | /Shipments/FromPurchaseOrders/{OrderNos} | Creates a shipment from the supplied purchase orders. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNos | path | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentID | form | string | No | |
| ShipmentNo | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| InitiatedDate | form | DateTime? | No | |
| DepartureDate | form | DateTime? | No | |
| ExpectedArrivalDate | form | DateTime? | No | |
| ScheduledArrivalDate | form | DateTime? | No | |
| ReceiptDate | form | DateTime? | No | |
| DeliveryNotes | form | string | No | |
| Status | form | StatusType? | No | |
| WayBillNo | form | string | No | |
| VesselName | form | string | No | |
| ContainerNo | form | string | No | |
| UseVOTI | form | bool? | No | |
| ShippingAgentCreditorID | form | string | No | |
| ShippingAgentCreditorAccountNo | form | string | No | |
| ShippingAgentCreditorName | form | string | No | |
| ImportCostClearingAccount | form | Account | No | |
| Lines | form | List<ShipmentLine> | No | |
| PurchaseOrders | form | List<ShipmentPurchaseOrderReceived> | No | |
| ImportCosts | form | List<ShipmentImportCost> | No | |
| VOTIs | form | List<ShipmentVOTI> | No | |
| Invoices | form | List<ShipmentInvoice> | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerID | form | string | No | |
| AccountNo | form | string | No | |
| Description | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LineID | form | string | No | |
| ItemNo | form | int? | No | |
| InventoryID | form | string | No | |
| InventoryPartNo | form | string | No | |
| InventoryDescription | form | string | No | |
| CreditorID | form | string | No | |
| CreditorAccountNo | form | string | No | |
| CreditorName | form | string | No | |
| SHInvoicesRecID | form | string | No | |
| SHInvoicesInvoiceNo | form | string | No | |
| PurchaseOrderLineID | form | string | No | |
| PurchaseOrderLineOrderLineNo | form | string | No | |
| PurchaseOrderLineOrderID | form | string | No | |
| PurchaseOrderLineOrderNo | form | string | No | |
| PurchaseOrderLineQuantity | form | string | No | |
| PurchaseOrderLineQuantityDelivered | form | string | No | |
| QuantityOrdered | form | decimal? | No | |
| QuantityThisShipment | form | decimal? | No | |
| OrderedCost | form | decimal? | No | |
| FXOrderedCost | form | decimal? | No | |
| UnitCostExTax | form | decimal? | No | |
| FXRate | form | decimal? | No | |
| FXUnitCostExTax | form | decimal? | No | |
| TaxRate | form | TaxRate | No | |
| TaxAmount | form | decimal? | No | |
| UnitCostIncTax | form | decimal? | No | |
| LineTotalExTax | form | decimal? | No | |
| LineTotalIncTax | form | decimal? | No | |
| FXLineTotalExTax | form | decimal? | No | |
| LandedCostLineTotal | form | decimal? | No | |
| LandedCost | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| TaxID | form | string | No | |
| Description | form | string | No | |
| GSTTaxGroup | form | TaxRateTypes? | No | |
| Rate | form | decimal? | No | |
| IsDefaultRate | form | bool? | No | |
| BASCode | form | decimal? | No | |
| IsDefaultRateInGroup | form | bool? | No | |
| IsEnabled | form | bool? | No | |
| LedgerAccount | form | Account | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PurchaseOrderReceivedID | form | string | No | |
| OrderID | form | string | No | |
| OrderNo | form | string | No | |
| OrderedDate | form | DateTime? | No | |
| ItemNo | form | int? | No | |
| UserField1 | form | string | No | |
| UserField2 | form | string | No | |
| UserField3 | form | string | No | |
| UserField4 | form | string | No | |
| UserField5 | form | string | No | |
| UserField6 | form | string | No | |
| UserField7 | form | string | No | |
| UserField8 | form | string | No | |
| UserField9 | form | string | No | |
| UserField10 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ImportCostID | form | string | No | |
| ItemNo | form | int? | No | |
| CreditorID | form | string | No | |
| CreditorAccountNo | form | string | No | |
| CreditorName | form | string | No | |
| CostType | form | ShipmentCostType | No | |
| UseForwardCoverContract | form | bool? | No | |
| FXRate | form | decimal? | No | |
| FXAmount | form | decimal? | No | |
| HomeAmount | form | decimal? | No | |
| TaxRate | form | TaxRate | No | |
| TaxAmount | form | decimal? | No | |
| TotalAmount | form | decimal? | No | |
| ApportionedOnPurchaseOrders | form | List<ShipmentApportionedCost> | No | |
| ApportionMethod | form | ApportionMethods? | No | |
| Apportioned | form | bool? | No | |
| Invoiced | form | bool? | No | |
| InvoiceDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| InvoiceNo | form | string | No | |
| Reference | form | string | No | |
| CR_TransID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| UserField1 | form | string | No | |
| UserField2 | form | string | No | |
| UserField3 | form | string | No | |
| UserField4 | form | string | No | |
| UserField5 | form | string | No | |
| UserField6 | form | string | No | |
| UserField7 | form | string | No | |
| UserField8 | form | string | No | |
| UserField9 | form | string | No | |
| UserField10 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CostTypeID | form | string | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| IsEnabled | form | bool? | No | |
| IsDefault | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApportionedCostID | form | string | No | |
| ItemNo | form | int? | No | |
| OrdersUsedKey | form | string | No | |
| OrderNo | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VOTIID | form | string | No | |
| ItemNo | form | int? | No | |
| CreditorID | form | string | No | |
| CreditorAccountNo | form | string | No | |
| CreditorName | form | string | No | |
| TaxRate | form | TaxRate | No | |
| Description | form | string | No | |
| InvoiceNo | form | string | No | |
| Reference | form | string | No | |
| Amount | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| InvoiceDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| CR_TransID | form | string | No | |
| UserField1 | form | string | No | |
| UserField2 | form | string | No | |
| UserField3 | form | string | No | |
| UserField4 | form | string | No | |
| UserField5 | form | string | No | |
| UserField6 | form | string | No | |
| UserField7 | form | string | No | |
| UserField8 | form | string | No | |
| UserField9 | form | string | No | |
| UserField10 | form | string | No | |
| Invoiced | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceID | form | string | No | |
| InvoiceNo | form | string | No | |
| ItemNo | form | int? | No | |
| Reference | form | string | No | |
| Remark | form | string | No | |
| InvoiceDate | form | DateTime? | No | |
| DueDate | form | DateTime? | No | |
| CreditorID | form | string | No | |
| CreditorAccountNo | form | string | No | |
| CreditorName | form | string | No | |
| UseForwardCoverContract | form | bool? | No | |
| ForwardCoverContracts | form | List<ShipmentForwardCoverContract> | No | |
| CR_TransID | form | string | No | |
| UserField1 | form | string | No | |
| UserField2 | form | string | No | |
| UserField3 | form | string | No | |
| UserField4 | form | string | No | |
| UserField5 | form | string | No | |
| UserField6 | form | string | No | |
| UserField7 | form | string | No | |
| UserField8 | form | string | No | |
| UserField9 | form | string | No | |
| UserField10 | form | string | No | |
| Invoiced | form | bool? | No | |
| FXRate | form | decimal? | No | |
| ExpectedHomeAmount | form | decimal? | No | |
| ExpectedFXAmount | form | decimal? | No | |
| HomeAmount | form | decimal? | No | |
| FXAmount | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| AmountIncTax | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LineKey | form | string | No | |
| ForwardCoverContractTransactionID | form | string | No | |
| ForwardCoverContract | form | ForwardCoverContract | No | |
| FXAmount | form | decimal? | No | |
| HomeAmount | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ForwardCoverContractID | form | string | No | |
| ContractNo | form | string | No | |
| Description | form | string | No | |
| Reference | form | string | No | |
| Currency | form | Currency | No | |
| FXRate | form | decimal? | No | |
| FXContractAmount | form | decimal? | No | |
| FXUsedAmount | form | decimal? | No | |
| HomeContractAmount | form | decimal? | No | |
| HomeUsedAmount | form | decimal? | No | |
| InitiatedDate | form | DateTime? | No | |
| StartDate | form | DateTime? | No | |
| EndDate | form | DateTime? | No | |
| Status | form | Statuses? | No | |
| LastSavedDateTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyID | form | string | No | |
| Name | form | string | No | |
| ShortName | form | string | No | |
| DecimalPlaces | form | int? | No | |
| IsEnabled | form | bool? | No | |
| IsLocal | form | bool? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| Rates | form | List<CurrencyRate> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RateID | form | string | No | |
| DateEntered | form | DateTime? | No | |
| EffectiveDate | form | DateTime? | No | |
| EffectiveDateEnd | form | DateTime? | No | |
| TransactionRate | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingID | form | string | No | |
| SettingName | form | string | No | |
| Contents | form | string | No | |
| PluginID | form | string | No | |
| PluginName | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"OrderNos":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}