Procurement APIs
List out purchase requirements accumulated
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/purchase-requirements-by-reorder-point?locationId={locationId}&supplierId={supplierId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6874, version 15 |
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.
| locationId Integer, required |
Location identifier
Minimum: 10000 |
| supplierId Integer, optional |
RamBase supplier identifier
Minimum: 100 |
| $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.
| HideBlocked() Named filter | If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered. |
| ShowActiveDemand() Named filter | Pending action |
| AvailableBacklogWithinLeadtime Decimal | Available quantity in purchase backlog which is exptected to arrive within leadtime. |
| AvailableStockQuantity Decimal | Total available quantity in stock in all locations. This quantity is not assigned to any orders. |
| ExpectedStockOutDate Date | Estimated date which stock runs out based on average daily consumption. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| IsBlockedForPurchase Boolean | If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.. |
| IsOutsideOfAssignmentWindow Boolean | Indicates that this product is outside of assignment window. |
| ManufacturersProductName String | Manufacturers name of the product. Also known as Manufacturer Part Number (MPN). |
| MaximumStock Decimal | A maximal quantity for how much a company wants to have in inventory at any time in a specific location. |
| ProductDescription String | Description of the product. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductSafetyStock Decimal | A quantity that should be a buffer of extra inventory at a specific location. It is held to protect against uncertainties such as supplier delays, changes in demand, etc. It does not trigger replenishment, it is a passive reserve. |
| ProductStatus Integer | Status of the product. |
| ProductType String | Type of product. |
| PurchaseGroupId Integer | Purchase group identifier. |
| ReorderPoint Decimal | Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout. |
| ReorderQuantity Decimal | Suggested quantity to purchase when stock gets below reorder point. |
| Shortage Decimal | The actual quantity which is required to meet reorder point. |
| StockQuantity Decimal | Total quantity in stock in all locations. |
| SuppliersProductName String | Supplier internal product name. |
Read more about filters and sorting on how to use sortable parameters
| AvailableBacklogWithinLeadtime Decimal | Available quantity in purchase backlog which is exptected to arrive within leadtime |
| AvailableStockQuantity Decimal | Total available quantity in stock in all locations. This quantity is not assigned to any orders. |
| ExpectedStockOutDate Date | Estimated date which stock runs out based on average daily consumption |
| IsBlockedForPurchase Boolean | If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered. |
| IsOutsideOfAssignmentWindow Boolean | Indicates that this product is outside of assignment window |
| ManufacturersProductName String | Manufacturers name of the product. Also known as Manufacturer Part Number (MPN). |
| MaximumStock Decimal | A maximal quantity for how much a company wants to have in inventory at any time in a specific location |
| ProductDescription String | Description of the product |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| ProductSafetyStock Decimal | A quantity that should be a buffer of extra inventory at a specific location. It is held to protect against uncertainties such as supplier delays, changes in demand, etc. It does not trigger replenishment, it is a passive reserve. |
| ProductStatus Integer | Status of the product |
| ProductType String | Type of product |
| PurchaseGroupId Integer | Purchase group identifier |
| ReorderPoint Decimal | Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout. |
| ReorderQuantity Decimal | Suggested quantity to purchase when stock gets below reorder point. |
| Shortage Decimal | The actual quantity which is required to meet reorder point |
| StockQuantity Decimal | Total quantity in stock in all locations. |
| SuppliersProductName String | Supplier internal product name |
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.
PurchaseBacklogQuantity
Total quantity from purchase backlog
>{Decimal}</PurchaseBacklogQuantity>EarliestConfirmedDeliveryDate
The earliest confirmed delivery date from purchase backlog
>{Date}</EarliestConfirmedDeliveryDate>AverageDailyConsumption
Average daily consumption of the product based on historical data.
Calculated as total consumption over 90 days.
EstimatedDaysOfStockLeft
Estimated number of days before stock runs out based on average daily consumption
>{Integer}</EstimatedDaysOfStockLeft>SuggestedPurchaseQuantity
Calculated requirement based on “Net requirement”, but adjusted for package size and minimum order quantity
>{Decimal}</SuggestedPurchaseQuantity>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>Precision
The precision/accuracy of the measurement (number of decimals)
>{Integer}</Precision>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ManufacturersProductId
Manufacturer product identifier
>{Integer}</ManufacturersProductId>ManufacturersProductLink
Manufacturers product reference
>{String}</ManufacturersProductLink>ExpectedLeadTime
The expected lead time, in number of days, from ordering from supplier to goods reception. 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}</ExpectedLeadTime>ProductLink
Product identifier
>{String}</ProductLink>BlockedForPurchase
If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.
>{Boolean}</BlockedForPurchase>ReorderQuantity
Suggested quantity to purchase when stock gets below reorder point.
>{Decimal}</ReorderQuantity>ReorderPoint
Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout.
>{Decimal}</ReorderPoint>MaximumStock
A maximal quantity for how much a company wants to have in inventory at any time in a specific location
>{Decimal}</MaximumStock>SafetyStock
A quantity that should be a buffer of extra inventory at a specific location. It is held to protect against uncertainties such as supplier delays, changes in demand, etc. It does not trigger replenishment, it is a passive reserve.
>{Decimal}</SafetyStock>Shortage
The actual quantity which is required to meet reorder point
>{Decimal}</Shortage>LeadTimeBuffer
If a value is set, it overrides the company-wide setting for calculating the procurement deadlines,
otherwise the default company-wide setting applies.
ExpectedStockOutDate
Estimated date which stock runs out based on average daily consumption
>{Date}</ExpectedStockOutDate>AvailableBacklogWithinLeadtime
Available quantity in purchase backlog which is exptected to arrive within leadtime
>{Decimal}</AvailableBacklogWithinLeadtime>StockQuantity
Quantity in stock at a specifice location.
>{Decimal}</StockQuantity>AvailableStockQuantity
Available quantity in stock in a specifice location. This quantity is not assigned to any orders.
>{Decimal}</AvailableStockQuantity>StandardLeadTime
Standard leadtime in days for this product from this supplier
>{Integer}</StandardLeadTime>IsPreferred
Whether this supplier is preferred or not
>{Boolean}</IsPreferred>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>ConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.
This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.
SupplierLink
Supplier reference
>{String}</SupplierLink>Name
Supplier internal product name
>{String}</Name>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>PurchaseBacklogQuantity
Total quantity from purchase backlog
": "{Decimal}",EarliestConfirmedDeliveryDate
The earliest confirmed delivery date from purchase backlog
": "{Date}",AverageDailyConsumption
Average daily consumption of the product based on historical data.
Calculated as total consumption over 90 days.
EstimatedDaysOfStockLeft
Estimated number of days before stock runs out based on average daily consumption
": "{Integer}",SuggestedPurchaseQuantity
Calculated requirement based on “Net requirement”, but adjusted for package size and minimum order quantity
": "{Decimal}",ProductId
Product identifier
": "{Integer}",Status
Status of the product
Possible domain values can be found here
": "{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}",MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
": {MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",Precision
The precision/accuracy of the measurement (number of decimals)
": "{Integer}",MeasurementUnitLink
Material unit reference
": "{String}"ManufacturersProductId
Manufacturer product identifier
": "{Integer}",ManufacturersProductLink
Manufacturers product reference
": "{String}"ExpectedLeadTime
The expected lead time, in number of days, from ordering from supplier to goods reception. 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}"ProductLink
Product identifier
": "{String}"BlockedForPurchase
If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.
": "{Boolean}",ReorderQuantity
Suggested quantity to purchase when stock gets below reorder point.
": "{Decimal}",ReorderPoint
Reorder point. A locations specific stock level which a new order must be placed to replenish stock and prevent a stockout.
": "{Decimal}",MaximumStock
A maximal quantity for how much a company wants to have in inventory at any time in a specific location
": "{Decimal}",SafetyStock
A quantity that should be a buffer of extra inventory at a specific location. It is held to protect against uncertainties such as supplier delays, changes in demand, etc. It does not trigger replenishment, it is a passive reserve.
": "{Decimal}",Shortage
The actual quantity which is required to meet reorder point
": "{Decimal}",LeadTimeBuffer
If a value is set, it overrides the company-wide setting for calculating the procurement deadlines,
otherwise the default company-wide setting applies.
ExpectedStockOutDate
Estimated date which stock runs out based on average daily consumption
": "{Date}",AvailableBacklogWithinLeadtime
Available quantity in purchase backlog which is exptected to arrive within leadtime
": "{Decimal}"StockQuantity
Quantity in stock at a specifice location.
": "{Decimal}",AvailableStockQuantity
Available quantity in stock in a specifice location. This quantity is not assigned to any orders.
": "{Decimal}"StandardLeadTime
Standard leadtime in days for this product from this supplier
": "{Integer}",IsPreferred
Whether this supplier is preferred or not
": "{Boolean}",SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",ConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.
This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.
SupplierLink
Supplier reference
": "{String}"Name
Supplier internal product name
": "{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 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |