API

Finance APIs

GET system/reports/106887/result-set?warehouseLocation={loc}

Assets : Period amounts & total year

Report name Parts availability overview 52 weeks
Report identifier 106887
HTTP method GET
URI https://api.rambase.net/system/reports/106887/result-set?warehouseLocation={loc}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 20
Successful HTTP status code 200
API resource identifier 4497, version 23

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.

warehouseLocation String, optional Unique abbreviation/short name of the location

Regular expression: ^[a-zA-Z]{3}$
$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.

CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
Description String Description of the product.
ExpectedPurchaseLeadTime Integer The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers..
Manufacturer String Manufacturer of the product.
ProductCategory String Product category.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductRevision String The Revision of the product.
Status Integer Status of the product.
Type String Type of product.

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

CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
Description String Description of the product
ExpectedPurchaseLeadTime Integer The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.
Manufacturer String Manufacturer of the product
ProductCategory String Product category
ProductId Integer Product identifier
ProductName String Name of the product
ProductRevision String The Revision of the product
Status Integer Status of the product
Type String Type of product

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

Status of the product

Possible domain values can be found here

>
{Integer}</Status>
5
               <Product
Product

Product reference

>
6
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Product reference

>
{String}</ProductLink>
9
               </Product>
10
               <ProductRevision
ProductRevision

The Revision of the product

>
{String}</ProductRevision>
11
               <Description
Description

Description of the product

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

Type of product

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

Product category

>
{String}</ProductCategory>
14
               <Manufacturer
Manufacturer

Manufacturer of the product

>
{String}</Manufacturer>
15
               <ExpectedPurchaseLeadTime
ExpectedPurchaseLeadTime

The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

>
{Integer}</ExpectedPurchaseLeadTime>
16
               <PurchaseGroup
PurchaseGroup

PurchaseGroup reference

>
17
                    <PurchaseGroupId
PurchaseGroupId

Purchase group identifier

>
{Integer}</PurchaseGroupId>
18
                    <Name
Name

Name of purchase group

>
{String}</Name>
19
               </PurchaseGroup>
20
               <QualityControlRequired
QualityControlRequired

Shows if quality control is required for article

>
{String}</QualityControlRequired>
21
               <ReorderPoint
ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

>
{Decimal}</ReorderPoint>
22
               <Week0
Week0

Week {WEEK0}

>
{Decimal}</Week0>
23
               <Week1
Week1

Week {WEEK1}

>
{Decimal}</Week1>
24
               <Week2
Week2

Week {WEEK2}

>
{Decimal}</Week2>
25
               <Week3
Week3

Week {WEEK3}

>
{Decimal}</Week3>
26
               <Week4
Week4

Week {WEEK4}

>
{Decimal}</Week4>
27
               <Week5
Week5

Week {WEEK5}

>
{Decimal}</Week5>
28
               <Week6
Week6

Week {WEEK6}

>
{Decimal}</Week6>
29
               <Week7
Week7

Week {WEEK7}

>
{Decimal}</Week7>
30
               <Week8
Week8

Week {WEEK8}

>
{Decimal}</Week8>
31
               <Week9
Week9

Week {WEEK9}

>
{Decimal}</Week9>
32
               <Week10
Week10

Week {WEEK10}

>
{Decimal}</Week10>
33
               <Week11
Week11

Week {WEEK11}

>
{Decimal}</Week11>
34
               <Week12
Week12

Week {WEEK12}

>
{Decimal}</Week12>
35
               <Week13
Week13

Week {WEEK13}

>
{Decimal}</Week13>
36
               <Week14
Week14

Week {WEEK14}

>
{Decimal}</Week14>
37
               <Week15
Week15

Week {WEEK15}

>
{Decimal}</Week15>
38
               <Week16
Week16

Week {WEEK16}

>
{Decimal}</Week16>
39
               <Week17
Week17

Week {WEEK17}

>
{Decimal}</Week17>
40
               <Week18
Week18

Week {WEEK18}

>
{Decimal}</Week18>
41
               <Week19
Week19

Week {WEEK19}

>
{Decimal}</Week19>
42
               <Week20
Week20

Week {WEEK20}

>
{Decimal}</Week20>
43
               <Week21
Week21

Week {WEEK21}

>
{Decimal}</Week21>
44
               <Week22
Week22

Week {WEEK22}

>
{Decimal}</Week22>
45
               <Week23
Week23

Week {WEEK23}

>
{Decimal}</Week23>
46
               <Week24
Week24

Week {WEEK24}

>
{Decimal}</Week24>
47
               <Week25
Week25

Week {WEEK25}

>
{Decimal}</Week25>
48
               <Week26
Week26

Week {WEEK26}

>
{Decimal}</Week26>
49
               <Week27
Week27

Week {WEEK27}

>
{Decimal}</Week27>
50
               <Week28
Week28

Week {WEEK28}

>
{Decimal}</Week28>
51
               <Week29
Week29

Week {WEEK29}

>
{Decimal}</Week29>
52
               <Week30
Week30

Week {WEEK30}

>
{Decimal}</Week30>
53
               <Week31
Week31

Week {WEEK31}

>
{Decimal}</Week31>
54
               <Week32
Week32

Week {WEEK32}

>
{Decimal}</Week32>
55
               <Week33
Week33

Week {WEEK33}

>
{Decimal}</Week33>
56
               <Week34
Week34

Week {WEEK34}

>
{Decimal}</Week34>
57
               <Week35
Week35

Week {WEEK35}

>
{Decimal}</Week35>
58
               <Week36
Week36

Week {WEEK36}

>
{Decimal}</Week36>
59
               <Week37
Week37

Week {WEEK37}

>
{Decimal}</Week37>
60
               <Week38
Week38

Week {WEEK38}

>
{Decimal}</Week38>
61
               <Week39
Week39

Week {WEEK39}

>
{Decimal}</Week39>
62
               <Week40
Week40

Week {WEEK40}

>
{Decimal}</Week40>
63
               <Week41
Week41

Week {WEEK41}

>
{Decimal}</Week41>
64
               <Week42
Week42

Week {WEEK42}

>
{Decimal}</Week42>
65
               <Week43
Week43

Week {WEEK43}

>
{Decimal}</Week43>
66
               <Week44
Week44

Week {WEEK44}

>
{Decimal}</Week44>
67
               <Week45
Week45

Week {WEEK45}

>
{Decimal}</Week45>
68
               <Week46
Week46

Week {WEEK46}

>
{Decimal}</Week46>
69
               <Week47
Week47

Week {WEEK47}

>
{Decimal}</Week47>
70
               <Week48
Week48

Week {WEEK48}

>
{Decimal}</Week48>
71
               <Week49
Week49

Week {WEEK49}

>
{Decimal}</Week49>
72
               <Week50
Week50

Week {WEEK50}

>
{Decimal}</Week50>
73
               <Week51
Week51

Week {WEEK51}

>
{Decimal}</Week51>
74
               <Inspect>
75
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>
{String}</TargetApplication>
76
               </Inspect>
77
          </Row>
78
     </Rows>
79
     <ColumnParameters
ColumnParameters

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

>
80
          <ColumnParameter
ColumnParameter

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

>
81
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>
{String}</Key>
82
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>
{String}</Value>
83
          </ColumnParameter>
84
     </ColumnParameters>
85
     <Paging
Paging

Detailed paging information for this list.

>
86
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>
{Integer}</Page>
89
          <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>
90
          <FirstPage
FirstPage

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

>
{String}</FirstPage>
91
          <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>
92
          <PreviousPage
PreviousPage

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

>
{String}</PreviousPage>
93
          <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>
94
          <NextPage
NextPage

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

>
{String}</NextPage>
95
          <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>
96
          <LastPage
LastPage

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

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

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

>
{Integer}</Size>
98
     </Paging>
99
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of the product

Possible domain values can be found here

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

Product reference

":
{
7
                         "productId
ProductId

Product identifier

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

Name of the product

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

Product reference

":
"{String}"
10
                    },
11
                    "productRevision
ProductRevision

The Revision of the product

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

Description of the product

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

Type of product

":
"{String}",
14
                    "productCategory
ProductCategory

Product category

":
"{String}",
15
                    "manufacturer
Manufacturer

Manufacturer of the product

":
"{String}",
16
                    "expectedPurchaseLeadTime
ExpectedPurchaseLeadTime

The expected lead time, in number of days, from ordering from supplier to delivery. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

":
"{Integer}",
17
                    "purchaseGroup
PurchaseGroup

PurchaseGroup reference

":
{
18
                         "purchaseGroupId
PurchaseGroupId

Purchase group identifier

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

Name of purchase group

":
"{String}"
20
                    },
21
                    "qualityControlRequired
QualityControlRequired

Shows if quality control is required for article

":
"{String}",
22
                    "reorderPoint
ReorderPoint

A minimum amount of quantity which a location holds in stock, such that, when stock falls to this amount, the product must be reordered.

":
"{Decimal}",
23
                    "week0
Week0

Week {WEEK0}

":
"{Decimal}",
24
                    "week1
Week1

Week {WEEK1}

":
"{Decimal}",
25
                    "week2
Week2

Week {WEEK2}

":
"{Decimal}",
26
                    "week3
Week3

Week {WEEK3}

":
"{Decimal}",
27
                    "week4
Week4

Week {WEEK4}

":
"{Decimal}",
28
                    "week5
Week5

Week {WEEK5}

":
"{Decimal}",
29
                    "week6
Week6

Week {WEEK6}

":
"{Decimal}",
30
                    "week7
Week7

Week {WEEK7}

":
"{Decimal}",
31
                    "week8
Week8

Week {WEEK8}

":
"{Decimal}",
32
                    "week9
Week9

Week {WEEK9}

":
"{Decimal}",
33
                    "week10
Week10

Week {WEEK10}

":
"{Decimal}",
34
                    "week11
Week11

Week {WEEK11}

":
"{Decimal}",
35
                    "week12
Week12

Week {WEEK12}

":
"{Decimal}",
36
                    "week13
Week13

Week {WEEK13}

":
"{Decimal}",
37
                    "week14
Week14

Week {WEEK14}

":
"{Decimal}",
38
                    "week15
Week15

Week {WEEK15}

":
"{Decimal}",
39
                    "week16
Week16

Week {WEEK16}

":
"{Decimal}",
40
                    "week17
Week17

Week {WEEK17}

":
"{Decimal}",
41
                    "week18
Week18

Week {WEEK18}

":
"{Decimal}",
42
                    "week19
Week19

Week {WEEK19}

":
"{Decimal}",
43
                    "week20
Week20

Week {WEEK20}

":
"{Decimal}",
44
                    "week21
Week21

Week {WEEK21}

":
"{Decimal}",
45
                    "week22
Week22

Week {WEEK22}

":
"{Decimal}",
46
                    "week23
Week23

Week {WEEK23}

":
"{Decimal}",
47
                    "week24
Week24

Week {WEEK24}

":
"{Decimal}",
48
                    "week25
Week25

Week {WEEK25}

":
"{Decimal}",
49
                    "week26
Week26

Week {WEEK26}

":
"{Decimal}",
50
                    "week27
Week27

Week {WEEK27}

":
"{Decimal}",
51
                    "week28
Week28

Week {WEEK28}

":
"{Decimal}",
52
                    "week29
Week29

Week {WEEK29}

":
"{Decimal}",
53
                    "week30
Week30

Week {WEEK30}

":
"{Decimal}",
54
                    "week31
Week31

Week {WEEK31}

":
"{Decimal}",
55
                    "week32
Week32

Week {WEEK32}

":
"{Decimal}",
56
                    "week33
Week33

Week {WEEK33}

":
"{Decimal}",
57
                    "week34
Week34

Week {WEEK34}

":
"{Decimal}",
58
                    "week35
Week35

Week {WEEK35}

":
"{Decimal}",
59
                    "week36
Week36

Week {WEEK36}

":
"{Decimal}",
60
                    "week37
Week37

Week {WEEK37}

":
"{Decimal}",
61
                    "week38
Week38

Week {WEEK38}

":
"{Decimal}",
62
                    "week39
Week39

Week {WEEK39}

":
"{Decimal}",
63
                    "week40
Week40

Week {WEEK40}

":
"{Decimal}",
64
                    "week41
Week41

Week {WEEK41}

":
"{Decimal}",
65
                    "week42
Week42

Week {WEEK42}

":
"{Decimal}",
66
                    "week43
Week43

Week {WEEK43}

":
"{Decimal}",
67
                    "week44
Week44

Week {WEEK44}

":
"{Decimal}",
68
                    "week45
Week45

Week {WEEK45}

":
"{Decimal}",
69
                    "week46
Week46

Week {WEEK46}

":
"{Decimal}",
70
                    "week47
Week47

Week {WEEK47}

":
"{Decimal}",
71
                    "week48
Week48

Week {WEEK48}

":
"{Decimal}",
72
                    "week49
Week49

Week {WEEK49}

":
"{Decimal}",
73
                    "week50
Week50

Week {WEEK50}

":
"{Decimal}",
74
                    "week51
Week51

Week {WEEK51}

":
"{Decimal}",
75
                    "inspect": {
76
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

":
"{String}"
77
                    }
78
               }
79
          ],
80
          "columnParameters
ColumnParameters

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

":
[
81
               {
82
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

":
"{String}",
83
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

":
"{String}"
84
               }
85
          ]
86
     }
87
}

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404 Setting definition not found
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type