Procurement APIs
Production requirements grouped by product . Shows quantities for 20 periods ahead.
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/sop-processes/{sopProcessId}/production-requirement-plan |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {sopProcessId} |
S&OP (sales and operation planning) process identifier
Integer, minimum 100000 |
| Maximum page size ($top) | 50 |
| Successful HTTP status code | 200 |
| API resource identifier | 3292, version 16 |
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.
| $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.
| CustomField1 String | Custom field for grouping, sorting, categorizing and other purposes. |
| CustomField2 String | Custom field for grouping, sorting, categorizing and other purposes. |
| ManufacturingAreaId Integer | Manufacturing area identifier. |
| PlanningCategory String | Planning category. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductType String | Type of product. |
| PurchaseGroupId Integer | Purchase group identifier. |
Read more about filters and sorting on how to use sortable parameters
| CustomField1 String | Custom field for grouping, sorting, categorizing and other purposes. |
| CustomField2 String | Custom field for grouping, sorting, categorizing and other purposes. |
| ManufacturingAreaId Integer | Manufacturing area identifier |
| PlanningCategory String | Planning category |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| ProductType String | Type of product |
| PurchaseGroupId Integer | Purchase group 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.
ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>BlockedForProduction
If a product is blocked for production, no production work orders with that product can be registered.
>{Boolean}</BlockedForProduction>ProductLink
Product reference
>{String}</ProductLink>Period
Period as defined in the granularity parameter
>{String}</Period>AvailableQuantity
Total quantity available to be subtracted from the demand quantity (gross quantity). This is the sum of all goods receptions and production work orders ready to be consumed at requrested delivery date.
>{Decimal}</AvailableQuantity>GrossQuantity
Gross quantity of the production requirement. This is the total demand before any subtractions or adjustments is considered. Initially set as the demand forecasted quantity, but will be changed if the net quantity of parent product structures changes.
>{Decimal}</GrossQuantity>UserAdjustedQuantity
Quantity adjusted by the users. Can be both negative and positive. The sum of gross quantity and adjusted quantity can never be less than zero.
>{Decimal}</UserAdjustedQuantity>ProductionAdjustedQuantity
Some products are only produced in multiple of a specified quantity. In that case, the net quantity might need an adjustment.
>{Decimal}</ProductionAdjustedQuantity>SubtractedQuantity
Quantity of stock and production work orders subtracted from the gross quantity
>{Decimal}</SubtractedQuantity>NetQuantity
Net production requirement quantity. This is calculated by subtracting production work orders, stock and adjusted quantity from the gross quantity
>{Decimal}</NetQuantity>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>ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",BlockedForProduction
If a product is blocked for production, no production work orders with that product can be registered.
": "{Boolean}"ProductLink
Product reference
": "{String}"Period
Period as defined in the granularity parameter
": "{String}",AvailableQuantity
Total quantity available to be subtracted from the demand quantity (gross quantity). This is the sum of all goods receptions and production work orders ready to be consumed at requrested delivery date.
": "{Decimal}",GrossQuantity
Gross quantity of the production requirement. This is the total demand before any subtractions or adjustments is considered. Initially set as the demand forecasted quantity, but will be changed if the net quantity of parent product structures changes.
": "{Decimal}",UserAdjustedQuantity
Quantity adjusted by the users. Can be both negative and positive. The sum of gross quantity and adjusted quantity can never be less than zero.
": "{Decimal}",ProductionAdjustedQuantity
Some products are only produced in multiple of a specified quantity. In that case, the net quantity might need an adjustment.
": "{Decimal}",SubtractedQuantity
Quantity of stock and production work orders subtracted from the gross quantity
": "{Decimal}",NetQuantity
Net production requirement quantity. This is calculated by subtracting production work orders, stock and adjusted quantity from the gross quantity
": "{Decimal}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 |