SmartAcc DynaMod Web API v2024.4 Build 0000

StocksWithLocationBalance

Stock Module - Enquiry

Stocks With Location Balance Quatity API

**Requires Authentication**
Required permission:	StocksWithLocationBalances-Enquiry.GET

The following routes are available for this service:
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.

**StocksWithLocationBalance** Parameters:
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

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

**pfapi70050GetStockWithLocationBalanceListing** Parameters:
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

**AcStockSerialBalanceLocation** Parameters:
Name	Parameter	Data Type	Required
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 .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 /StocksWithLocationBalance/StockArticleNo/{StockArticleNo} HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

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

<StocksWithLocationBalanceResponse 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>
  <SerialNumberDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:AcStockSerialBalanceLocation>
      <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
      <d2p1:AcLocationID>String</d2p1:AcLocationID>
      <d2p1:AcStockID>String</d2p1:AcStockID>
      <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
      <d2p1:BalanceQuantity>0</d2p1:BalanceQuantity>
      <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
      <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
      <d2p1:QuantityIn>0</d2p1:QuantityIn>
      <d2p1:QuantityOut>0</d2p1:QuantityOut>
      <d2p1:StockSerialNumber>String</d2p1:StockSerialNumber>
    </d2p1:AcStockSerialBalanceLocation>
  </SerialNumberDetails>
  <Stocks xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:pfapi70050GetStockWithLocationBalanceListing>
      <d2p1:AcLocationDesc>String</d2p1:AcLocationDesc>
      <d2p1:AcLocationID>String</d2p1:AcLocationID>
      <d2p1:AcStockBrandDesc>String</d2p1:AcStockBrandDesc>
      <d2p1:AcStockBrandID>String</d2p1:AcStockBrandID>
      <d2p1:AcStockCategoryDesc>String</d2p1:AcStockCategoryDesc>
      <d2p1:AcStockCategoryID>String</d2p1:AcStockCategoryID>
      <d2p1:AcStockColorDesc>String</d2p1:AcStockColorDesc>
      <d2p1:AcStockColorID>String</d2p1:AcStockColorID>
      <d2p1:AcStockGroupDesc>String</d2p1:AcStockGroupDesc>
      <d2p1:AcStockGroupID>String</d2p1:AcStockGroupID>
      <d2p1:AcStockID>String</d2p1:AcStockID>
      <d2p1:AcStockSizeDesc>String</d2p1:AcStockSizeDesc>
      <d2p1:AcStockSizeID>String</d2p1:AcStockSizeID>
      <d2p1:AcStockUDGroup1Desc>String</d2p1:AcStockUDGroup1Desc>
      <d2p1:AcStockUDGroup1ID>String</d2p1:AcStockUDGroup1ID>
      <d2p1:AcStockUDGroup2Desc>String</d2p1:AcStockUDGroup2Desc>
      <d2p1:AcStockUDGroup2ID>String</d2p1:AcStockUDGroup2ID>
      <d2p1:AcStockUDGroup3Desc>String</d2p1:AcStockUDGroup3Desc>
      <d2p1:AcStockUDGroup3ID>String</d2p1:AcStockUDGroup3ID>
      <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
      <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
      <d2p1:SerialNumberDetails>
        <d2p1:AcStockSerialBalanceLocation>
          <d2p1:AcCompanyID>String</d2p1:AcCompanyID>
          <d2p1:AcLocationID>String</d2p1:AcLocationID>
          <d2p1:AcStockID>String</d2p1:AcStockID>
          <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
          <d2p1:BalanceQuantity>0</d2p1:BalanceQuantity>
          <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
          <d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
          <d2p1:QuantityIn>0</d2p1:QuantityIn>
          <d2p1:QuantityOut>0</d2p1:QuantityOut>
          <d2p1:StockSerialNumber>String</d2p1:StockSerialNumber>
        </d2p1:AcStockSerialBalanceLocation>
      </d2p1:SerialNumberDetails>
      <d2p1:StockArticleNo>String</d2p1:StockArticleNo>
      <d2p1:StockBalanceQuantityCompany>0</d2p1:StockBalanceQuantityCompany>
      <d2p1:StockBalanceQuantityLocation>0</d2p1:StockBalanceQuantityLocation>
      <d2p1:StockBarcode>String</d2p1:StockBarcode>
      <d2p1:StockDescription1>String</d2p1:StockDescription1>
      <d2p1:StockDescription2>String</d2p1:StockDescription2>
      <d2p1:StockPrice1>0</d2p1:StockPrice1>
      <d2p1:StockPrice2>0</d2p1:StockPrice2>
      <d2p1:StockPrice3>0</d2p1:StockPrice3>
      <d2p1:StockPrice4>0</d2p1:StockPrice4>
      <d2p1:StockPrice5>0</d2p1:StockPrice5>
    </d2p1:pfapi70050GetStockWithLocationBalanceListing>
  </Stocks>
  <TotalRecords>0</TotalRecords>
  <TotalRecordsInPage>0</TotalRecordsInPage>
</StocksWithLocationBalanceResponse>

SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

StocksWithLocationBalance

Stocks With Location Balance Quatity API

HTTP + XML