| Required permission: | Stock-Setup.GET |
| GET | /Stocks/page/{Page} | Get records by given a page number | Each page consists of 20 records |
|---|---|---|---|
| GET | /Stocks/EditDate/{EditDate} | Get records that since last changed for a given date. | Each page consinsts of 20 records. |
| GET | /Stocks/StockBarcode/{StockBarcode} | Get record for given barcode | Please provide value for AcLocationID in order to get POS Price |
| GET | /Stocks/StockArticleNo/{StockArticleNo} | Get records by given Article Number | All colors and sizes of the stock would be presented if found for the given Article Number. |
| GET | /Stocks/EditDateRange/ | Get records that since last changed for a given date range (SearchEditDateFrom, SearchEditDateTo). | Each page consinsts of 20 records. |
| GET | /Stocks/StockIDList/ | Get records for given stock ID List | Multiple records could be returned for multi-uom stocks |
| GET | /Stocks/StockID/{AcStockID*} | Get records for given stock ID | Multiple records could be returned for multi-uom stocks |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| EditDate | path | DateTime? | No | Edit Date. YYYY-MM-DD. |
| AcStockID | path | string | No | Get product info by providing Stock ID |
| AcLocationID | query | string | No | Provide Location ID to get it's StockPosPrice |
| StockBarcode | path | string | No | Get product info by providing Barcode |
| AcStockIDList | query | string[] | No | Get product info by providing Stock ID list |
| IsReturnImage | query | bool | No | Indicate whether should return image data (if any). true;false |
| SearchEditDateFrom | query | DateTime? | No | Edit Date From (Search By Edit Date From). YYYY-MM-DD. |
| SearchEditDateTo | query | DateTime? | No | Edit Date To (Search By Edit Date To). YYYY-MM-DD. |
| StockArticleNo | path | string | No | Get product info by providing Stock Article Number |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stocks | form | List<Acvw_AcStockCompany> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockID | form | NVARCHAR(40) | No | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | No | UOM ID |
| StockDescription1 | form | NVARCHAR(100) | No | Stock Description 1 |
| StockDescription2 | form | NVARCHAR(100) | No | Stock Description 2 |
| StockBalanceQuantity | form | NVARCHAR(100) | No | Stock Balance Quantity (Company Level, Converted Multi-Uom if Applicable) |
| StockBarcode | form | NVARCHAR(40) | No | Stock Barcode |
| StockArticleNo | form | NVARCHAR(20) | No | Article Number |
| StockPrice1 | form | NUMERIC(18,4) | No | Price 1 |
| StockPrice2 | form | NUMERIC(18,4) | No | Price 2 |
| StockPrice3 | form | NUMERIC(18,4) | No | Price 3 |
| StockPrice4 | form | NUMERIC(18,4) | No | Price 4 |
| StockPrice5 | form | NUMERIC(18,4) | No | Price 5 |
| QuantityMinimumLevel | form | NUMERIC(18,4) | No | Quantity Minimum Level |
| AcStockBrandID | form | NVARCHAR(20) | No | Stock Brand ID |
| AcStockGroupID | form | NVARCHAR(20) | No | Stock Group ID |
| AcStockCategoryID | form | NVARCHAR(20) | No | Stock Category ID |
| AcStockColorID | form | NVARCHAR(20) | No | Stock Color ID |
| AcStockSizeID | form | NVARCHAR(20) | No | Stock Size ID |
| AcStockUDGroup1ID | form | NVARCHAR(20) | No | Stock User Define Group 1 ID |
| AcStockUDGroup2ID | form | NVARCHAR(20) | No | Stock User Define Group 2 ID |
| AcStockUDGroup3ID | form | NVARCHAR(20) | No | Stock User Define Group 3 ID |
| AcStockBrandDesc | form | NVARCHAR(100) | No | Stock Brand Description |
| AcStockGroupDesc | form | NVARCHAR(100) | No | Stock Group Description |
| AcStockCategoryDesc | form | NVARCHAR(100) | No | Stock Category Description |
| AcStockColorDesc | form | NVARCHAR(100) | No | Stock Color Description |
| AcStockSizeDesc | form | NVARCHAR(100) | No | Stock Size Description |
| AcStockUDGroup1Desc | form | NVARCHAR(100) | No | Stock User Define Group 1 Description |
| AcStockUDGroup2Desc | form | NVARCHAR(100) | No | Stock User Define Group 2 Description |
| AcStockUDGroup3Desc | form | NVARCHAR(100) | No | Stock User Define Group 3 Description |
| EditDate | form | DATETIME | No | Record Edit DateTime |
| AccountNoSales | form | NVARCHAR(20) | No | Account Number (Sales) |
| AccountNoSalesDiscount | form | NVARCHAR(20) | No | Account Number (Sales Discount) |
| AccountNoSalesReturn | form | NVARCHAR(20) | No | Account Number (Sales Return) |
| AccountNoPurchase | form | NVARCHAR(20) | No | Account Number (Purchase) |
| AccountNoPurchaseDiscount | form | NVARCHAR(20) | No | Account Number (Purchase Discount) |
| AccountNoPurchaseReturn | form | NVARCHAR(20) | No | Account Number (Purchase Return) |
| StockPosPrice | form | NUMERIC(18,4) | No | POS Price (Value will presented if AcLocationID in parameter provided). Else 0.00 |
| StockDimensionHeight | form | NUMERIC(18,6) | No | Dimension - Height |
| StockDimensionWidth | form | NUMERIC(18,6) | No | Dimension - Width |
| StockDimensionLength | form | NUMERIC(18,6) | No | Dimension - Length |
| AcStockUOMIDDimension | form | NVARCHAR(20) | No | Dimension - UOM ID |
| StockWeight | form | NUMERIC(18,6) | No | Stock Weight |
| AcStockUOMIDWeight | form | NVARCHAR(20) | No | Stock Weight - UOM ID |
| AcStockUOMIDWeighingType | form | NVARCHAR(20) | No | Weighing Type - UOM ID |
| AcStockTypeID | form | NVARCHAR(20) | No | Stock Type ID. STOCK; SERVICE; NON-STOCK |
| StockISBN | form | NVARCHAR(100) | No | Stock ISBN |
| StockIsActive | form | NVARCHAR(1) | No | Is Active? Y: Active; N: Inactive |
| StockExtraRemark1 | form | NVARCHAR(100) | No | Stock Extra Remark 1 |
| StockExtraRemark2 | form | NVARCHAR(100) | No | Stock Extra Remark 2 |
| StockExtraRemark3 | form | NVARCHAR(100) | No | Stock Extra Remark 3 |
| StockExtraRemark4 | form | NVARCHAR(100) | No | Stock Extra Remark 4 |
| ImageDisplayBase64 | form | VARCHAR(MAX) | No | Stock Display Image in Base64 Encoding. |
| IsStockNotesAddToSales | form | NVARCHAR(1) | No | Is Stock Note add to sales? (Y/N) |
| StockNotes | form | NVARCHAR(MAX) | No | Stock Notes. Also known as Sales Notes in Dynamod Stock Maintenance. |
| IsStockNotesAddToPurchase | form | NVARCHAR(1) | No | Is Stock Note Purchase add to purchase? (Y/N) |
| StockNotesPurchase | form | NVARCHAR(MAX) | No | Stock Notes purchases. |
| StockCost | form | NUMERIC(18,4) | No | Stock Cost. |
| StockIsSerialNumber | form | NVARCHAR(1) | No | Is Serial Number Stock (Y/N) |
| AcEInvoiceItemClassificationID | form | NVARCHAR(40) | Yes | E-Invoice Item Classification ID |
| AcEInvoiceItemTaxTypeID | form | NVARCHAR(40) | Yes | E-Invoice Item Tax Type ID |
| AcTaxIDSupplySST | form | NVARCHAR(20) | Yes | Tax Code (SST) (Supply) |
| AcTaxIDPurchaseSST | form | NVARCHAR(20) | Yes | Tax Code (SST) (Purchase) |
| AcTaxIDSupply | form | NVARCHAR(20) | Yes | Tax Code (GST) (Supply) |
| AcTaxIDPurchase | form | NVARCHAR(20) | Yes | Tax Code (GST) (Purchase) |
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 /Stocks/page/{Page} HTTP/1.1
Host: snr2u.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Stocks":[{"AcStockID":"String","AcStockUOMID":"String","StockDescription1":"String","StockDescription2":"String","StockBalanceQuantity":0,"StockBarcode":"String","StockArticleNo":"String","StockPrice1":0,"StockPrice2":0,"StockPrice3":0,"StockPrice4":0,"StockPrice5":0,"QuantityMinimumLevel":0,"AcStockBrandID":"String","AcStockGroupID":"String","AcStockCategoryID":"String","AcStockColorID":"String","AcStockSizeID":"String","AcStockUDGroup1ID":"String","AcStockUDGroup2ID":"String","AcStockUDGroup3ID":"String","AcStockBrandDesc":"String","AcStockGroupDesc":"String","AcStockCategoryDesc":"String","AcStockColorDesc":"String","AcStockSizeDesc":"String","AcStockUDGroup1Desc":"String","AcStockUDGroup2Desc":"String","AcStockUDGroup3Desc":"String","EditDate":"\/Date(-62135596800000-0000)\/","AccountNoSales":"String","AccountNoSalesDiscount":"String","AccountNoSalesReturn":"String","AccountNoPurchase":"String","AccountNoPurchaseDiscount":"String","AccountNoPurchaseReturn":"String","StockPosPrice":0,"StockDimensionHeight":0,"StockDimensionWidth":0,"StockDimensionLength":0,"AcStockUOMIDDimension":"String","StockWeight":0,"AcStockUOMIDWeight":"String","AcStockUOMIDWeighingType":"String","AcStockTypeID":"String","StockISBN":"String","StockIsActive":"String","StockExtraRemark1":"String","StockExtraRemark2":"String","StockExtraRemark3":"String","StockExtraRemark4":"String","ImageDisplayBase64":"String","IsStockNotesAddToSales":"String","StockNotes":"String","IsStockNotesAddToPurchase":"String","StockNotesPurchase":"String","StockCost":0,"StockIsSerialNumber":"String","AcEInvoiceItemClassificationID":"String","AcEInvoiceItemTaxTypeID":"String","AcTaxIDSupplySST":"String","AcTaxIDPurchaseSST":"String","AcTaxIDSupply":"String","AcTaxIDPurchase":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"TotalRecords":0,"TotalRecordsInPage":0}