Sales APIs
Sales forecast details for provided identifier
| HTTP method | GET |
| 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 | 592, version 17 |
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. |
| $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. |
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.
SalesForecastId
Sales forecast identifier
>{Integer}</SalesForecastId>Status
Status of the sales forecast
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>CustomersReference
Customers reference. Typically a person.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
>{String}</CustomersReferenceNumber>RequestedDeliveryDate
The delivery date as requested by the customer.
>{Date}</RequestedDeliveryDate>CustomersProductName
Customers internal name of the product. Retrieved from the product.
>{String}</CustomersProductName>Source
Source of the sales forecast
Possible domain values can be found here
>{Integer}</Source>Quantity
Number of units ordered
>{Decimal}</Quantity>ProbabilityPercent
Probability of receiving a firm sales order
>{Decimal}</ProbabilityPercent>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of warehouse location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>SalesForecastId
Sales forecast identifier
": "{Integer}",Status
Status of the sales forecast
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",CustomersReference
Customers reference. Typically a person.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
": "{String}",RequestedDeliveryDate
The delivery date as requested by the customer.
": "{Date}",CustomersProductName
Customers internal name of the product. Retrieved from the product.
": "{String}",Source
Source of the sales forecast
Possible domain values can be found here
": "{Integer}",Quantity
Number of units ordered
": "{Decimal}",ProbabilityPercent
Probability of receiving a firm sales order
": "{Decimal}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"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}"LocationId
Location identifier
": "{Integer}",Name
Name of warehouse location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location 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 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |