API

Logistics APIs

GET logistics/stock-entries?costingMethod={costingMethod}

List of stock entries across all stock items

HTTP method GET
URI https://api.rambase.net/logistics/stock-entries?costingMethod={costingMethod}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3648, version 15

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.

costingMethod String, optional Costing method to use for stock valuation. Default is costing method specified in product, but can be set to "SI" to see stock value for specific identification costing method.
$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.

InStock() Named filter Stock entries with quantity in stock
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EntryDate Date Date of stock entry. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
LocationId Integer Location identifier.
LocationShortName String Unique abbreviation/short name of the location.
ProductName String Name of the product.
Quantity Decimal Quantity used for calculating stock value.
Status Integer Status of stock entry.
StockEntryId Integer Stock entry identifier.
StockItemId Integer Stock item identifier.

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

CreatedAt Datetime Date and time of creation
EntryDate Date Date of stock entry
GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
LocationId Integer Location identifier
LocationShortName String Unique abbreviation/short name of the location
ProductName String Name of the product
Status Integer Status of stock entry
StockEntryId Integer Stock entry identifier
StockItemId Integer Stock item identifier

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
<StockEntries>
2
     <StockEntry>
3
          <StockEntryId
StockEntryId

Stock entry identifier

>{Integer}</StockEntryId>
4
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
          <Status
Status

Status of stock entry

Possible domain values can be found here

>{Integer}</Status>
6
          <EntryDate
EntryDate

Date of stock entry

>{Date}</EntryDate>
7
          <GoodsReceptionItem>
8
               <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
9
               <Product>
10
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

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

Description of the product

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

Product reference

>{String}</ProductLink>
15
               </Product>
16
               <GoodsReception>
17
                    <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
18
                    <Supplier>
19
                         <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
20
                         <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
21
                         <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
22
                    </Supplier>
23
                    <Location>
24
                         <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
25
                         <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
26
                         <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
27
                    </Location>
28
                    <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
29
               </GoodsReception>
30
               <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
31
          </GoodsReceptionItem>
32
          <StockValue>
33
               <CostingMethod
CostingMethod

Costing method to use for stock valuation.

Possible domain values can be found here

>{String}</CostingMethod>
34
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
35
               <Cost
Cost

Cost used in stock valuation

>{Decimal}</Cost>
36
               <Quantity
Quantity

Quantity used for calculating stock value

>{Decimal}</Quantity>
37
               <Total
Total

Total stock value

>{Decimal}</Total>
38
          </StockValue>
39
          <StockValueConverted
StockValueConverted

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

>
40
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
41
               <Cost
Cost

Cost used in stock valuation

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

>{Decimal}</Cost>
42
               <Total
Total

Total stock value

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

>{Decimal}</Total>
43
          </StockValueConverted>
44
          <FreightValue>
45
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
46
               <Freight
Freight

Freight used in stock valuation

>{Decimal}</Freight>
47
               <Total
Total

Total freight value

>{Decimal}</Total>
48
          </FreightValue>
49
          <FreightValueConverted
FreightValueConverted

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

>
50
               <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
51
               <Cost
Cost

Freight used in stock valuation

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

>{Decimal}</Cost>
52
               <ExchangeRate
ExchangeRate

The exchange rate used in convertion

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

>{Decimal}</ExchangeRate>
53
               <Total
Total

Total freight value

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

>{Decimal}</Total>
54
          </FreightValueConverted>
55
          <StockItem>
56
               <StockItemId
StockItemId

Stock item identifier

>{Integer}</StockItemId>
57
               <StockItemLink
StockItemLink

Stock item referance

>{String}</StockItemLink>
58
          </StockItem>
59
          <StockEntryLink
StockEntryLink

Stock entry reference

>{String}</StockEntryLink>
60
     </StockEntry>
61
     <Paging
Paging

Detailed paging information for this list.

>
62
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
65
          <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>
66
          <FirstPage
FirstPage

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

>{String}</FirstPage>
67
          <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>
68
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
69
          <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>
70
          <NextPage
NextPage

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

>{String}</NextPage>
71
          <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>
72
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
74
     </Paging>
75
</StockEntries>
1
{
2
     "stockEntries": [
3
          {
4
               "stockEntryId
StockEntryId

Stock entry identifier

": "{Integer}",
5
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
               "status
Status

Status of stock entry

Possible domain values can be found here

": "{Integer}",
7
               "entryDate
EntryDate

Date of stock entry

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

Item-/line-number of the goods reception

": "{Integer}",
10
                    "product": {
11
                         "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
14
                         "description
Description

Description of the product

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

Product reference

": "{String}"
16
                    },
17
                    "goodsReception": {
18
                         "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
19
                         "supplier": {
20
                              "supplierId
SupplierId

RamBase supplier identifier

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

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
22
                              "supplierLink
SupplierLink

Supplier reference

": "{String}"
23
                         },
24
                         "location": {
25
                              "locationId
LocationId

Location identifier

": "{Integer}",
26
                              "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
27
                              "locationLink
LocationLink

Location reference

": "{String}"
28
                         },
29
                         "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
30
                    },
31
                    "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
32
               },
33
               "stockValue": {
34
                    "costingMethod
CostingMethod

Costing method to use for stock valuation.

Possible domain values can be found here

": "{String}",
35
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
36
                    "cost
Cost

Cost used in stock valuation

": "{Decimal}",
37
                    "quantity
Quantity

Quantity used for calculating stock value

": "{Decimal}",
38
                    "total
Total

Total stock value

": "{Decimal}"
39
               },
40
               "stockValueConverted
StockValueConverted

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

": {
41
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
42
                    "cost
Cost

Cost used in stock valuation

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

": "{Decimal}",
43
                    "total
Total

Total stock value

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

": "{Decimal}"
44
               },
45
               "freightValue": {
46
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
47
                    "freight
Freight

Freight used in stock valuation

": "{Decimal}",
48
                    "total
Total

Total freight value

": "{Decimal}"
49
               },
50
               "freightValueConverted
FreightValueConverted

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

": {
51
                    "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
52
                    "cost
Cost

Freight used in stock valuation

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

": "{Decimal}",
53
                    "exchangeRate
ExchangeRate

The exchange rate used in convertion

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

": "{Decimal}",
54
                    "total
Total

Total freight value

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

": "{Decimal}"
55
               },
56
               "stockItem": {
57
                    "stockItemId
StockItemId

Stock item identifier

": "{Integer}",
58
                    "stockItemLink
StockItemLink

Stock item referance

": "{String}"
59
               },
60
               "stockEntryLink
StockEntryLink

Stock entry reference

": "{String}"
61
          }
62
     ],
63
     "paging
Paging

Detailed paging information for this list.

": {
64
          "pageSize
PageSize

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

": "{Integer}",
65
          "position
Position

Position of the first element in the list

": "{Integer}",
66
          "page
Page

Page index

": "{Integer}",
67
          "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}",
68
          "firstPage
FirstPage

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

": "{String}",
69
          "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}",
70
          "previousPage
PreviousPage

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

": "{String}",
71
          "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}",
72
          "nextPage
NextPage

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

": "{String}",
73
          "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}",
74
          "lastPage
LastPage

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

": "{String}",
75
          "size
Size

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

": "{Integer}"
76
     }
77
}

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 101304 HTTP 404 Carrier not found
Error 100053 HTTP 403 You have only admittance to your own suppliers
Error 100511 HTTP 400 Invalid date