SmartAcc DynaMod Web API v2024.4 Build 0000

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 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.

**StockPriceBooks** Parameters:
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.

**StockPriceBooksResponse** Parameters:
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.

**StockPriceBook** Parameters:
Name	Parameter	Data Type	Required
PriceBook	form	AcStockPriceBookM	No
PriceBookStockList	form	List<AcStockPriceBookD>	No
PriceBookCustomerList	form	List<AcStockPriceBookCustomerAs>	No
PriceBookLocationList	form	List<AcStockPriceBookLocationAs>	No

**AcStockPriceBookM** Parameters:
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.

**AcStockPriceBookD** Parameters:
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.

**AcStockPriceBookCustomerAs** Parameters:
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.

**AcStockPriceBookLocationAs** Parameters:
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 .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 /StockPriceBooks HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StockPriceBooksResponse 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>
  <StockPriceBooks xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:StockPriceBook>
      <d2p1:PriceBook>
        <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
        <d2p1:AcStockPriceBookMDesc>String</d2p1:AcStockPriceBookMDesc>
        <d2p1:AcStockPriceBookMID>String</d2p1:AcStockPriceBookMID>
        <d2p1:CreateBy>String</d2p1:CreateBy>
        <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
        <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:IsActive>String</d2p1:IsActive>
        <d2p1:IsApplyToAllCustomer>String</d2p1:IsApplyToAllCustomer>
        <d2p1:IsApplyToAllLocation>String</d2p1:IsApplyToAllLocation>
        <d2p1:IsPriceExclusive>String</d2p1:IsPriceExclusive>
        <d2p1:Stamp>0</d2p1:Stamp>
      </d2p1:PriceBook>
      <d2p1:PriceBookCustomerList>
        <d2p1:AcStockPriceBookCustomerAs>
          <d2p1:AcCustomerID>String</d2p1:AcCustomerID>
          <d2p1:AcStockPriceBookCustomerAsID>String</d2p1:AcStockPriceBookCustomerAsID>
          <d2p1:AcStockPriceBookMID>String</d2p1:AcStockPriceBookMID>
          <d2p1:CreateBy>String</d2p1:CreateBy>
          <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
          <d2p1:EditBy>String</d2p1:EditBy>
          <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
          <d2p1:IsActive>String</d2p1:IsActive>
          <d2p1:Stamp>0</d2p1:Stamp>
        </d2p1:AcStockPriceBookCustomerAs>
      </d2p1:PriceBookCustomerList>
      <d2p1:PriceBookLocationList>
        <d2p1:AcStockPriceBookLocationAs>
          <d2p1:AcLocationID>String</d2p1:AcLocationID>
          <d2p1:AcStockPriceBookLocationAsID>String</d2p1:AcStockPriceBookLocationAsID>
          <d2p1:AcStockPriceBookMID>String</d2p1:AcStockPriceBookMID>
          <d2p1:CreateBy>String</d2p1:CreateBy>
          <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
          <d2p1:EditBy>String</d2p1:EditBy>
          <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
          <d2p1:IsActive>String</d2p1:IsActive>
          <d2p1:Stamp>0</d2p1:Stamp>
        </d2p1:AcStockPriceBookLocationAs>
      </d2p1:PriceBookLocationList>
      <d2p1:PriceBookStockList>
        <d2p1:AcStockPriceBookD>
          <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
          <d2p1:AcStockID>String</d2p1:AcStockID>
          <d2p1:AcStockPriceBookDID>String</d2p1:AcStockPriceBookDID>
          <d2p1:AcStockPriceBookMID>String</d2p1:AcStockPriceBookMID>
          <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
          <d2p1:CreateBy>String</d2p1:CreateBy>
          <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
          <d2p1:EditBy>String</d2p1:EditBy>
          <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
          <d2p1:ItemDisplaySeq>0</d2p1:ItemDisplaySeq>
          <d2p1:ItemNo>0</d2p1:ItemNo>
          <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
          <d2p1:PriceBookIsTaxInclusive>String</d2p1:PriceBookIsTaxInclusive>
          <d2p1:PriceBookPrice>0</d2p1:PriceBookPrice>
          <d2p1:Stamp>0</d2p1:Stamp>
        </d2p1:AcStockPriceBookD>
      </d2p1:PriceBookStockList>
    </d2p1:StockPriceBook>
  </StockPriceBooks>
  <TotalRecords>0</TotalRecords>
  <TotalRecordsInPage>0</TotalRecordsInPage>
</StockPriceBooksResponse>

SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

StockPriceBooks

Stock Price Book API

HTTP + XML