JiwaAPI

<back to all web services

LandedCostBookInPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/BookIns/{BookInID}Updates a book in.
LandedCostBookInPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
BookInIDpathstringNo
BookIn Parameters:
NameParameterData TypeRequiredDescription
BookInIDformstringNo
BookInNoformstringNo
ShipmentformBookInShipmentNo
BookInDateformDateTime?No
Activatedformbool?No
GL_Sets_RecIDformstringNo
LastSavedDateTimeformDateTime?No
LinesformList<BookInLine>No
OtherBookInsForThisShipmentformList<BookInOtherBookIn>No
BookInShipment Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDformstringNo
ShipmentNoformstringNo
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
BookInOtherBookIn Parameters:
NameParameterData TypeRequiredDescription
BookInIDformstringNo
LinesformList<BookInOtherBookInLine>No
BookInOtherBookInLine Parameters:
NameParameterData TypeRequiredDescription
LineIDformstringNo
ItemNoformint?No
Quantityformdecimal?No
SH_Lines_RecIDformstringNo
BookIn Parameters:
NameParameterData TypeRequiredDescription
BookInIDformstringNo
BookInNoformstringNo
ShipmentformBookInShipmentNo
BookInDateformDateTime?No
Activatedformbool?No
GL_Sets_RecIDformstringNo
LastSavedDateTimeformDateTime?No
LinesformList<BookInLine>No
OtherBookInsForThisShipmentformList<BookInOtherBookIn>No

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.

PATCH /BookIns/{BookInID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"BookInID":"String","BookInNo":"String","Shipment":{"ShipmentID":"String","ShipmentNo":"String"},"BookInDate":"0001-01-01T00:00:00.0000000","Activated":false,"GL_Sets_RecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Lines":[{"LineID":"String","ItemNo":0,"Quantity":0,"QuantityPreviouslyBookedIn":0,"QuantityOutstanding":0,"ShipmentLine":{"ShipmentLineID":"String","ItemNo":0,"SHInvoicesRecID":"String","QuantityOrdered":0,"QuantityThisShipment":0,"OrderedCost":0,"FXOrderedCost":0,"UnitCostExTax":0,"FXRate":{"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},"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,"InventoryID":"String","PartNo":"String"},"LineDetails":[{"IN_SOH_LinkID":"String","Cost":0,"DateIn":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","SpecialPrice":0,"Quantity":0,"QuantityIn":0,"QuantityLeft":0,"QuantityAllocated":0,"LineDetailID":"String","SerialNo":"String","IN_LogicalID":"String","Ref":"String","HistoryText":"String","SourceID":"String","BinLocation":{"BinLocationID":"String","LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String","Description":"String","ShortName":"String","ItemNo":0,"IsDefault":false,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"OtherBookInsForThisShipment":[{"BookInID":"String","Lines":[{"LineID":"String","ItemNo":0,"Quantity":0,"SH_Lines_RecID":"String"}]}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"BookInID":"String","BookInNo":"String","Shipment":{"ShipmentID":"String","ShipmentNo":"String"},"BookInDate":"0001-01-01T00:00:00.0000000","Activated":false,"GL_Sets_RecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Lines":[{"LineID":"String","ItemNo":0,"Quantity":0,"QuantityPreviouslyBookedIn":0,"QuantityOutstanding":0,"ShipmentLine":{"ShipmentLineID":"String","ItemNo":0,"SHInvoicesRecID":"String","QuantityOrdered":0,"QuantityThisShipment":0,"OrderedCost":0,"FXOrderedCost":0,"UnitCostExTax":0,"FXRate":{"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},"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,"InventoryID":"String","PartNo":"String"},"LineDetails":[{"IN_SOH_LinkID":"String","Cost":0,"DateIn":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","SpecialPrice":0,"Quantity":0,"QuantityIn":0,"QuantityLeft":0,"QuantityAllocated":0,"LineDetailID":"String","SerialNo":"String","IN_LogicalID":"String","Ref":"String","HistoryText":"String","SourceID":"String","BinLocation":{"BinLocationID":"String","LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String","Description":"String","ShortName":"String","ItemNo":0,"IsDefault":false,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"OtherBookInsForThisShipment":[{"BookInID":"String","Lines":[{"LineID":"String","ItemNo":0,"Quantity":0,"SH_Lines_RecID":"String"}]}]}