Finance APIs
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) | 30 |
| 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.
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.
Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ProductRevision
The Revision of the product
>{String}</ProductRevision>Description
Description of the product
>{String}</Description>Type
Type of product
>{String}</Type>ProductCategory
Product category
>{String}</ProductCategory>Manufacturer
Manufacturer of the product
>{String}</Manufacturer>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>PurchaseGroup
PurchaseGroup reference
>PurchaseGroupId
Purchase group identifier
>{Integer}</PurchaseGroupId>Name
Name of purchase group
>{String}</Name>QualityControlRequired
Shows if quality control is required for article
>{String}</QualityControlRequired>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.
Week0
Week {WEEK0}
>{Decimal}</Week0>Week1
Week {WEEK1}
>{Decimal}</Week1>Week2
Week {WEEK2}
>{Decimal}</Week2>Week3
Week {WEEK3}
>{Decimal}</Week3>Week4
Week {WEEK4}
>{Decimal}</Week4>Week5
Week {WEEK5}
>{Decimal}</Week5>Week6
Week {WEEK6}
>{Decimal}</Week6>Week7
Week {WEEK7}
>{Decimal}</Week7>Week8
Week {WEEK8}
>{Decimal}</Week8>Week9
Week {WEEK9}
>{Decimal}</Week9>Week10
Week {WEEK10}
>{Decimal}</Week10>Week11
Week {WEEK11}
>{Decimal}</Week11>Week12
Week {WEEK12}
>{Decimal}</Week12>Week13
Week {WEEK13}
>{Decimal}</Week13>Week14
Week {WEEK14}
>{Decimal}</Week14>Week15
Week {WEEK15}
>{Decimal}</Week15>Week16
Week {WEEK16}
>{Decimal}</Week16>Week17
Week {WEEK17}
>{Decimal}</Week17>Week18
Week {WEEK18}
>{Decimal}</Week18>Week19
Week {WEEK19}
>{Decimal}</Week19>Week20
Week {WEEK20}
>{Decimal}</Week20>Week21
Week {WEEK21}
>{Decimal}</Week21>Week22
Week {WEEK22}
>{Decimal}</Week22>Week23
Week {WEEK23}
>{Decimal}</Week23>Week24
Week {WEEK24}
>{Decimal}</Week24>Week25
Week {WEEK25}
>{Decimal}</Week25>Week26
Week {WEEK26}
>{Decimal}</Week26>Week27
Week {WEEK27}
>{Decimal}</Week27>Week28
Week {WEEK28}
>{Decimal}</Week28>Week29
Week {WEEK29}
>{Decimal}</Week29>Week30
Week {WEEK30}
>{Decimal}</Week30>Week31
Week {WEEK31}
>{Decimal}</Week31>Week32
Week {WEEK32}
>{Decimal}</Week32>Week33
Week {WEEK33}
>{Decimal}</Week33>Week34
Week {WEEK34}
>{Decimal}</Week34>Week35
Week {WEEK35}
>{Decimal}</Week35>Week36
Week {WEEK36}
>{Decimal}</Week36>Week37
Week {WEEK37}
>{Decimal}</Week37>Week38
Week {WEEK38}
>{Decimal}</Week38>Week39
Week {WEEK39}
>{Decimal}</Week39>Week40
Week {WEEK40}
>{Decimal}</Week40>Week41
Week {WEEK41}
>{Decimal}</Week41>Week42
Week {WEEK42}
>{Decimal}</Week42>Week43
Week {WEEK43}
>{Decimal}</Week43>Week44
Week {WEEK44}
>{Decimal}</Week44>Week45
Week {WEEK45}
>{Decimal}</Week45>Week46
Week {WEEK46}
>{Decimal}</Week46>Week47
Week {WEEK47}
>{Decimal}</Week47>Week48
Week {WEEK48}
>{Decimal}</Week48>Week49
Week {WEEK49}
>{Decimal}</Week49>Week50
Week {WEEK50}
>{Decimal}</Week50>Week51
Week {WEEK51}
>{Decimal}</Week51>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Status
Status of the product
Possible domain values can be found here
": "{Integer}",Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",ProductLink
Product reference
": "{String}"ProductRevision
The Revision of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
": "{String}",ProductCategory
Product category
": "{String}",Manufacturer
Manufacturer of the product
": "{String}",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}",PurchaseGroup
PurchaseGroup reference
": {PurchaseGroupId
Purchase group identifier
": "{Integer}",Name
Name of purchase group
": "{String}"QualityControlRequired
Shows if quality control is required for article
": "{String}",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.
Week0
Week {WEEK0}
": "{Decimal}",Week1
Week {WEEK1}
": "{Decimal}",Week2
Week {WEEK2}
": "{Decimal}",Week3
Week {WEEK3}
": "{Decimal}",Week4
Week {WEEK4}
": "{Decimal}",Week5
Week {WEEK5}
": "{Decimal}",Week6
Week {WEEK6}
": "{Decimal}",Week7
Week {WEEK7}
": "{Decimal}",Week8
Week {WEEK8}
": "{Decimal}",Week9
Week {WEEK9}
": "{Decimal}",Week10
Week {WEEK10}
": "{Decimal}",Week11
Week {WEEK11}
": "{Decimal}",Week12
Week {WEEK12}
": "{Decimal}",Week13
Week {WEEK13}
": "{Decimal}",Week14
Week {WEEK14}
": "{Decimal}",Week15
Week {WEEK15}
": "{Decimal}",Week16
Week {WEEK16}
": "{Decimal}",Week17
Week {WEEK17}
": "{Decimal}",Week18
Week {WEEK18}
": "{Decimal}",Week19
Week {WEEK19}
": "{Decimal}",Week20
Week {WEEK20}
": "{Decimal}",Week21
Week {WEEK21}
": "{Decimal}",Week22
Week {WEEK22}
": "{Decimal}",Week23
Week {WEEK23}
": "{Decimal}",Week24
Week {WEEK24}
": "{Decimal}",Week25
Week {WEEK25}
": "{Decimal}",Week26
Week {WEEK26}
": "{Decimal}",Week27
Week {WEEK27}
": "{Decimal}",Week28
Week {WEEK28}
": "{Decimal}",Week29
Week {WEEK29}
": "{Decimal}",Week30
Week {WEEK30}
": "{Decimal}",Week31
Week {WEEK31}
": "{Decimal}",Week32
Week {WEEK32}
": "{Decimal}",Week33
Week {WEEK33}
": "{Decimal}",Week34
Week {WEEK34}
": "{Decimal}",Week35
Week {WEEK35}
": "{Decimal}",Week36
Week {WEEK36}
": "{Decimal}",Week37
Week {WEEK37}
": "{Decimal}",Week38
Week {WEEK38}
": "{Decimal}",Week39
Week {WEEK39}
": "{Decimal}",Week40
Week {WEEK40}
": "{Decimal}",Week41
Week {WEEK41}
": "{Decimal}",Week42
Week {WEEK42}
": "{Decimal}",Week43
Week {WEEK43}
": "{Decimal}",Week44
Week {WEEK44}
": "{Decimal}",Week45
Week {WEEK45}
": "{Decimal}",Week46
Week {WEEK46}
": "{Decimal}",Week47
Week {WEEK47}
": "{Decimal}",Week48
Week {WEEK48}
": "{Decimal}",Week49
Week {WEEK49}
": "{Decimal}",Week50
Week {WEEK50}
": "{Decimal}",Week51
Week {WEEK51}
": "{Decimal}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
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 |