| GET | /BookIns/{BookInID} | Retrieves a book in. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookInID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookInID | form | string | No | |
| BookInNo | form | string | No | |
| Shipment | form | BookInShipment | No | |
| BookInDate | form | DateTime? | No | |
| Activated | form | bool? | No | |
| GL_Sets_RecID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| Lines | form | List<BookInLine> | No | |
| OtherBookInsForThisShipment | form | List<BookInOtherBookIn> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentID | form | string | No | |
| ShipmentNo | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LineID | form | string | No | |
| ItemNo | form | int? | No | |
| Quantity | form | decimal? | No | |
| QuantityPreviouslyBookedIn | form | decimal? | No | |
| QuantityOutstanding | form | decimal? | No | |
| ShipmentLine | form | BookInShipmentLine | No | |
| LineDetails | form | List<InventorySOHLineDetail> | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentLineID | form | string | No | |
| ItemNo | form | int? | No | |
| SHInvoicesRecID | 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 | CurrencyRate | 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 | |
| InventoryID | form | string | No | |
| PartNo | form | string | 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 |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IN_SOH_LinkID | form | string | No | |
| Cost | form | decimal? | No | |
| DateIn | form | DateTime? | No | |
| ExpiryDate | form | DateTime? | No | |
| SpecialPrice | form | decimal? | No | |
| Quantity | form | decimal? | No | |
| QuantityIn | form | decimal? | No | |
| QuantityLeft | form | decimal? | No | |
| QuantityAllocated | form | decimal? | No | |
| LineDetailID | form | string | No | |
| SerialNo | form | string | No | |
| IN_LogicalID | form | string | No | |
| Ref | form | string | No | |
| HistoryText | form | string | No | |
| SourceID | form | string | No | |
| BinLocation | form | InventoryBinLocation | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BinLocationID | form | string | No | |
| LogicalWarehouseID | form | string | No | |
| LogicalWarehouseDescription | form | string | No | |
| PhysicalWarehouseID | form | string | No | |
| PhysicalWarehouseDescription | form | string | No | |
| Description | form | string | No | |
| ShortName | form | string | No | |
| ItemNo | form | int? | No | |
| IsDefault | form | bool? | No | |
| CustomFieldValues | form | List<CustomFieldValue> | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BookInID | form | string | No | |
| Lines | form | List<BookInOtherBookInLine> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LineID | form | string | No | |
| ItemNo | form | int? | No | |
| Quantity | form | decimal? | No | |
| SH_Lines_RecID | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookIns/{BookInID} HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
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"}]}]}