JiwaAPI

<back to all web services

LandedCostShipmentLineGETRequest

Requires Authentication
The following routes are available for this service:
GET/Shipments/{ShipmentID}/Lines/{LineID}Retrieves a shipment line.
LandedCostShipmentLineGETRequest Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDpathstringNo
LineIDpathstringNo
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
Account Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
AccountNoformstringNo
DescriptionformstringNo

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ShipmentLine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.LandedCost.Shipments">
  <_x003C_CreditorAccountNo_x003E_k__BackingField>String</_x003C_CreditorAccountNo_x003E_k__BackingField>
  <_x003C_CreditorID_x003E_k__BackingField>String</_x003C_CreditorID_x003E_k__BackingField>
  <_x003C_CreditorName_x003E_k__BackingField>String</_x003C_CreditorName_x003E_k__BackingField>
  <_x003C_FXLineTotalExTax_x003E_k__BackingField>0</_x003C_FXLineTotalExTax_x003E_k__BackingField>
  <_x003C_FXOrderedCost_x003E_k__BackingField>0</_x003C_FXOrderedCost_x003E_k__BackingField>
  <_x003C_FXRate_x003E_k__BackingField>0</_x003C_FXRate_x003E_k__BackingField>
  <_x003C_FXUnitCostExTax_x003E_k__BackingField>0</_x003C_FXUnitCostExTax_x003E_k__BackingField>
  <_x003C_InventoryDescription_x003E_k__BackingField>String</_x003C_InventoryDescription_x003E_k__BackingField>
  <_x003C_InventoryID_x003E_k__BackingField>String</_x003C_InventoryID_x003E_k__BackingField>
  <_x003C_InventoryPartNo_x003E_k__BackingField>String</_x003C_InventoryPartNo_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
  <_x003C_LandedCostLineTotal_x003E_k__BackingField>0</_x003C_LandedCostLineTotal_x003E_k__BackingField>
  <_x003C_LandedCost_x003E_k__BackingField>0</_x003C_LandedCost_x003E_k__BackingField>
  <_x003C_LineID_x003E_k__BackingField>String</_x003C_LineID_x003E_k__BackingField>
  <_x003C_LineTotalExTax_x003E_k__BackingField>0</_x003C_LineTotalExTax_x003E_k__BackingField>
  <_x003C_LineTotalIncTax_x003E_k__BackingField>0</_x003C_LineTotalIncTax_x003E_k__BackingField>
  <_x003C_OrderedCost_x003E_k__BackingField>0</_x003C_OrderedCost_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineID_x003E_k__BackingField>String</_x003C_PurchaseOrderLineID_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineOrderID_x003E_k__BackingField>String</_x003C_PurchaseOrderLineOrderID_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineOrderLineNo_x003E_k__BackingField>String</_x003C_PurchaseOrderLineOrderLineNo_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineOrderNo_x003E_k__BackingField>String</_x003C_PurchaseOrderLineOrderNo_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineQuantityDelivered_x003E_k__BackingField>String</_x003C_PurchaseOrderLineQuantityDelivered_x003E_k__BackingField>
  <_x003C_PurchaseOrderLineQuantity_x003E_k__BackingField>String</_x003C_PurchaseOrderLineQuantity_x003E_k__BackingField>
  <_x003C_QuantityOrdered_x003E_k__BackingField>0</_x003C_QuantityOrdered_x003E_k__BackingField>
  <_x003C_QuantityThisShipment_x003E_k__BackingField>0</_x003C_QuantityThisShipment_x003E_k__BackingField>
  <_x003C_SHInvoicesInvoiceNo_x003E_k__BackingField>String</_x003C_SHInvoicesInvoiceNo_x003E_k__BackingField>
  <_x003C_SHInvoicesRecID_x003E_k__BackingField>String</_x003C_SHInvoicesRecID_x003E_k__BackingField>
  <_x003C_TaxAmount_x003E_k__BackingField>0</_x003C_TaxAmount_x003E_k__BackingField>
  <_x003C_TaxRate_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tax">
    <d2p1:_x003C_BASCode_x003E_k__BackingField>0</d2p1:_x003C_BASCode_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField>WST</d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField>
    <d2p1:_x003C_IsDefaultRateInGroup_x003E_k__BackingField>false</d2p1:_x003C_IsDefaultRateInGroup_x003E_k__BackingField>
    <d2p1:_x003C_IsDefaultRate_x003E_k__BackingField>false</d2p1:_x003C_IsDefaultRate_x003E_k__BackingField>
    <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
    <d2p1:_x003C_LedgerAccount_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger">
      <d3p1:_x003C_AccountNo_x003E_k__BackingField>String</d3p1:_x003C_AccountNo_x003E_k__BackingField>
      <d3p1:_x003C_Description_x003E_k__BackingField>String</d3p1:_x003C_Description_x003E_k__BackingField>
      <d3p1:_x003C_LedgerID_x003E_k__BackingField>String</d3p1:_x003C_LedgerID_x003E_k__BackingField>
    </d2p1:_x003C_LedgerAccount_x003E_k__BackingField>
    <d2p1:_x003C_Rate_x003E_k__BackingField>0</d2p1:_x003C_Rate_x003E_k__BackingField>
    <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    <d2p1:_x003C_TaxID_x003E_k__BackingField>String</d2p1:_x003C_TaxID_x003E_k__BackingField>
  </_x003C_TaxRate_x003E_k__BackingField>
  <_x003C_UnitCostExTax_x003E_k__BackingField>0</_x003C_UnitCostExTax_x003E_k__BackingField>
  <_x003C_UnitCostIncTax_x003E_k__BackingField>0</_x003C_UnitCostIncTax_x003E_k__BackingField>
</ShipmentLine>