<back to all web services
StockTransitsSimple
Stock Module - Transaction
Stock Transit API
Requires Authentication
Required permission: | StockTransit-Transaction.GET |
The following routes are available for this service:GET | /StockTransits/simple | | |
---|
GET | /StockTransits/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
---|
GET | /StockTransits/simple/IsOutstanding/{IsOutstanding} | Get records by given a outstanding filter | Default will return all document |
---|
GET | /StockTransits/simple/StockTransit/{AcStockTransitMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
---|
GET | /StockTransits/simple/DocumentDate/{fromDocumentDate}/{toDocumentDate} | Get a record by given a Document Date | Date format yyyy-MM-dd |
---|
GET | /StockTransits/simple/EditDate/{fromEditDate}/{toEditDate} | Get a record by given a Edit Date | Date format yyyy-MM-dd |
---|
StockTransitsSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
Page | path | int? | No | |
AcStockTransitMID | path | string | No | |
IsOutstanding | path | string | No | |
fromDocumentDate | path | string | No | |
toDocumentDate | path | string | No | |
fromEditDate | path | string | No | |
toEditDate | path | string | No | |
StockTransitsSimpleResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
StockTransit | form | List<StockTransitSimple> | No | |
ResponseStatus | form | ResponseStatus | No | |
StockTransitSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
DocumentHeader | form | AcStockTransitMSimple | No | |
DocumentDetails | form | List<AcStockTransitDSimple> | No | |
AcStockTransitMSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransitMID | form | NVARCHAR(20) | Yes | Stock Adjustment Document Number |
DocumentDate | form | DATE | Yes | Document Date |
AcLocationIDFrom | form | NVARCHAR(20) | Yes | Location ID From |
AcLocationIDTo | form | NVARCHAR(20) | Yes | Location ID To |
AcLocationIDTransit | form | NVARCHAR(20) | Yes | Location ID Transit |
IsOutstanding | form | NVARCHAR(20) | Yes | IsOutstanding |
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 |
CreateBy | form | NVARCHAR(20) | Yes | Create By |
CreateDate | form | DATETIME | Yes | Create Date |
EditBy | form | NVARCHAR(20) | Yes | Edit By |
EditDate | form | DATETIME | Yes | Edit Date |
Stamp | form | INT | Yes | Record Stamp. Always 0 |
AcStockTransitDSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransitDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
AcStockTransitMID | form | NVARCHAR(20) | Yes | Stock Transit 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. Always positive input expected. |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
AcStockTransitDSerial | form | List | No | Stock Transit Serial List. |
AcStockTransitDSerialSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcStockTransitDSerialID | form | NVARCHAR(40) | Yes | Primary Key |
AcStockTransitMID | form | NVARCHAR(20) | Yes | Stock Transit 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 /StockTransits/simple HTTP/1.1
Host: snr2u.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StockTransitsSimpleResponse 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>
<StockTransit xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:StockTransitSimple>
<d2p1:DocumentDetails>
<d2p1:AcStockTransitDSimple>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockTransitDID>String</d2p1:AcStockTransitDID>
<d2p1:AcStockTransitDSerial>
<d2p1:AcStockTransitDSerialSimple>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockTransitDSerialID>String</d2p1:AcStockTransitDSerialID>
<d2p1:AcStockTransitMID>String</d2p1:AcStockTransitMID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:ItemNo>0</d2p1:ItemNo>
<d2p1:ItemQuantity>0</d2p1:ItemQuantity>
<d2p1:StockSerialNumber>String</d2p1:StockSerialNumber>
</d2p1:AcStockTransitDSerialSimple>
</d2p1:AcStockTransitDSerial>
<d2p1:AcStockTransitMID>String</d2p1:AcStockTransitMID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:ItemNo>0</d2p1:ItemNo>
<d2p1:ItemQuantity>0</d2p1:ItemQuantity>
<d2p1:ItemRemark1>String</d2p1:ItemRemark1>
</d2p1:AcStockTransitDSimple>
</d2p1:DocumentDetails>
<d2p1:DocumentHeader>
<d2p1:AcLocationIDFrom>String</d2p1:AcLocationIDFrom>
<d2p1:AcLocationIDTo>String</d2p1:AcLocationIDTo>
<d2p1:AcLocationIDTransit>String</d2p1:AcLocationIDTransit>
<d2p1:AcStockTransitMID>String</d2p1:AcStockTransitMID>
<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:IsOutstanding>String</d2p1:IsOutstanding>
<d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
<d2p1:Stamp>0</d2p1:Stamp>
</d2p1:DocumentHeader>
</d2p1:StockTransitSimple>
</StockTransit>
</StockTransitsSimpleResponse>