Logistics APIs
This report shows stock takings (STT) where counted stock quantity deviates from expected quantity. If a stock correction (SAW) has been created to adjust stock quantity, this will also show.
Report name | Stock takings (STT) where counting deviates from expected quantity (including stock correction (SAW)) |
Report identifier | 106006 |
HTTP method | GET |
URI | https://api.rambase.net/system/reports/106006/result-set |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 5460, version 11 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
$pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
$filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
$orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
$inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
CompletedAt Date | Date and time of completion. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CountedById Integer | Employee who perform the stock taking. |
CountedStockQuantity Decimal | The counted/actual quantity found when counting the goods reception item for the stock location. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
CreatedById Integer | Employee who created the stock taking. |
ExpectedStockQuantity Decimal | Expected quantity to be found when counting the goods reception item in stock location. Note that this field will not be set before you have actually started counting. Also note that when the stock location count is created, this expected quantity is set equal to the remaining quantity of the stock location assignment. |
GoodsReceptionCountId Integer | Stock taking identifier. |
GoodsReceptionId Integer | Goods reception identifier. |
GoodsReceptionItemId Integer | Item-/line-number of the goods reception. |
Name String | Name of stock taking. |
ProductName String | Name of the product. |
Status Integer | Status of stock taking. |
StockLocationLabel String | Name of current- and parent stock locations, including seperator for location. |
StockTakingId Integer | Stock taking identifier. |
Type String | Type of stock taking. |
Read more about filters and sorting on how to use sortable parameters
CompletedAt Date | Date and time of completion |
CountedById Integer | Employee who perform the stock taking |
CountedStockQuantity Decimal | The counted/actual quantity found when counting the goods reception item for the stock location |
CreatedAt Datetime | Date and time of creation |
CreatedById Integer | Employee who created the stock taking |
ExpectedStockQuantity Decimal | Expected quantity to be found when counting the goods reception item in stock location. Note that this field will not be set before you have actually started counting. Also note that when the stock location count is created, this expected quantity is set equal to the remaining quantity of the stock location assignment. |
GoodsReceptionCountId Integer | Stock taking identifier |
GoodsReceptionId Integer | Goods reception identifier |
GoodsReceptionItemId Integer | Item-/line-number of the goods reception |
Name String | Name of stock taking |
ProductName String | Name of the product |
Status Integer | Status of stock taking |
StockLocationLabel String | Name of current- and parent stock locations, including seperator for location |
StockTakingId Integer | Stock taking identifier |
Type String | Type of stock taking |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
GoodsReceptionCount
Reference to the goods reception count
>GoodsReceptionCountId
Goods reception count identifier
>{Integer}</GoodsReceptionCountId>StockTaking
Stock taking reference
>StockTakingId
Stock taking identifier
>{Integer}</StockTakingId>StockTakingLink
Stock taking reference
>{String}</StockTakingLink>GoodsReceptionCountLink
Stock taking item reference
>{String}</GoodsReceptionCountLink>Name
Name of stock taking
>{String}</Name>GoodsReceptionItem
Goods reception item reference
>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>GoodsReception
Goods reception reference
>GoodsReceptionId
Goods reception identifier
>{Integer}</GoodsReceptionId>GoodsReceptionLink
Goods reception reference
>{String}</GoodsReceptionLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>CreatedAt
Date and time of creation
>{Date}</CreatedAt>CountedBy
Employee who perform the stock taking
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ExpectedStockQuantity
Expected stock quantity for this count location (combination of goods reception count and stock location). This quantity might change after counting is completed. Note that this quantity is always the same as the remaining quantity of the stock location assignment.
>{Decimal}</ExpectedStockQuantity>CountedStockQuantity
The counted/actual quantity found when counting the goods reception item for the stock location
>{Decimal}</CountedStockQuantity>StockCorrectionList
Stock correction identifier
>{String}</StockCorrectionList>AdjustedQuantity
The quantity the stock has been (or will be) corrected by. Note that a negative quantity means that the stock will be adjusted up.
>{Decimal}</AdjustedQuantity>AdjustedAmount
Value of stock correction in local currency
>{Decimal}</AdjustedAmount>StockLocation
Stock location reference
>Label
Name of current- and parent stock locations, including seperator for location
>{String}</Label>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>GoodsReceptionCount
Reference to the goods reception count
": {GoodsReceptionCountId
Goods reception count identifier
": "{Integer}",StockTaking
Stock taking reference
": {StockTakingId
Stock taking identifier
": "{Integer}",StockTakingLink
Stock taking reference
": "{String}"GoodsReceptionCountLink
Stock taking item reference
": "{String}"Name
Name of stock taking
": "{String}",Type
Type of stock taking
Possible domain values can be found here
": "{String}",GoodsReceptionItem
Goods reception item reference
": {GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",GoodsReception
Goods reception reference
": {GoodsReceptionId
Goods reception identifier
": "{Integer}",GoodsReceptionLink
Goods reception reference
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"CreatedAt
Date and time of creation
": "{Date}",CountedBy
Employee who perform the stock taking
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"ExpectedStockQuantity
Expected stock quantity for this count location (combination of goods reception count and stock location). This quantity might change after counting is completed. Note that this quantity is always the same as the remaining quantity of the stock location assignment.
": "{Decimal}",CountedStockQuantity
The counted/actual quantity found when counting the goods reception item for the stock location
": "{Decimal}",StockCorrectionList
Stock correction identifier
": "{String}",AdjustedQuantity
The quantity the stock has been (or will be) corrected by. Note that a negative quantity means that the stock will be adjusted up.
": "{Decimal}",AdjustedAmount
Value of stock correction in local currency
": "{Decimal}",StockLocation
Stock location reference
": {Label
Name of current- and parent stock locations, including seperator for location
": "{String}"TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 104920 HTTP 400 | Log text is required |
Error 104921 HTTP 400 | Invalid log category |
Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
Error 105710 HTTP 400 | Invalid output type |