Procurement APIs
List of purchase requirements
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/requirements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 3373, version 7 |
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.
| DemandForecastedQuantity Decimal | The total quantity from the demand forecast. This might include sales forecasts, sales backlog, minimum reorder point quantity, quantity expanded from BOM etc.. |
| GrossQuantity Decimal | Gross quantity is initially the same as the sales forecasted quantity but might have changed during the production requirement planning. The gross quantity is the final required quantity for given product at requested delivery date. |
| NetQuantity Decimal | Net purchase requirement. This is the quantity needed to be ordered for this product at this requested delivery date. The net quantity is calculated by subtracting stock, purchase orders and purchase order responses from the gross quantity. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| PurchaseGroupId Integer | Purchase group identifier. |
| PurchaseRequirementId Integer | Purchase requirement identifier. |
| RequestedDeliveryDate Date | The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| SOPProcessId Integer | S&OP (sales and operation planning) process identifier. |
| Status Integer | Status of purchase requirement. |
Read more about filters and sorting on how to use sortable parameters
| DemandForecastedQuantity Decimal | The total quantity from the demand forecast. This might include sales forecasts, sales backlog, minimum reorder point quantity, quantity expanded from BOM etc. |
| GrossQuantity Decimal | Gross quantity is initially the same as the sales forecasted quantity but might have changed during the production requirement planning. The gross quantity is the final required quantity for given product at requested delivery date. |
| NetQuantity Decimal | Net purchase requirement. This is the quantity needed to be ordered for this product at this requested delivery date. The net quantity is calculated by subtracting stock, purchase orders and purchase order responses from the gross quantity. |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| PurchaseGroupId Integer | Purchase group identifier |
| PurchaseRequirementId Integer | Purchase requirement identifier |
| RequestedDeliveryDate Date | The delivery date as requested by the customer. |
| SOPProcessId Integer | S&OP (sales and operation planning) process identifier |
| Status Integer | Status of purchase requirement |
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.
PurchaseRequirementId
Purchase requirement identifier
>{Integer}</PurchaseRequirementId>Status
Status of purchase requirement
Possible domain values can be found here
>{Integer}</Status>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>DemandForecastedQuantity
The total quantity from the demand forecast. This might include sales forecasts, sales backlog, minimum reorder point quantity, quantity expanded from BOM etc.
>{Decimal}</DemandForecastedQuantity>AvailableQuantity
Total quantity available to be subtracted from the gross quantity. This is the sum of all goods receptions, purchase orders and purchase order responses ready to be consumed at requested delivery date.
>{Decimal}</AvailableQuantity>GrossQuantity
Gross quantity is initially the same as the sales forecasted quantity but might have changed during the production requirement planning. The gross quantity is the final required quantity for given product at requested delivery date.
>{Decimal}</GrossQuantity>SubtractedQuantity
Quantity of stock, purchase orders and purchase order responses subtracted from the gross quantity
>{Decimal}</SubtractedQuantity>NetQuantity
Net purchase requirement. This is the quantity needed to be ordered for this product at this requested delivery date. The net quantity is calculated by subtracting stock, purchase orders and purchase order responses from the gross quantity.
>{Decimal}</NetQuantity>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>PurchaseRequirementLink
Purchase requirement reference
>{String}</PurchaseRequirementLink>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>PurchaseRequirementId
Purchase requirement identifier
": "{Integer}",Status
Status of purchase requirement
Possible domain values can be found here
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",DemandForecastedQuantity
The total quantity from the demand forecast. This might include sales forecasts, sales backlog, minimum reorder point quantity, quantity expanded from BOM etc.
": "{Decimal}",AvailableQuantity
Total quantity available to be subtracted from the gross quantity. This is the sum of all goods receptions, purchase orders and purchase order responses ready to be consumed at requested delivery date.
": "{Decimal}",GrossQuantity
Gross quantity is initially the same as the sales forecasted quantity but might have changed during the production requirement planning. The gross quantity is the final required quantity for given product at requested delivery date.
": "{Decimal}",SubtractedQuantity
Quantity of stock, purchase orders and purchase order responses subtracted from the gross quantity
": "{Decimal}",NetQuantity
Net purchase requirement. This is the quantity needed to be ordered for this product at this requested delivery date. The net quantity is calculated by subtracting stock, purchase orders and purchase order responses from the gross quantity.
": "{Decimal}",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}",ProductLink
Product reference
": "{String}"PurchaseRequirementLink
Purchase requirement reference
": "{String}"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 100089 HTTP 404 | Product not found |