| Required permission: | StockPriceBookList-Enquiry.GET |
| GET | /StockPriceBooks | ||
|---|---|---|---|
| GET | /StockPriceBooks/page/{Page} | Get records by given a page number | Each page consists of 20 records |
| GET | /StockPriceBooks/AcStockPriceBookMID/{AcStockPriceBookMID} | Get record for given Stock Price Book ID | |
| GET | /StockPriceBooks/EditDate/{EditDate} | Get records that since last changed for a given date. | Each page consinsts of 20 records. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| AcStockPriceBookMID | path | string | No | Stock Price Book ID |
| AcStockID | query | string | No | Stock ID. Filter in a given Stock Price Book ID |
| EditDate | path | DateTime? | No | Edit Date. YYYY-MM-DD. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StockPriceBooks | form | List<StockPriceBook> | 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 |
|---|---|---|---|---|
| PriceBook | form | AcStockPriceBookM | No | |
| PriceBookStockList | form | List<AcStockPriceBookD> | No | |
| PriceBookCustomerList | form | List<AcStockPriceBookCustomerAs> | No | |
| PriceBookLocationList | form | List<AcStockPriceBookLocationAs> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockPriceBookMID | form | NVARCHAR(20) | Yes | Price Book ID |
| AcStockPriceBookMDesc | form | NVARCHAR(20) | Yes | Price Book Description |
| AcCompanyID | form | NVARCHAR(20) | Yes | Company ID |
| IsApplyToAllCustomer | form | NVARCHAR(1) | Yes | Visibile To All Customer Price Input. (Y/N) |
| IsApplyToAllLocation | form | NVARCHAR(1) | Yes | Apply To All POS Location. (Y/N) |
| IsPriceExclusive | form | NVARCHAR(1) | Yes | Exclude From POS Promotion. (Y/N) |
| IsActive | form | NVARCHAR(1) | Yes | Is Price Book Active? (Y/N) |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockPriceBookDID | form | NVARCHAR(40) | Yes | Record ID |
| AcStockPriceBookMID | form | NVARCHAR(20) | Yes | Price Book ID |
| ItemNo | form | INTEGER | Yes | Item Number |
| ItemDisplaySeq | form | NUMERIC(18,2) | Yes | Item Display Sequence |
| AcCompanyID | form | NVARCHAR(20) | Yes | Company ID |
| AcStockID | form | NVARCHAR(20) | Yes | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
| ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
| PriceBookPrice | form | NUMERIC(18,2) | Yes | Price Book Price |
| PriceBookIsTaxInclusive | form | NVARCHAR(1) | Yes | Price Book Is Tax Inclusive? (Y/N) |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockPriceBookCustomerAsID | form | NVARCHAR(40) | Yes | Record ID |
| AcStockPriceBookMID | form | NVARCHAR(20) | Yes | Price Book ID |
| AcCustomerID | form | NVARCHAR(20) | Yes | Customer ID |
| IsActive | form | NVARCHAR(1) | Yes | Is Active? (Y/N) |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockPriceBookLocationAsID | form | NVARCHAR(40) | Yes | Record ID |
| AcStockPriceBookMID | form | NVARCHAR(20) | Yes | Price Book ID |
| AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
| IsActive | form | NVARCHAR(1) | Yes | Is Active? (Y/N) |
| 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. |
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 /StockPriceBooks HTTP/1.1 Host: snr2u.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"StockPriceBooks":[{"PriceBook":{"AcStockPriceBookMID":"String","AcStockPriceBookMDesc":"String","AcCompanyID":"String","IsApplyToAllCustomer":"String","IsApplyToAllLocation":"String","IsPriceExclusive":"String","IsActive":"String","ExtraRemark1":"String","ExtraRemark2":"String","ExtraRemark3":"String","ExtraRemark4":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":0},"PriceBookStockList":[{"AcStockPriceBookDID":"String","AcStockPriceBookMID":"String","ItemNo":0,"ItemDisplaySeq":0,"AcCompanyID":"String","AcStockID":"String","AcStockUOMID":"String","ItemRemark1":"String","PriceBookPrice":0,"PriceBookIsTaxInclusive":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":0}],"PriceBookCustomerList":[{"AcStockPriceBookCustomerAsID":"String","AcStockPriceBookMID":"String","AcCustomerID":"String","IsActive":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":0}],"PriceBookLocationList":[{"AcStockPriceBookLocationAsID":"String","AcStockPriceBookMID":"String","AcLocationID":"String","IsActive":"String","CreateBy":"String","CreateDate":"\/Date(-62135596800000-0000)\/","EditBy":"String","EditDate":"\/Date(-62135596800000-0000)\/","Stamp":0}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"TotalRecords":0,"TotalRecordsInPage":0}