API

Logistics APIs

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

List of all stock transactions across all stock entries and all stock items

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

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.

GoodsReceptions() Named filter Stock transactions with which resulted in a stock entry. Will have a goods reception item.
StockDecreasing() Named filter Stock transactions which decreases quantity
StockIncreasing() Named filter Stock transactions which increases quantity
WorkInProgress() Named filter Stock transaction affecting work in progress (WIP)
DepartmentId Integer Department identifier.
FinanceProjectId Integer Finance project identifier.
LocationId Integer Location identifier.
LocationShortName String Unique abbreviation/short name of the location.
ObjectId Integer Identifier of the object.
ObjectItemId Integer Item-number of the object.
ObjectType String Type of object.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
StartedAt Datetime Date and time the stock transaction occured. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
StartedByUserId Integer The user who started the stock transaction. Available macros: currentUser()
StockEntryDate Date Date of stock entry. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
StockEntryId Integer Stock entry identifier.
StockItemId Integer Stock item identifier.
StockTransactionId Integer Stock transaction identifier.
Type Integer Type of stock transaction.

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

DepartmentId Integer Department identifier
FinanceProjectId Integer Finance project identifier
LocationId Integer Location identifier
LocationShortName String Unique abbreviation/short name of the location
ObjectId Integer Identifier of the object
ObjectItemId Integer Item-number of the object
ObjectType String Type of object
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
StartedAt Datetime Date and time the stock transaction occured
StartedByUserId Integer The user who started the stock transaction
StockEntryDate Date Date of stock entry
StockEntryId Integer Stock entry identifier
StockItemId Integer Stock item identifier
StockTransactionId Integer Stock transaction 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
<StockTransactions>
2
     <StockTransaction>
3
          <StockTransactionId
StockTransactionId

Stock transaction identifier

>{Integer}</StockTransactionId>
4
          <Type
Type

Type of stock transaction

Possible domain values can be found here

>{Integer}</Type>
5
          <StartedAt
StartedAt

Date and time the stock transaction occured

>{Datetime}</StartedAt>
6
          <StartedBy
StartedBy

The user who started the stock transaction

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

>
7
               <UserId
UserId

User identifier

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

>{Integer}</UserId>
8
               <Name
Name

Name of the user

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

>{String}</Name>
9
               <FirstName
FirstName

First name of the user

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

>{String}</FirstName>
10
               <UserLink
UserLink

User reference

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

>{String}</UserLink>
11
          </StartedBy>
12
          <StockEntry>
13
               <StockEntryId
StockEntryId

Stock entry identifier

>{Integer}</StockEntryId>
14
               <EntryDate
EntryDate

Date of stock entry

>{Date}</EntryDate>
15
               <GoodsReceptionItem
GoodsReceptionItem

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

>
16
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

>{String}</GoodsReceptionItemId>
17
                    <Product
Product

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

>
18
                         <ProductId
ProductId

Product identifier

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

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

Name of the product

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

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

Type of product

Possible domain values can be found here

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

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

Description of the product

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

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

Product reference

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

>{String}</ProductLink>
23
                    </Product>
24
                    <GoodsReception
GoodsReception

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

>
25
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

>{Integer}</GoodsReceptionId>
26
                         <Location
Location

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

>
27
                              <LocationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

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

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

Location reference

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

>{String}</LocationLink>
30
                         </Location>
31
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

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

>{String}</GoodsReceptionLink>
32
                    </GoodsReception>
33
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

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

>{String}</GoodsReceptionItemLink>
34
               </GoodsReceptionItem>
35
               <StockEntryLink
StockEntryLink

Stock entry reference

>{String}</StockEntryLink>
36
          </StockEntry>
37
          <Item>
38
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
39
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
40
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
41
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
42
               <ItemType
ItemType

Type of item

>{String}</ItemType>
43
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
44
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
45
          </Item>
46
          <StockValueChange>
47
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
48
               <Quantity
Quantity

Changes in quantity

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

Changes in total stock value

>{Decimal}</Total>
50
          </StockValueChange>
51
          <StockValueChangeConverted
StockValueChangeConverted

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

>
52
               <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=StockTransaction.StockValueChangeConverted in your request URI to get this field

>{String}</Currency>
53
               <Total
Total

Changes in total stock value

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

>{Decimal}</Total>
54
          </StockValueChangeConverted>
55
          <FreightChange>
56
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
57
               <Total
Total

Total changes in freight value

>{Decimal}</Total>
58
          </FreightChange>
59
          <FreightChangeConverted
FreightChangeConverted

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

>
60
               <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=StockTransaction.FreightChangeConverted in your request URI to get this field

>{String}</Currency>
61
               <Total
Total

Total changes in freight value

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

>{Decimal}</Total>
62
          </FreightChangeConverted>
63
          <WorkInProgressChange>
64
               <Quantity
Quantity

Changes in quantity

>{Decimal}</Quantity>
65
          </WorkInProgressChange>
66
     </StockTransaction>
67
     <Paging
Paging

Detailed paging information for this list.

>
68
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
71
          <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>
72
          <FirstPage
FirstPage

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

>{String}</FirstPage>
73
          <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>
74
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
75
          <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>
76
          <NextPage
NextPage

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

>{String}</NextPage>
77
          <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>
78
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
80
     </Paging>
81
</StockTransactions>
1
{
2
     "stockTransactions": [
3
          {
4
               "stockTransactionId
StockTransactionId

Stock transaction identifier

": "{Integer}",
5
               "type
Type

Type of stock transaction

Possible domain values can be found here

": "{Integer}",
6
               "startedAt
StartedAt

Date and time the stock transaction occured

": "{Datetime}",
7
               "startedBy
StartedBy

The user who started the stock transaction

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

": {
8
                    "userId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

": "{String}",
11
                    "userLink
UserLink

User reference

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

": "{String}"
12
               },
13
               "stockEntry": {
14
                    "stockEntryId
StockEntryId

Stock entry identifier

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

Date of stock entry

": "{Date}",
16
                    "goodsReceptionItem
GoodsReceptionItem

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

": {
17
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

": "{String}",
18
                         "product
Product

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

": {
19
                              "productId
ProductId

Product identifier

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

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

Name of the product

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

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

Type of product

Possible domain values can be found here

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

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

Description of the product

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

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

Product reference

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

": "{String}"
24
                         },
25
                         "goodsReception
GoodsReception

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

": {
26
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

": "{Integer}",
27
                              "location
Location

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

": {
28
                                   "locationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

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

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

Location reference

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

": "{String}"
31
                              },
32
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

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

": "{String}"
33
                         },
34
                         "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

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

": "{String}"
35
                    },
36
                    "stockEntryLink
StockEntryLink

Stock entry reference

": "{String}"
37
               },
38
               "item": {
39
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
40
                    "objectType
ObjectType

Type of object

": "{String}",
41
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
42
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
43
                    "itemType
ItemType

Type of item

": "{String}",
44
                    "itemLink
ItemLink

API reference to the item

": "{String}",
45
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
46
               },
47
               "stockValueChange": {
48
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
49
                    "quantity
Quantity

Changes in quantity

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

Changes in total stock value

": "{Decimal}"
51
               },
52
               "stockValueChangeConverted
StockValueChangeConverted

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

": {
53
                    "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=StockTransaction.StockValueChangeConverted in your request URI to get this field

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

Changes in total stock value

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

": "{Decimal}"
55
               },
56
               "freightChange": {
57
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
58
                    "total
Total

Total changes in freight value

": "{Decimal}"
59
               },
60
               "freightChangeConverted
FreightChangeConverted

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

": {
61
                    "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=StockTransaction.FreightChangeConverted in your request URI to get this field

": "{String}",
62
                    "total
Total

Total changes in freight value

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

": "{Decimal}"
63
               },
64
               "workInProgressChange": {
65
                    "quantity
Quantity

Changes in quantity

": "{Decimal}"
66
               }
67
          }
68
     ],
69
     "paging
Paging

Detailed paging information for this list.

": {
70
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
82
     }
83
}

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 101566 HTTP 404 User not found
Error 101420 HTTP 404 Setting definition not found