Procurement APIs
Purchase requirement details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/requirements/{purchaseRequirementId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseRequirementId} |
Purchase requirement identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3365, version 8 |
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
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>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>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>SOPProcessId
S&OP (sales and operation planning) process identifier
>{Integer}</SOPProcessId>SOPProcessLink
S&OP (salse and operation planning) process reference
>{String}</SOPProcessLink>PurchaseRequirementId
Purchase requirement identifier
": "{Integer}",Status
Status of purchase requirement
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",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}"SOPProcessId
S&OP (sales and operation planning) process identifier
": "{Integer}",SOPProcessLink
S&OP (salse and operation planning) process reference
": "{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 100089 HTTP 404 | Product not found |