GET | /Shipments/{ShipmentID}/Lines/{LineID} | Retrieves a shipment line. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ShipmentID | path | string | No | |
LineID | path | 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 |
---|---|---|---|---|
LedgerID | form | string | No | |
AccountNo | form | string | No | |
Description | 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.
GET /Shipments/{ShipmentID}/Lines/{LineID} HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"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}