| Required permission: | StocksWithLocationBalances-Enquiry.GET |
| GET | /StocksWithLocationBalance/StockArticleNo/{StockArticleNo} | Get all stocks record's location balance quantity by given the corresponding Article Number | All colors and sizes of the stock would be presented if found for the given Article Number. Pass in list of AcLocationID (Optional). Pass in EditDate if only want to return for those info and quantity changed since the given date. |
|---|---|---|---|
| GET | /StocksWithLocationBalance/StockID/{AcStockID}/{AcStockUOMID} | Get specific stock record's location balance quantity | Stock's location balance quantity would be return if found. Pass in list of AcLocationID (Optional). Pass in EditDate if only want to return for those info and quantity changed since the given date. |
| GET | /StocksWithLocationBalance/EditDateRange/{SearchEditDateFrom}/{SearchEditDateTo} | Get records that since last changed for a given date range (SearchEditDateFrom, SearchEditDateTo). | Each page consinsts of 20 records. |
| GET | /StocksWithLocationBalance/{EditDate} | Get stock record's location balance quantity listing since last edit date. (Changed of Stock Maintenance info and Inventory Movement) | Stock's location balance quantity would be return if found. Pass in list of AcLocationID (Optional). Pass in EditDate (Compulsory) if only want to return for those info and quantity changed since the given date. Default return 20 records per page. Not recommended due to tentative very long query time needed. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StockArticleNo | path | string | No | |
| AcStockID | path | string | No | |
| AcStockUOMID | path | string | No | |
| AcLocationID | query | string[] | No | Location ID list |
| EditDate | path | DateTime | No | Edit Date. YYYY-MM-DD |
| Page | query | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| SearchEditDateFrom | path | DateTime? | No | Edit Date From (Search By Edit Date From). YYYY-MM-DD. |
| SearchEditDateTo | path | DateTime? | No | Edit Date To (Search By Edit Date To). YYYY-MM-DD. |
| IncludeSerialNumber | query | string | No | Return Stock Serial Number listing. Y / N |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stocks | form | List<pfapi70050GetStockWithLocationBalanceListing> | No | |
| SerialNumberDetails | form | List<AcStockSerialBalanceLocation> | 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 | string | No | Stock ID |
| AcStockUOMID | form | string | No | Stock UOM ID |
| StockDescription1 | form | string | No | Stock Description 1 |
| StockDescription2 | form | string | No | Stock Description 2 |
| StockBarcode | form | string | No | Barcode |
| StockArticleNo | form | string | No | Stock Article No |
| StockPrice1 | form | decimal | No | Stock Price 1 |
| StockPrice2 | form | decimal | No | Stock Price 2 |
| StockPrice3 | form | decimal | No | Stock Price 3 |
| StockPrice4 | form | decimal | No | Stock Price 4 |
| StockPrice5 | form | decimal | No | Stock Price 5 |
| AcStockBrandID | form | string | No | Stock Brand ID |
| AcStockGroupID | form | string | No | Stock Group ID |
| AcStockCategoryID | form | string | No | Stock Category ID |
| AcStockColorID | form | string | No | Stock Color ID |
| AcStockSizeID | form | string | No | Stock Size ID |
| AcStockUDGroup1ID | form | string | No | Stock User Define Group 1 ID |
| AcStockUDGroup2ID | form | string | No | Stock User Define Group 2 ID |
| AcStockUDGroup3ID | form | string | No | Stock User Define Group 3 ID |
| AcStockBrandDesc | form | string | No | Stock Brand Description |
| AcStockGroupDesc | form | string | No | Stock Group Description |
| AcStockCategoryDesc | form | string | No | Stock Category Description |
| AcStockColorDesc | form | string | No | Stock Color Description |
| AcStockSizeDesc | form | string | No | Stock Size Description |
| AcStockUDGroup1Desc | form | string | No | Stock User Define Group 1 Description |
| AcStockUDGroup2Desc | form | string | No | Stock User Define Group 2 Description |
| AcStockUDGroup3Desc | form | string | No | Stock User Define Group 3 Description |
| EditDate | form | DateTime | No | Stock Edit Date |
| StockBalanceQuantityCompany | form | decimal | No | Company Balance Quantity (All Locations) |
| AcLocationID | form | string | No | Location ID |
| AcLocationDesc | form | string | No | Location Description |
| StockBalanceQuantityLocation | form | decimal | No | Location Balance Quantity |
| SerialNumberDetails | form | List<AcStockSerialBalanceLocation> | No | Stock Serial Number Listing |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockID | form | string | No | |
| AcStockUOMID | form | string | No | |
| AcCompanyID | form | string | No | |
| StockSerialNumber | form | string | No | |
| AcLocationID | form | string | No | |
| QuantityIn | form | int | No | |
| QuantityOut | form | int | No | |
| BalanceQuantity | form | int | No | |
| CreateDate | form | DateTime | No | |
| EditDate | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /StocksWithLocationBalance/StockArticleNo/{StockArticleNo} HTTP/1.1
Host: snr2u.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Stocks:
[
{
AcStockID: String,
AcStockUOMID: String,
StockDescription1: String,
StockDescription2: String,
StockBarcode: String,
StockArticleNo: String,
StockPrice1: 0,
StockPrice2: 0,
StockPrice3: 0,
StockPrice4: 0,
StockPrice5: 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: 0001-01-01,
StockBalanceQuantityCompany: 0,
AcLocationID: String,
AcLocationDesc: String,
StockBalanceQuantityLocation: 0,
SerialNumberDetails:
[
{
AcStockID: String,
AcStockUOMID: String,
AcCompanyID: String,
StockSerialNumber: String,
AcLocationID: String,
QuantityIn: 0,
QuantityOut: 0,
BalanceQuantity: 0,
CreateDate: 0001-01-01,
EditDate: 0001-01-01
}
]
}
],
SerialNumberDetails:
[
{
AcStockID: String,
AcStockUOMID: String,
AcCompanyID: String,
StockSerialNumber: String,
AcLocationID: String,
QuantityIn: 0,
QuantityOut: 0,
BalanceQuantity: 0,
CreateDate: 0001-01-01,
EditDate: 0001-01-01
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
TotalRecords: 0,
TotalRecordsInPage: 0
}