| GET | /StockTransfers/{TransferID} | Retrieves a stock transfer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransferID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransferID | form | string | No | |
| TransferNo | form | string | No | |
| Status | form | Statuses? | No | |
| TransferDate | form | DateTime? | No | |
| Reference | form | string | No | |
| LogicalWarehouseID | form | string | No | |
| LogicalWarehouseDescription | form | string | No | |
| PhysicalWarehouseID | form | string | No | |
| PhysicalWarehouseDescription | form | string | No | |
| LastSavedByStaffID | form | string | No | |
| LastSavedByStaffUserName | form | string | No | |
| LastSavedByStaffTitle | form | string | No | |
| LastSavedByStaffFirstName | form | string | No | |
| LastSavedByStaffSurname | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| CreatedByStaffID | form | string | No | |
| CreatedByStaffUserName | form | string | No | |
| CreatedByStaffTitle | form | string | No | |
| CreatedByStaffFirstName | form | string | No | |
| CreatedByStaffSurname | form | string | No | |
| CreatedDateTime | form | DateTime? | No | |
| Lines | form | List<StockTransferLine> | No | |
| Notes | form | List<Note> | No | |
| Documents | form | List<Document> | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No | |
| StockTransferReasonRecID | form | string | No | |
| StockTransferReasonName | form | string | No | |
| StockTransferReasonIsDefault | form | bool? | No | |
| StockTransferReasonWriteOffLedgerAccountOverride | form | bool? | No | |
| StockTransferReasonWriteOffLedgerAccountRecID | form | string | No | |
| StockTransferReasonWriteOffLedgerAccountNo | form | string | No | |
| StockTransferReasonWriteOffLedgerAccountDescription | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountOverride | form | bool? | No | |
| StockTransferReasonWriteOnLedgerAccountRecID | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountNo | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountDescription | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransferLineID | form | string | No | |
| ItemNo | form | int? | No | |
| FromInventoryRecID | form | string | No | |
| FromInventoryPartNo | form | string | No | |
| FromInventoryDescription | form | string | No | |
| FromInventoryDecimalPlaces | form | int? | No | |
| FromInventoryLastCost | form | decimal? | No | |
| FromInventoryCubic | form | decimal? | No | |
| FromInventoryWeight | form | decimal? | No | |
| FromInventoryUnits | form | string | No | |
| FromInventoryIsPhysical | form | bool? | No | |
| FromInventoryIsSerial | form | bool? | No | |
| FromInventoryInventoryValueLedgerRecID | form | string | No | |
| FromInventoryInventoryValueLedgerAccountNo | form | string | No | |
| FromInventoryInventoryValueLedgerDescription | form | string | No | |
| FromInventoryWriteOnLedgerAccountRecID | form | string | No | |
| FromInventoryWriteOnLedgerAccountNo | form | string | No | |
| FromInventoryWriteOnLedgerAccountDescription | form | string | No | |
| FromInventoryWriteOffLedgerAccountRecID | form | string | No | |
| FromInventoryWriteOffLedgerAccountNo | form | string | No | |
| FromInventoryWriteOffLedgerAccountDescription | form | string | No | |
| FromPartInventorySOHID | form | string | No | |
| FromPartOriginalQuantity | form | decimal? | No | |
| FromPartSerialNo | form | string | No | |
| FromPartComment | form | string | No | |
| FromPartExpiryDate | form | DateTime? | No | |
| FromPartBinLocation | form | string | No | |
| Reference | form | string | No | |
| AvailableQuantity | form | decimal? | No | |
| TransferQuantity | form | decimal? | No | |
| StockTransferReasonRecID | form | string | No | |
| StockTransferReasonName | form | string | No | |
| StockTransferReasonIsDefault | form | bool? | No | |
| StockTransferReasonWriteOffLedgerAccountOverride | form | bool? | No | |
| StockTransferReasonWriteOffLedgerAccountRecID | form | string | No | |
| StockTransferReasonWriteOffLedgerAccountNo | form | string | No | |
| StockTransferReasonWriteOffLedgerAccountDescription | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountOverride | form | bool? | No | |
| StockTransferReasonWriteOnLedgerAccountRecID | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountNo | form | string | No | |
| StockTransferReasonWriteOnLedgerAccountDescription | form | string | No | |
| ToInventoryRecID | form | string | No | |
| ToInventoryPartNo | form | string | No | |
| ToInventoryDescription | form | string | No | |
| ToInventoryDecimalPlaces | form | int? | No | |
| ToInventoryLastCost | form | decimal? | No | |
| ToInventoryCubic | form | decimal? | No | |
| ToInventoryWeight | form | decimal? | No | |
| ToInventoryUnits | form | string | No | |
| ToInventoryIsPhysical | form | bool? | No | |
| ToInventoryIsSerial | form | bool? | No | |
| ToInventoryInventoryValueLedgerRecID | form | string | No | |
| ToInventoryInventoryValueLedgerAccountNo | form | string | No | |
| ToInventoryInventoryValueLedgerDescription | form | string | No | |
| ToInventoryWriteOnLedgerAccountRecID | form | string | No | |
| ToInventoryWriteOnLedgerAccountNo | form | string | No | |
| ToInventoryWriteOnLedgerAccountDescription | form | string | No | |
| ToInventoryWriteOffLedgerAccountRecID | form | string | No | |
| ToInventoryWriteOffLedgerAccountNo | form | string | No | |
| ToInventoryWriteOffLedgerAccountDescription | form | string | No | |
| ToPartInventorySOHID | form | string | No | |
| ToPartSerialNo | form | string | No | |
| ToPartComment | form | string | No | |
| ToPartExpiryDate | form | DateTime? | No | |
| ToPartBinLocation | form | string | No | |
| LastSavedByStaffID | form | string | No | |
| LastSavedByStaffUserName | form | string | No | |
| LastSavedByStaffTitle | form | string | No | |
| LastSavedByStaffFirstName | form | string | No | |
| LastSavedByStaffSurname | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| CreatedByStaffID | form | string | No | |
| CreatedByStaffUserName | form | string | No | |
| CreatedByStaffTitle | form | string | No | |
| CreatedByStaffFirstName | form | string | No | |
| CreatedByStaffSurname | form | string | No | |
| CreatedDateTime | form | DateTime? | 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 |
|---|---|---|---|---|
| NoteID | form | string | No | |
| NoteType | form | NoteType | No | |
| LineNo | form | int? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| NoteText | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoteTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | DocumentType | No | |
| FileID | form | string | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| FileBinary | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | 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 /StockTransfers/{TransferID} HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"TransferID":"String","TransferNo":"String","Status":"UnActivated","TransferDate":"0001-01-01T00:00:00.0000000","Reference":"String","LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String","LastSavedByStaffID":"String","LastSavedByStaffUserName":"String","LastSavedByStaffTitle":"String","LastSavedByStaffFirstName":"String","LastSavedByStaffSurname":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","CreatedByStaffID":"String","CreatedByStaffUserName":"String","CreatedByStaffTitle":"String","CreatedByStaffFirstName":"String","CreatedByStaffSurname":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","Lines":[{"TransferLineID":"String","ItemNo":0,"FromInventoryRecID":"String","FromInventoryPartNo":"String","FromInventoryDescription":"String","FromInventoryDecimalPlaces":0,"FromInventoryLastCost":0,"FromInventoryCubic":0,"FromInventoryWeight":0,"FromInventoryUnits":"String","FromInventoryIsPhysical":false,"FromInventoryIsSerial":false,"FromInventoryInventoryValueLedgerRecID":"String","FromInventoryInventoryValueLedgerAccountNo":"String","FromInventoryInventoryValueLedgerDescription":"String","FromInventoryWriteOnLedgerAccountRecID":"String","FromInventoryWriteOnLedgerAccountNo":"String","FromInventoryWriteOnLedgerAccountDescription":"String","FromInventoryWriteOffLedgerAccountRecID":"String","FromInventoryWriteOffLedgerAccountNo":"String","FromInventoryWriteOffLedgerAccountDescription":"String","FromPartInventorySOHID":"String","FromPartOriginalQuantity":0,"FromPartSerialNo":"String","FromPartComment":"String","FromPartExpiryDate":"0001-01-01T00:00:00.0000000","FromPartBinLocation":"String","Reference":"String","AvailableQuantity":0,"TransferQuantity":0,"StockTransferReasonRecID":"String","StockTransferReasonName":"String","StockTransferReasonIsDefault":false,"StockTransferReasonWriteOffLedgerAccountOverride":false,"StockTransferReasonWriteOffLedgerAccountRecID":"String","StockTransferReasonWriteOffLedgerAccountNo":"String","StockTransferReasonWriteOffLedgerAccountDescription":"String","StockTransferReasonWriteOnLedgerAccountOverride":false,"StockTransferReasonWriteOnLedgerAccountRecID":"String","StockTransferReasonWriteOnLedgerAccountNo":"String","StockTransferReasonWriteOnLedgerAccountDescription":"String","ToInventoryRecID":"String","ToInventoryPartNo":"String","ToInventoryDescription":"String","ToInventoryDecimalPlaces":0,"ToInventoryLastCost":0,"ToInventoryCubic":0,"ToInventoryWeight":0,"ToInventoryUnits":"String","ToInventoryIsPhysical":false,"ToInventoryIsSerial":false,"ToInventoryInventoryValueLedgerRecID":"String","ToInventoryInventoryValueLedgerAccountNo":"String","ToInventoryInventoryValueLedgerDescription":"String","ToInventoryWriteOnLedgerAccountRecID":"String","ToInventoryWriteOnLedgerAccountNo":"String","ToInventoryWriteOnLedgerAccountDescription":"String","ToInventoryWriteOffLedgerAccountRecID":"String","ToInventoryWriteOffLedgerAccountNo":"String","ToInventoryWriteOffLedgerAccountDescription":"String","ToPartInventorySOHID":"String","ToPartSerialNo":"String","ToPartComment":"String","ToPartExpiryDate":"0001-01-01T00:00:00.0000000","ToPartBinLocation":"String","LastSavedByStaffID":"String","LastSavedByStaffUserName":"String","LastSavedByStaffTitle":"String","LastSavedByStaffFirstName":"String","LastSavedByStaffSurname":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","CreatedByStaffID":"String","CreatedByStaffUserName":"String","CreatedByStaffTitle":"String","CreatedByStaffFirstName":"String","CreatedByStaffSurname":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"Notes":[{"NoteID":"String","NoteType":{"NoteTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"LineNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","NoteText":"String"}],"Documents":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"StockTransferReasonRecID":"String","StockTransferReasonName":"String","StockTransferReasonIsDefault":false,"StockTransferReasonWriteOffLedgerAccountOverride":false,"StockTransferReasonWriteOffLedgerAccountRecID":"String","StockTransferReasonWriteOffLedgerAccountNo":"String","StockTransferReasonWriteOffLedgerAccountDescription":"String","StockTransferReasonWriteOnLedgerAccountOverride":false,"StockTransferReasonWriteOnLedgerAccountRecID":"String","StockTransferReasonWriteOnLedgerAccountNo":"String","StockTransferReasonWriteOnLedgerAccountDescription":"String"}