Procurement APIs
Update provided sales forecast
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/forecasts/{salesForecastId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesForecastId} |
Sales forecast identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3284, version 4 |
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.
SalesForecast
This field is optional.
>CustomersReference
Customers reference. Typically a person.
This field is optional.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
>{String}</CustomersReferenceNumber>RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
>{Date}</RequestedDeliveryDate>CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
>{String}</CustomersProductName>Source
Source of the sales forecast
Applicable domain values can be found here
This field is optional.
>{Integer}</Source>Quantity
Number of units ordered
Minimum value: 0
This field is optional.
>{Decimal}</Quantity>ProbabilityPercent
Probability of receiving a firm sales order
Minimum value: 0
Maximum value: 100
This field is optional.
>{Decimal}</ProbabilityPercent>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Product
This field is optional.
>ProductId
Product identifier
Minimum value: 10000
This field is optional.
>{Integer}</ProductId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>SalesForecast
This field is optional.
": {CustomersReference
Customers reference. Typically a person.
This field is optional.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
": "{String}",RequestedDeliveryDate
The delivery date as requested by the customer.
This field is optional.
": "{Date}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
This field is optional.
": "{String}",Source
Source of the sales forecast
Applicable domain values can be found here
This field is optional.
": "{Integer}",Quantity
Number of units ordered
Minimum value: 0
This field is optional.
": "{Decimal}",ProbabilityPercent
Probability of receiving a firm sales order
Minimum value: 0
Maximum value: 100
This field is optional.
": "{Decimal}",Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Product
This field is optional.
": {ProductId
Product identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
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.
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 100167 HTTP 404 | Measurement unit not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |
| Error 104020 HTTP 400 | You can not use this type of product |