API

Logistics APIs

GET system/reports/106897/result-set

Assets : Period amounts & total year

Report name Stock Location Assignment (SAP) Movements
Report identifier 106897
HTTP method GET
URI https://api.rambase.net/system/reports/106897/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 4612, version 17

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.

$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.

AssignmentEventOccuredAt Datetime Date and time the change occured. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CausalReference String Possible reference to an object related to the change.
CreatedByUserId Integer Employee identifier.
Date Datetime Date and time of change. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DeltaQuantity Decimal This is the quantity the stock location assignment is changed with because of picking/moving goods or correcting stock. Could be a positive or a negative number.
GoodsReceptionId Integer Goods reception identifier.
GoodsReceptionItemId Integer Item-/line-number of the goods reception.
Location String Unique abbreviation/short name of the location.
Product String Name of the product.
StockLocation String Name of current- and parent stock locations, including seperator for location.
Type String Type of change.

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

AssignmentEventOccuredAt Datetime Date and time the change occured
CausalReference String Possible reference to an object related to the change
CreatedByUserId Integer Employee identifier
Date Datetime Date and time of change
DeltaQuantity Decimal This is the quantity the stock location assignment is changed with because of picking/moving goods or correcting stock. Could be a positive or a negative number.
GoodsReceptionId Integer Goods reception identifier
GoodsReceptionItemId Integer Item-/line-number of the goods reception
Location String Unique abbreviation/short name of the location
Product String Name of the product
StockLocation String Name of current- and parent stock locations, including seperator for location
Type String Type of change

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
               <StockLocation
StockLocation

Stock location reference

>
5
                    <Label
Label

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

>{String}</Label>
6
                    <Location
Location

Location reference

>
7
                         <LocationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.StockLocation.Location.LocationId in your request URI to get this field

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

Unique abbreviation/short name of the location

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

Location reference

>{String}</LocationLink>
10
                    </Location>
11
               </StockLocation>
12
               <GoodsReceptionItem
GoodsReceptionItem

Goods reception item reference

>
13
                    <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
14
                    <Database
Database

Company code/database the object belongs to

>{String}</Database>
15
                    <GoodsReception
GoodsReception

Goods reception reference

>
16
                         <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
17
                         <Supplier
Supplier

Supplier reference

>
18
                              <SupplierId
SupplierId

RamBase supplier identifier

>{String}</SupplierId>
19
                              <Name
Name

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

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

API reference to the item

>{String}</SupplierLink>
21
                         </Supplier>
22
                         <GoodsReceptionLink
GoodsReceptionLink

Goods reception identifier

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

Product reference

>
25
                         <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>{String}</ProductLink>
28
                    </Product>
29
                    <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
30
               </GoodsReceptionItem>
31
               <AssignmentEvent
AssignmentEvent

Stock Assignment Register reference

>
32
                    <AssignmentEventId
AssignmentEventId

Change identifier

>{Integer}</AssignmentEventId>
33
                    <OccuredAt
OccuredAt

Date and time the change occured

>{Datetime}</OccuredAt>
34
                    <Type
Type

Type of change

>{String}</Type>
35
                    <DeltaQuantity
DeltaQuantity

This is the quantity the stock location assignment is changed with because of picking/moving goods or correcting stock. Could be a positive or a negative number.

>{Decimal}</DeltaQuantity>
36
                    <CreatedBy
CreatedBy

The employee who registered the change

>
37
                         <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
41
                    </CreatedBy>
42
                    <CausalReference
CausalReference

Possible reference to an object related to the change

>
43
                         <Database
Database

Company code/database the object belongs to

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.AssignmentEvent.CausalReference.Database in your request URI to get this field

>{String}</Database>
44
                         <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

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

Item-number of the object

>{Integer}</ItemId>
48
                         <ItemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
50
                    </CausalReference>
51
                    <AssignmentEventLink
AssignmentEventLink

Change reference

>{String}</AssignmentEventLink>
52
               </AssignmentEvent>
53
               <Inspect>
54
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
55
               </Inspect>
56
          </Row>
57
     </Rows>
58
     <Paging
Paging

Detailed paging information for this list.

>
59
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
62
          <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>
63
          <FirstPage
FirstPage

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

>{String}</FirstPage>
64
          <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>
65
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
66
          <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>
67
          <NextPage
NextPage

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

>{String}</NextPage>
68
          <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>
69
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
71
     </Paging>
72
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "stockLocation
StockLocation

Stock location reference

": {
6
                         "label
Label

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

": "{String}",
7
                         "location
Location

Location reference

": {
8
                              "locationId
LocationId

Location identifier

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.StockLocation.Location.LocationId in your request URI to get this field

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

Unique abbreviation/short name of the location

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

Location reference

": "{String}"
11
                         }
12
                    },
13
                    "goodsReceptionItem
GoodsReceptionItem

Goods reception item reference

": {
14
                         "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
15
                         "database
Database

Company code/database the object belongs to

": "{String}",
16
                         "goodsReception
GoodsReception

Goods reception reference

": {
17
                              "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
18
                              "supplier
Supplier

Supplier reference

": {
19
                                   "supplierId
SupplierId

RamBase supplier identifier

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

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

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

API reference to the item

": "{String}"
22
                              },
23
                              "goodsReceptionLink
GoodsReceptionLink

Goods reception identifier

": "{String}"
24
                         },
25
                         "product
Product

Product reference

": {
26
                              "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

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

Goods reception item reference

": "{String}"
31
                    },
32
                    "assignmentEvent
AssignmentEvent

Stock Assignment Register reference

": {
33
                         "assignmentEventId
AssignmentEventId

Change identifier

": "{Integer}",
34
                         "occuredAt
OccuredAt

Date and time the change occured

": "{Datetime}",
35
                         "type
Type

Type of change

": "{String}",
36
                         "deltaQuantity
DeltaQuantity

This is the quantity the stock location assignment is changed with because of picking/moving goods or correcting stock. Could be a positive or a negative number.

": "{Decimal}",
37
                         "createdBy
CreatedBy

The employee who registered the change

": {
38
                              "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
42
                         },
43
                         "causalReference
CausalReference

Possible reference to an object related to the change

": {
44
                              "database
Database

Company code/database the object belongs to

This field is greyed out because it is an expandable field. You have to add $expand=Rows.Row.AssignmentEvent.CausalReference.Database in your request URI to get this field

": "{String}",
45
                              "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

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

Item-number of the object

": "{Integer}",
49
                              "itemLink
ItemLink

API reference to the item

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

Internal RamBase identifier of the object/item

": "{String}"
51
                         },
52
                         "assignmentEventLink
AssignmentEventLink

Change reference

": "{String}"
53
                    },
54
                    "inspect": {
55
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
56
                    }
57
               }
58
          ]
59
     }
60
}

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