JiwaAPI

<back to all web services

LandedCostBookInLineGETRequest

Requires Authentication
The following routes are available for this service:
GET/BookIns/{BookInID}/Lines/{LineID}Retrieves a book in line.
LandedCostBookInLineGETRequest Parameters:
NameParameterData TypeRequiredDescription
BookInIDpathstringNo
LineIDpathstringNo
BookInLine Parameters:
NameParameterData TypeRequiredDescription
LineIDformstringNo
ItemNoformint?No
Quantityformdecimal?No
QuantityPreviouslyBookedInformdecimal?No
QuantityOutstandingformdecimal?No
ShipmentLineformBookInShipmentLineNo
LineDetailsformList<InventorySOHLineDetail>No
CustomFieldValuesformList<CustomFieldValue>No
BookInShipmentLine Parameters:
NameParameterData TypeRequiredDescription
ShipmentLineIDformstringNo
ItemNoformint?No
SHInvoicesRecIDformstringNo
QuantityOrderedformdecimal?No
QuantityThisShipmentformdecimal?No
OrderedCostformdecimal?No
FXOrderedCostformdecimal?No
UnitCostExTaxformdecimal?No
FXRateformCurrencyRateNo
FXUnitCostExTaxformdecimal?No
TaxRateformTaxRateNo
TaxAmountformdecimal?No
UnitCostIncTaxformdecimal?No
LineTotalExTaxformdecimal?No
LineTotalIncTaxformdecimal?No
FXLineTotalExTaxformdecimal?No
LandedCostLineTotalformdecimal?No
LandedCostformdecimal?No
InventoryIDformstringNo
PartNoformstringNo
CurrencyRate Parameters:
NameParameterData TypeRequiredDescription
RateIDformstringNo
DateEnteredformDateTime?No
EffectiveDateformDateTime?No
EffectiveDateEndformDateTime?No
TransactionRateformdecimal?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
InventorySOHLineDetail Parameters:
NameParameterData TypeRequiredDescription
IN_SOH_LinkIDformstringNo
Costformdecimal?No
DateInformDateTime?No
ExpiryDateformDateTime?No
SpecialPriceformdecimal?No
Quantityformdecimal?No
QuantityInformdecimal?No
QuantityLeftformdecimal?No
QuantityAllocatedformdecimal?No
LineDetailIDformstringNo
SerialNoformstringNo
IN_LogicalIDformstringNo
RefformstringNo
HistoryTextformstringNo
SourceIDformstringNo
BinLocationformInventoryBinLocationNo
InventoryBinLocation Parameters:
NameParameterData TypeRequiredDescription
BinLocationIDformstringNo
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo
DescriptionformstringNo
ShortNameformstringNo
ItemNoformint?No
IsDefaultformbool?No
CustomFieldValuesformList<CustomFieldValue>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 .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 /BookIns/{BookInID}/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

<BookInLine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.LandedCost.BookIns">
  <_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
    <d2p1:CustomFieldValue>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_PluginID_x003E_k__BackingField>String</d2p1:_x003C_PluginID_x003E_k__BackingField>
      <d2p1:_x003C_PluginName_x003E_k__BackingField>String</d2p1:_x003C_PluginName_x003E_k__BackingField>
      <d2p1:_x003C_SettingID_x003E_k__BackingField>String</d2p1:_x003C_SettingID_x003E_k__BackingField>
      <d2p1:_x003C_SettingName_x003E_k__BackingField>String</d2p1:_x003C_SettingName_x003E_k__BackingField>
    </d2p1:CustomFieldValue>
  </_x003C_CustomFieldValues_x003E_k__BackingField>
  <_x003C_ItemNo_x003E_k__BackingField>0</_x003C_ItemNo_x003E_k__BackingField>
  <_x003C_LineDetails_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Inventory.SOH">
    <d2p1:InventorySOHLineDetail>
      <d2p1:_x003C_BinLocation_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Inventory">
        <d4p1:_x003C_BinLocationID_x003E_k__BackingField>String</d4p1:_x003C_BinLocationID_x003E_k__BackingField>
        <d4p1:_x003C_CustomFieldValues_x003E_k__BackingField xmlns:d5p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.CustomFields">
          <d5p1:CustomFieldValue>
            <d5p1:_x003C_Contents_x003E_k__BackingField>String</d5p1:_x003C_Contents_x003E_k__BackingField>
            <d5p1:_x003C_PluginID_x003E_k__BackingField>String</d5p1:_x003C_PluginID_x003E_k__BackingField>
            <d5p1:_x003C_PluginName_x003E_k__BackingField>String</d5p1:_x003C_PluginName_x003E_k__BackingField>
            <d5p1:_x003C_SettingID_x003E_k__BackingField>String</d5p1:_x003C_SettingID_x003E_k__BackingField>
            <d5p1:_x003C_SettingName_x003E_k__BackingField>String</d5p1:_x003C_SettingName_x003E_k__BackingField>
          </d5p1:CustomFieldValue>
        </d4p1:_x003C_CustomFieldValues_x003E_k__BackingField>
        <d4p1:_x003C_Description_x003E_k__BackingField>String</d4p1:_x003C_Description_x003E_k__BackingField>
        <d4p1:_x003C_IsDefault_x003E_k__BackingField>false</d4p1:_x003C_IsDefault_x003E_k__BackingField>
        <d4p1:_x003C_ItemNo_x003E_k__BackingField>0</d4p1:_x003C_ItemNo_x003E_k__BackingField>
        <d4p1:_x003C_LogicalWarehouseDescription_x003E_k__BackingField>String</d4p1:_x003C_LogicalWarehouseDescription_x003E_k__BackingField>
        <d4p1:_x003C_LogicalWarehouseID_x003E_k__BackingField>String</d4p1:_x003C_LogicalWarehouseID_x003E_k__BackingField>
        <d4p1:_x003C_PhysicalWarehouseDescription_x003E_k__BackingField>String</d4p1:_x003C_PhysicalWarehouseDescription_x003E_k__BackingField>
        <d4p1:_x003C_PhysicalWarehouseID_x003E_k__BackingField>String</d4p1:_x003C_PhysicalWarehouseID_x003E_k__BackingField>
        <d4p1:_x003C_ShortName_x003E_k__BackingField>String</d4p1:_x003C_ShortName_x003E_k__BackingField>
      </d2p1:_x003C_BinLocation_x003E_k__BackingField>
      <d2p1:_x003C_Cost_x003E_k__BackingField>0</d2p1:_x003C_Cost_x003E_k__BackingField>
      <d2p1:_x003C_DateIn_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateIn_x003E_k__BackingField>
      <d2p1:_x003C_ExpiryDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ExpiryDate_x003E_k__BackingField>
      <d2p1:_x003C_HistoryText_x003E_k__BackingField>String</d2p1:_x003C_HistoryText_x003E_k__BackingField>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_IN_SOH_LinkID_x003E_k__BackingField>String</d2p1:_x003C_IN_SOH_LinkID_x003E_k__BackingField>
      <d2p1:_x003C_LineDetailID_x003E_k__BackingField>String</d2p1:_x003C_LineDetailID_x003E_k__BackingField>
      <d2p1:_x003C_QuantityAllocated_x003E_k__BackingField>0</d2p1:_x003C_QuantityAllocated_x003E_k__BackingField>
      <d2p1:_x003C_QuantityIn_x003E_k__BackingField>0</d2p1:_x003C_QuantityIn_x003E_k__BackingField>
      <d2p1:_x003C_QuantityLeft_x003E_k__BackingField>0</d2p1:_x003C_QuantityLeft_x003E_k__BackingField>
      <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
      <d2p1:_x003C_Ref_x003E_k__BackingField>String</d2p1:_x003C_Ref_x003E_k__BackingField>
      <d2p1:_x003C_SerialNo_x003E_k__BackingField>String</d2p1:_x003C_SerialNo_x003E_k__BackingField>
      <d2p1:_x003C_SourceID_x003E_k__BackingField>String</d2p1:_x003C_SourceID_x003E_k__BackingField>
      <d2p1:_x003C_SpecialPrice_x003E_k__BackingField>0</d2p1:_x003C_SpecialPrice_x003E_k__BackingField>
    </d2p1:InventorySOHLineDetail>
  </_x003C_LineDetails_x003E_k__BackingField>
  <_x003C_LineID_x003E_k__BackingField>String</_x003C_LineID_x003E_k__BackingField>
  <_x003C_QuantityOutstanding_x003E_k__BackingField>0</_x003C_QuantityOutstanding_x003E_k__BackingField>
  <_x003C_QuantityPreviouslyBookedIn_x003E_k__BackingField>0</_x003C_QuantityPreviouslyBookedIn_x003E_k__BackingField>
  <_x003C_Quantity_x003E_k__BackingField>0</_x003C_Quantity_x003E_k__BackingField>
  <_x003C_ShipmentLine_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 xmlns:d3p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Currencies">
      <d3p1:_x003C_DateEntered_x003E_k__BackingField>0001-01-01T00:00:00</d3p1:_x003C_DateEntered_x003E_k__BackingField>
      <d3p1:_x003C_EffectiveDateEnd_x003E_k__BackingField>0001-01-01T00:00:00</d3p1:_x003C_EffectiveDateEnd_x003E_k__BackingField>
      <d3p1:_x003C_EffectiveDate_x003E_k__BackingField>0001-01-01T00:00:00</d3p1:_x003C_EffectiveDate_x003E_k__BackingField>
      <d3p1:_x003C_RateID_x003E_k__BackingField>String</d3p1:_x003C_RateID_x003E_k__BackingField>
      <d3p1:_x003C_TransactionRate_x003E_k__BackingField>0</d3p1:_x003C_TransactionRate_x003E_k__BackingField>
    </_x003C_FXRate_x003E_k__BackingField>
    <_x003C_FXUnitCostExTax_x003E_k__BackingField>0</_x003C_FXUnitCostExTax_x003E_k__BackingField>
    <_x003C_InventoryID_x003E_k__BackingField>String</_x003C_InventoryID_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_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_PartNo_x003E_k__BackingField>String</_x003C_PartNo_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_SHInvoicesRecID_x003E_k__BackingField>String</_x003C_SHInvoicesRecID_x003E_k__BackingField>
    <_x003C_ShipmentLineID_x003E_k__BackingField>String</_x003C_ShipmentLineID_x003E_k__BackingField>
    <_x003C_TaxAmount_x003E_k__BackingField>0</_x003C_TaxAmount_x003E_k__BackingField>
    <_x003C_TaxRate_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tax">
      <d3p1:_x003C_BASCode_x003E_k__BackingField>0</d3p1:_x003C_BASCode_x003E_k__BackingField>
      <d3p1:_x003C_Description_x003E_k__BackingField>String</d3p1:_x003C_Description_x003E_k__BackingField>
      <d3p1:_x003C_GSTTaxGroup_x003E_k__BackingField>WST</d3p1:_x003C_GSTTaxGroup_x003E_k__BackingField>
      <d3p1:_x003C_IsDefaultRateInGroup_x003E_k__BackingField>false</d3p1:_x003C_IsDefaultRateInGroup_x003E_k__BackingField>
      <d3p1:_x003C_IsDefaultRate_x003E_k__BackingField>false</d3p1:_x003C_IsDefaultRate_x003E_k__BackingField>
      <d3p1:_x003C_IsEnabled_x003E_k__BackingField>false</d3p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d3p1:_x003C_LedgerAccount_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.GeneralLedger">
        <d4p1:_x003C_AccountNo_x003E_k__BackingField>String</d4p1:_x003C_AccountNo_x003E_k__BackingField>
        <d4p1:_x003C_Description_x003E_k__BackingField>String</d4p1:_x003C_Description_x003E_k__BackingField>
        <d4p1:_x003C_LedgerID_x003E_k__BackingField>String</d4p1:_x003C_LedgerID_x003E_k__BackingField>
      </d3p1:_x003C_LedgerAccount_x003E_k__BackingField>
      <d3p1:_x003C_Rate_x003E_k__BackingField>0</d3p1:_x003C_Rate_x003E_k__BackingField>
      <d3p1:_x003C_RecID_x003E_k__BackingField>String</d3p1:_x003C_RecID_x003E_k__BackingField>
      <d3p1:_x003C_TaxID_x003E_k__BackingField>String</d3p1:_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>
  </_x003C_ShipmentLine_x003E_k__BackingField>
</BookInLine>