SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

StockPriceBooks

Stock Module - Enquiry

Stock Price Book API

Requires Authentication
Required permission:StockPriceBookList-Enquiry.GET
The following routes are available for this service:
GET/StockPriceBooks
GET/StockPriceBooks/page/{Page}Get records by given a page numberEach 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.
StockPriceBooks Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
AcStockPriceBookMIDpathstringNoStock Price Book ID
AcStockIDquerystringNoStock ID. Filter in a given Stock Price Book ID
EditDatepathDateTime?NoEdit Date. YYYY-MM-DD.
StockPriceBooksResponse Parameters:
NameParameterData TypeRequiredDescription
StockPriceBooksformList<StockPriceBook>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
StockPriceBook Parameters:
NameParameterData TypeRequiredDescription
PriceBookformAcStockPriceBookMNo
PriceBookStockListformList<AcStockPriceBookD>No
PriceBookCustomerListformList<AcStockPriceBookCustomerAs>No
PriceBookLocationListformList<AcStockPriceBookLocationAs>No
AcStockPriceBookM Parameters:
NameParameterData TypeRequiredDescription
AcStockPriceBookMIDformNVARCHAR(20)YesPrice Book ID
AcStockPriceBookMDescformNVARCHAR(20)YesPrice Book Description
AcCompanyIDformNVARCHAR(20)YesCompany ID
IsApplyToAllCustomerformNVARCHAR(1)YesVisibile To All Customer Price Input. (Y/N)
IsApplyToAllLocationformNVARCHAR(1)YesApply To All POS Location. (Y/N)
IsPriceExclusiveformNVARCHAR(1)YesExclude From POS Promotion. (Y/N)
IsActiveformNVARCHAR(1)YesIs Price Book Active? (Y/N)
ExtraRemark1formNVARCHAR(100)NoExtra Remark 1
ExtraRemark2formNVARCHAR(100)NoExtra Remark 2
ExtraRemark3formNVARCHAR(100)NoExtra Remark 3
ExtraRemark4formNVARCHAR(100)NoExtra Remark 4
CreateByformNVARCHAR(20)YesCreate By
CreateDateformDATETIMEYesCreate Date
EditByformNVARCHAR(20)YesEdit By
EditDateformDATETIMEYesEdit Date
StampformINTYesRecord Stamp.
AcStockPriceBookD Parameters:
NameParameterData TypeRequiredDescription
AcStockPriceBookDIDformNVARCHAR(40)YesRecord ID
AcStockPriceBookMIDformNVARCHAR(20)YesPrice Book ID
ItemNoformINTEGERYesItem Number
ItemDisplaySeqformNUMERIC(18,2)YesItem Display Sequence
AcCompanyIDformNVARCHAR(20)YesCompany ID
AcStockIDformNVARCHAR(20)YesStock ID
AcStockUOMIDformNVARCHAR(20)YesStock UOM ID
ItemRemark1formNVARCHAR(MAX)YesItem Remark 1
PriceBookPriceformNUMERIC(18,2)YesPrice Book Price
PriceBookIsTaxInclusiveformNVARCHAR(1)YesPrice Book Is Tax Inclusive? (Y/N)
CreateByformNVARCHAR(20)YesCreate By
CreateDateformDATETIMEYesCreate Date
EditByformNVARCHAR(20)YesEdit By
EditDateformDATETIMEYesEdit Date
StampformINTYesRecord Stamp.
AcStockPriceBookCustomerAs Parameters:
NameParameterData TypeRequiredDescription
AcStockPriceBookCustomerAsIDformNVARCHAR(40)YesRecord ID
AcStockPriceBookMIDformNVARCHAR(20)YesPrice Book ID
AcCustomerIDformNVARCHAR(20)YesCustomer ID
IsActiveformNVARCHAR(1)YesIs Active? (Y/N)
CreateByformNVARCHAR(20)YesCreate By
CreateDateformDATETIMEYesCreate Date
EditByformNVARCHAR(20)YesEdit By
EditDateformDATETIMEYesEdit Date
StampformINTYesRecord Stamp.
AcStockPriceBookLocationAs Parameters:
NameParameterData TypeRequiredDescription
AcStockPriceBookLocationAsIDformNVARCHAR(40)YesRecord ID
AcStockPriceBookMIDformNVARCHAR(20)YesPrice Book ID
AcLocationIDformNVARCHAR(20)YesLocation ID
IsActiveformNVARCHAR(1)YesIs Active? (Y/N)
CreateByformNVARCHAR(20)YesCreate By
CreateDateformDATETIMEYesCreate Date
EditByformNVARCHAR(20)YesEdit By
EditDateformDATETIMEYesEdit Date
StampformINTYesRecord Stamp.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}