<back to all web services
StockTransfersSimple
Stock Module - Transaction
Stock Transfer API
Requires Authentication
Required permission: | StockTransfer-Transaction.GET |
The following routes are available for this service:GET | /StockTransfers/simple | | |
---|
GET | /StockTransfers/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
---|
GET | /StockTransfers/simple/StockTransfer/{AcStockTransferMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
---|
GET | /StockTransfers/simple/DocumentDate/{fromDocumentDate}/{toDocumentDate} | Get a record by given a Document Date | Date format yyyy-MM-dd |
---|
GET | /StockTransfers/simple/EditDate/{fromEditDate}/{toEditDate} | Get a record by given a Edit Date | Date format yyyy-MM-dd |
---|
StockTransfersSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
Page | path | int? | No | |
AcStockTransferMID | path | string | No | |
fromDocumentDate | path | string | No | |
toDocumentDate | path | string | No | |
fromEditDate | path | string | No | |
toEditDate | path | string | No | |
StockTransfersSimpleResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
StockTransfers | form | List<StockTransferSimple> | No | |
ResponseStatus | form | ResponseStatus | No | |
StockTransferSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
DocumentHeader | form | AcStockTransferMSimple | No | |
DocumentDetails | form | List<AcStockTransferDSimple> | No | |
AcStockTransferMSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransferMID | form | NVARCHAR(20) | Yes | Stock Transfer Document Number |
AcLocationIDFrom | form | NVARCHAR(20) | Yes | Location ID From |
AcLocationIDTo | form | NVARCHAR(20) | Yes | Location ID To |
DocumentDate | form | DATE | Yes | Document Date |
RefDocumentNo | form | NVARCHAR(20) | No | Reference Number |
DocumentRemark | form | NVARCHAR(100) | No | Document Remark |
ExtraRemark1 | form | NVARCHAR(100) | No | Extra Remark 1 |
ExtraRemark2 | form | NVARCHAR(100) | No | Extra Remark 2 |
ExtraRemark3 | form | NVARCHAR(100) | No | Extra Remark 3 |
ExtraRemark4 | form | NVARCHAR(100) | No | Extra Remark 4 |
AcVehicleID | form | NVARCHAR(20) | Yes | Vehicle ID |
AcDriverID | form | NVARCHAR(20) | Yes | Driver ID |
CreateBy | form | NVARCHAR(20) | Yes | Create By |
CreateDate | form | DATETIME | Yes | Create Date |
EditBy | form | NVARCHAR(20) | Yes | Edit By |
EditDate | form | DATETIME | Yes | Create Date |
Stamp | form | INT | Yes | Record Stamp. Always 0 |
AcStockTransferDSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransferDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
AcStockTransferMID | form | NVARCHAR(20) | Yes | Stock Transfer Document Number |
ItemNo | form | INT | Yes | Item Number |
AcStockID | form | NVARCHAR(40) | Yes | Stock ID |
AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
MatchIsActive | form | NVARCHAR(1) | Yes | Match Is Active |
MatchType | form | NVARCHAR(20) | Yes | Match Type |
MatchDocumentNo | form | NVARCHAR(20) | Yes | Match Document No |
MatchItemNo | form | INT | Yes | Match Item No |
AcStockTransferDSerial | form | List | No | Stock Transfer Serial List. |
AcStockTransferDSerialSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransferMID | form | NVARCHAR(20) | Yes | Stock Transfer Number |
ItemNo | form | INTEGER | Yes | Item Number (Referred to AcSupInvoiceD.ItemNo) |
AcStockID | form | NVARCHAR(20) | No | Stock ID |
AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID |
StockSerialNumber | form | NVARCHAR(40) | Yes | Stock Serial Number |
ItemQuantity | form | INT | No | Item Quantity. Always 1. |
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 /StockTransfers/simple HTTP/1.1
Host: snr2u.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StockTransfersSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<StockTransfers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:StockTransferSimple>
<d2p1:DocumentDetails>
<d2p1:AcStockTransferDSimple>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockTransferDID>String</d2p1:AcStockTransferDID>
<d2p1:AcStockTransferDSerial>
<d2p1:AcStockTransferDSerialSimple>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockTransferMID>String</d2p1:AcStockTransferMID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:ItemNo>0</d2p1:ItemNo>
<d2p1:ItemQuantity>0</d2p1:ItemQuantity>
<d2p1:StockSerialNumber>String</d2p1:StockSerialNumber>
</d2p1:AcStockTransferDSerialSimple>
</d2p1:AcStockTransferDSerial>
<d2p1:AcStockTransferMID>String</d2p1:AcStockTransferMID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:ItemNo>0</d2p1:ItemNo>
<d2p1:ItemQuantity>0</d2p1:ItemQuantity>
<d2p1:ItemRemark1>String</d2p1:ItemRemark1>
<d2p1:MatchDocumentNo>String</d2p1:MatchDocumentNo>
<d2p1:MatchIsActive>String</d2p1:MatchIsActive>
<d2p1:MatchItemNo>0</d2p1:MatchItemNo>
<d2p1:MatchType>String</d2p1:MatchType>
</d2p1:AcStockTransferDSimple>
</d2p1:DocumentDetails>
<d2p1:DocumentHeader>
<d2p1:AcDriverID>String</d2p1:AcDriverID>
<d2p1:AcLocationIDFrom>String</d2p1:AcLocationIDFrom>
<d2p1:AcLocationIDTo>String</d2p1:AcLocationIDTo>
<d2p1:AcStockTransferMID>String</d2p1:AcStockTransferMID>
<d2p1:AcVehicleID>String</d2p1:AcVehicleID>
<d2p1:CreateBy>String</d2p1:CreateBy>
<d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
<d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
<d2p1:DocumentRemark>String</d2p1:DocumentRemark>
<d2p1:EditBy>String</d2p1:EditBy>
<d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
<d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
<d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
<d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
<d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
<d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
<d2p1:Stamp>0</d2p1:Stamp>
</d2p1:DocumentHeader>
</d2p1:StockTransferSimple>
</StockTransfers>
</StockTransfersSimpleResponse>