JiwaAPI

<back to all web services

StockTransferGETRequest

Requires Authentication
The following routes are available for this service:
GET/StockTransfers/{TransferID}Retrieves a stock transfer.
StockTransferGETRequest Parameters:
NameParameterData TypeRequiredDescription
TransferIDpathstringNo
StockTransfer Parameters:
NameParameterData TypeRequiredDescription
TransferIDformstringNo
TransferNoformstringNo
StatusformStatuses?No
TransferDateformDateTime?No
ReferenceformstringNo
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo
LastSavedByStaffIDformstringNo
LastSavedByStaffUserNameformstringNo
LastSavedByStaffTitleformstringNo
LastSavedByStaffFirstNameformstringNo
LastSavedByStaffSurnameformstringNo
LastSavedDateTimeformDateTime?No
CreatedByStaffIDformstringNo
CreatedByStaffUserNameformstringNo
CreatedByStaffTitleformstringNo
CreatedByStaffFirstNameformstringNo
CreatedByStaffSurnameformstringNo
CreatedDateTimeformDateTime?No
LinesformList<StockTransferLine>No
NotesformList<Note>No
DocumentsformList<Document>No
CustomFieldValuesformList<CustomFieldValue>No
StockTransferReasonRecIDformstringNo
StockTransferReasonNameformstringNo
StockTransferReasonIsDefaultformbool?No
StockTransferReasonWriteOffLedgerAccountOverrideformbool?No
StockTransferReasonWriteOffLedgerAccountRecIDformstringNo
StockTransferReasonWriteOffLedgerAccountNoformstringNo
StockTransferReasonWriteOffLedgerAccountDescriptionformstringNo
StockTransferReasonWriteOnLedgerAccountOverrideformbool?No
StockTransferReasonWriteOnLedgerAccountRecIDformstringNo
StockTransferReasonWriteOnLedgerAccountNoformstringNo
StockTransferReasonWriteOnLedgerAccountDescriptionformstringNo
StockTransferLine Parameters:
NameParameterData TypeRequiredDescription
TransferLineIDformstringNo
ItemNoformint?No
FromInventoryRecIDformstringNo
FromInventoryPartNoformstringNo
FromInventoryDescriptionformstringNo
FromInventoryDecimalPlacesformint?No
FromInventoryLastCostformdecimal?No
FromInventoryCubicformdecimal?No
FromInventoryWeightformdecimal?No
FromInventoryUnitsformstringNo
FromInventoryIsPhysicalformbool?No
FromInventoryIsSerialformbool?No
FromInventoryInventoryValueLedgerRecIDformstringNo
FromInventoryInventoryValueLedgerAccountNoformstringNo
FromInventoryInventoryValueLedgerDescriptionformstringNo
FromInventoryWriteOnLedgerAccountRecIDformstringNo
FromInventoryWriteOnLedgerAccountNoformstringNo
FromInventoryWriteOnLedgerAccountDescriptionformstringNo
FromInventoryWriteOffLedgerAccountRecIDformstringNo
FromInventoryWriteOffLedgerAccountNoformstringNo
FromInventoryWriteOffLedgerAccountDescriptionformstringNo
FromPartInventorySOHIDformstringNo
FromPartOriginalQuantityformdecimal?No
FromPartSerialNoformstringNo
FromPartCommentformstringNo
FromPartExpiryDateformDateTime?No
FromPartBinLocationformstringNo
ReferenceformstringNo
AvailableQuantityformdecimal?No
TransferQuantityformdecimal?No
StockTransferReasonRecIDformstringNo
StockTransferReasonNameformstringNo
StockTransferReasonIsDefaultformbool?No
StockTransferReasonWriteOffLedgerAccountOverrideformbool?No
StockTransferReasonWriteOffLedgerAccountRecIDformstringNo
StockTransferReasonWriteOffLedgerAccountNoformstringNo
StockTransferReasonWriteOffLedgerAccountDescriptionformstringNo
StockTransferReasonWriteOnLedgerAccountOverrideformbool?No
StockTransferReasonWriteOnLedgerAccountRecIDformstringNo
StockTransferReasonWriteOnLedgerAccountNoformstringNo
StockTransferReasonWriteOnLedgerAccountDescriptionformstringNo
ToInventoryRecIDformstringNo
ToInventoryPartNoformstringNo
ToInventoryDescriptionformstringNo
ToInventoryDecimalPlacesformint?No
ToInventoryLastCostformdecimal?No
ToInventoryCubicformdecimal?No
ToInventoryWeightformdecimal?No
ToInventoryUnitsformstringNo
ToInventoryIsPhysicalformbool?No
ToInventoryIsSerialformbool?No
ToInventoryInventoryValueLedgerRecIDformstringNo
ToInventoryInventoryValueLedgerAccountNoformstringNo
ToInventoryInventoryValueLedgerDescriptionformstringNo
ToInventoryWriteOnLedgerAccountRecIDformstringNo
ToInventoryWriteOnLedgerAccountNoformstringNo
ToInventoryWriteOnLedgerAccountDescriptionformstringNo
ToInventoryWriteOffLedgerAccountRecIDformstringNo
ToInventoryWriteOffLedgerAccountNoformstringNo
ToInventoryWriteOffLedgerAccountDescriptionformstringNo
ToPartInventorySOHIDformstringNo
ToPartSerialNoformstringNo
ToPartCommentformstringNo
ToPartExpiryDateformDateTime?No
ToPartBinLocationformstringNo
LastSavedByStaffIDformstringNo
LastSavedByStaffUserNameformstringNo
LastSavedByStaffTitleformstringNo
LastSavedByStaffFirstNameformstringNo
LastSavedByStaffSurnameformstringNo
LastSavedDateTimeformDateTime?No
CreatedByStaffIDformstringNo
CreatedByStaffUserNameformstringNo
CreatedByStaffTitleformstringNo
CreatedByStaffFirstNameformstringNo
CreatedByStaffSurnameformstringNo
CreatedDateTimeformDateTime?No
CustomFieldValuesformList<CustomFieldValue>No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
Note Parameters:
NameParameterData TypeRequiredDescription
NoteIDformstringNo
NoteTypeformNoteTypeNo
LineNoformint?No
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
NoteTextformstringNo
NoteType Parameters:
NameParameterData TypeRequiredDescription
NoteTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]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.

GET /StockTransfers/{TransferID} HTTP/1.1 
Host: localhost 
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,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA=="},"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"}