API

Logistics APIs

GET logistics/stock-takings/{stockTakingId}/goods-reception-counts/{goodsReceptionCountId}

Details for provided goods reception count

HTTP method GET
URI https://api.rambase.net/logistics/stock-takings/{stockTakingId}/goods-reception-counts/{goodsReceptionCountId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {stockTakingId} Stock taking identifier
Integer, minimum 100000
- URI parameter {goodsReceptionCountId} Goods reception count identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2197, version 5

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

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
<GoodsReceptionCount>
2
     <GoodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

>{Integer}</GoodsReceptionCountId>
3
     <Status
Status

Status of the goods reception count

Possible domain values can be found here

>{Integer}</Status>
4
     <CurrentStockQuantity
CurrentStockQuantity

Current stock quantity is an accumulated/calculated stock quantity for the given goods reception count at a specific stock location

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

>{Decimal}</CurrentStockQuantity>
5
     <ExpectedStockQuantity
ExpectedStockQuantity

Expected quantity to be found when counting a specific goods reception item at a specific stock location. Note that this field will not be set before you have actually started the counting.

>{Decimal}</ExpectedStockQuantity>
6
     <CountedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the stock location assignment

>{Decimal}</CountedStockQuantity>
7
     <GoodsReceptionItem>
8
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
9
          <GoodsReception>
10
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
11
               <Product
Product

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

>
12
                    <ProductId
ProductId

Product identifier

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

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

Name of the product

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

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

Product reference

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

>{String}</ProductLink>
15
               </Product>
16
               <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
17
          </GoodsReception>
18
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Item-/line-number of the goods reception

>{String}</GoodsReceptionItemLink>
19
     </GoodsReceptionItem>
20
</GoodsReceptionCount>
1
{
2
     "goodsReceptionCount": {
3
          "goodsReceptionCountId
GoodsReceptionCountId

Goods reception count identifier

": "{Integer}",
4
          "status
Status

Status of the goods reception count

Possible domain values can be found here

": "{Integer}",
5
          "currentStockQuantity
CurrentStockQuantity

Current stock quantity is an accumulated/calculated stock quantity for the given goods reception count at a specific stock location

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

": "{Decimal}",
6
          "expectedStockQuantity
ExpectedStockQuantity

Expected quantity to be found when counting a specific goods reception item at a specific stock location. Note that this field will not be set before you have actually started the counting.

": "{Decimal}",
7
          "countedStockQuantity
CountedStockQuantity

The counted/actual quantity found when counting the stock location assignment

": "{Decimal}",
8
          "goodsReceptionItem": {
9
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
10
               "goodsReception": {
11
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
12
                    "product
Product

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

": {
13
                         "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Product reference

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

": "{String}"
16
                    },
17
                    "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
18
               },
19
               "goodsReceptionItemLink
GoodsReceptionItemLink

Item-/line-number of the goods reception

": "{String}"
20
          }
21
     }
22
}

Possible error codes the response might return:

Error 101889 HTTP 404 Stock taking goods reception not found