API

Logistics APIs

GET system/reports/106006/result-set

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.

Format:
1
1

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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <GoodsReceptionCount
GoodsReceptionCount

Reference to the goods reception count

>
5
                    <GoodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

>
{Integer}</GoodsReceptionCountId>
6
                    <StockTaking
StockTaking

Stock taking reference

>
7
                         <StockTakingId
StockTakingId

Stock taking identifier

>
{Integer}</StockTakingId>
8
                         <StockTakingLink
StockTakingLink

Stock taking reference

>
{String}</StockTakingLink>
9
                    </StockTaking>
10
                    <GoodsReceptionCountLink
GoodsReceptionCountLink

Stock taking item reference

>
{String}</GoodsReceptionCountLink>
11
               </GoodsReceptionCount>
12
               <Name
Name

Name of stock taking

>
{String}</Name>
13
               <Type
Type

Type of stock taking

Possible domain values can be found here

>
{String}</Type>
14
               <GoodsReceptionItem
GoodsReceptionItem

Goods reception item reference

>
15
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>
{Integer}</GoodsReceptionItemId>
16
                    <GoodsReception
GoodsReception

Goods reception reference

>
17
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>
{Integer}</GoodsReceptionId>
18
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>
{String}</GoodsReceptionLink>
19
                    </GoodsReception>
20
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>
{String}</GoodsReceptionItemLink>
21
               </GoodsReceptionItem>
22
               <CreatedAt
CreatedAt

Date and time of creation

>
{Date}</CreatedAt>
23
               <CountedBy
CountedBy

Employee who perform the stock taking

>
24
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
25
                    <LastName
LastName

Last name of employee

>
{String}</LastName>
26
                    <FirstName
FirstName

First name of employee

>
{String}</FirstName>
27
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
28
               </CountedBy>
29
               <Product
Product

Product reference

>
30
                    <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
31
                    <Name
Name

Name of the product

>
{String}</Name>
32
                    <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
33
               </Product>
34
               <ExpectedStockQuantity
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>
35
               <CountedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the goods reception item for the stock location

>
{Decimal}</CountedStockQuantity>
36
               <StockCorrectionList
StockCorrectionList

Stock correction identifier

>
{String}</StockCorrectionList>
37
               <AdjustedQuantity
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>
38
               <AdjustedAmount
AdjustedAmount

Value of stock correction in local currency

>
{Decimal}</AdjustedAmount>
39
               <StockLocation
StockLocation

Stock location reference

>
40
                    <Label
Label

Name of current- and parent stock locations, including seperator for location

>
{String}</Label>
41
               </StockLocation>
42
               <Inspect>
43
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>
{String}</TargetApplication>
44
               </Inspect>
45
          </Row>
46
     </Rows>
47
     <Paging
Paging

Detailed paging information for this list.

>
48
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>
{Integer}</PageSize>
49
          <Position
Position

Position of the first element in the list

>
{Integer}</Position>
50
          <Page
Page

Page index

>
{Integer}</Page>
51
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</FirstPageKey>
52
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>
{String}</FirstPage>
53
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</PreviousPageKey>
54
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>
{String}</PreviousPage>
55
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</NextPageKey>
56
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>
{String}</NextPage>
57
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>
{String}</LastPageKey>
58
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>
{String}</LastPage>
59
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>
{Integer}</Size>
60
     </Paging>
61
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "goodsReceptionCount
GoodsReceptionCount

Reference to the goods reception count

":
{
6
                         "goodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

":
"{Integer}",
7
                         "stockTaking
StockTaking

Stock taking reference

":
{
8
                              "stockTakingId
StockTakingId

Stock taking identifier

":
"{Integer}",
9
                              "stockTakingLink
StockTakingLink

Stock taking reference

":
"{String}"
10
                         },
11
                         "goodsReceptionCountLink
GoodsReceptionCountLink

Stock taking item reference

":
"{String}"
12
                    },
13
                    "name
Name

Name of stock taking

":
"{String}",
14
                    "type
Type

Type of stock taking

Possible domain values can be found here

":
"{String}",
15
                    "goodsReceptionItem
GoodsReceptionItem

Goods reception item reference

":
{
16
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

":
"{Integer}",
17
                         "goodsReception
GoodsReception

Goods reception reference

":
{
18
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

":
"{Integer}",
19
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

":
"{String}"
20
                         },
21
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

":
"{String}"
22
                    },
23
                    "createdAt
CreatedAt

Date and time of creation

":
"{Date}",
24
                    "countedBy
CountedBy

Employee who perform the stock taking

":
{
25
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
26
                         "lastName
LastName

Last name of employee

":
"{String}",
27
                         "firstName
FirstName

First name of employee

":
"{String}",
28
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
29
                    },
30
                    "product
Product

Product reference

":
{
31
                         "productId
ProductId

Product identifier

":
"{Integer}",
32
                         "name
Name

Name of the product

":
"{String}",
33
                         "productLink
ProductLink

Product reference

":
"{String}"
34
                    },
35
                    "expectedStockQuantity
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}",
36
                    "countedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the goods reception item for the stock location

":
"{Decimal}",
37
                    "stockCorrectionList
StockCorrectionList

Stock correction identifier

":
"{String}",
38
                    "adjustedQuantity
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}",
39
                    "adjustedAmount
AdjustedAmount

Value of stock correction in local currency

":
"{Decimal}",
40
                    "stockLocation
StockLocation

Stock location reference

":
{
41
                         "label
Label

Name of current- and parent stock locations, including seperator for location

":
"{String}"
42
                    },
43
                    "inspect": {
44
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

":
"{String}"
45
                    }
46
               }
47
          ]
48
     }
49
}

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