API

Procurement APIs

GET sales/forecasts

List of sales forecasts

HTTP method GET
URI https://api.rambase.net/sales/forecasts
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 586, version 18

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.

Format:
1
1

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.

Active() Named filter Active sales forecasts (status 4)
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
CustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
ForwardedToSalesOrder Boolean True if sales order is created, false if not.
LocationId Integer Location identifier.
ProbabilityPercent Decimal Probability of receiving a firm sales order.
ProductId Integer Product identifier.
ProductName String Name of the product.
Quantity Decimal Number of units ordered.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesForecastId Integer Sales forecast identifier.
Source Integer Source of the sales forecast.
Status Integer Status of the sales forecast.

Read more about filters and sorting on how to use sortable parameters

CreatedAt Datetime Date and time of creation
CustomerId Integer Customer identifier
CustomersProductName String Customers internal name of the product. Retrieved from the product.
CustomersReference String Customers reference. Typically a person.
CustomersReferenceNumber String Customers reference number. E.g. the internal sales order id the customer use in their own system.
CustomField1 String Custom field for grouping, sorting, categorizing and other purposes.
CustomField2 String Custom field for grouping, sorting, categorizing and other purposes.
ForwardedToSalesOrder Boolean True if sales order is created, false if not
LocationId Integer Location identifier
ProbabilityPercent Decimal Probability of receiving a firm sales order
ProductId Integer Product identifier
ProductName String Name of the product
Quantity Decimal Number of units ordered
RequestedDeliveryDate Date The delivery date as requested by the customer.
SalesForecastId Integer Sales forecast identifier
Source Integer Source of the sales forecast
Status Integer Status of the sales forecast

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.

Format:
1
<SalesForecasts>
2
     <SalesForecast>
3
          <SalesForecastId
SalesForecastId

Sales forecast identifier

>{Integer}</SalesForecastId>
4
          <Status
Status

Status of the sales forecast

Possible domain values can be found here

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <CustomersReference
CustomersReference

Customers reference. Typically a person.

>{String}</CustomersReference>
7
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

>{String}</CustomersReferenceNumber>
8
          <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
9
          <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
10
          <Source
Source

Source of the sales forecast

Possible domain values can be found here

>{Integer}</Source>
11
          <Quantity
Quantity

Number of units ordered

>{Decimal}</Quantity>
12
          <ProbabilityPercent
ProbabilityPercent

Probability of receiving a firm sales order

>{Decimal}</ProbabilityPercent>
13
          <Customer>
14
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
15
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
16
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
17
          </Customer>
18
          <Product>
19
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
20
               <Name
Name

Name of the product

>{String}</Name>
21
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
22
               <Description
Description

Description of the product

>{String}</Description>
23
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
24
          </Product>
25
          <Location>
26
               <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
27
               <Name
Name

Name of warehouse location

>{String}</Name>
28
               <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
29
               <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
30
          </Location>
31
          <SalesOrderItem
SalesOrderItem

Item this item was forwarded to.

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>
32
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>{Integer}</SalesOrderItemId>
33
               <SalesOrder
SalesOrder

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>
34
                    <SalesOrderId
SalesOrderId

Sales order identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>{Integer}</SalesOrderId>
35
                    <SalesOrderLink
SalesOrderLink

Sales order reference

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>{String}</SalesOrderLink>
36
               </SalesOrder>
37
               <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

>{String}</SalesOrderItemLink>
38
          </SalesOrderItem>
39
          <SalesForecastLink
SalesForecastLink

Sales forecast reference

>{String}</SalesForecastLink>
40
     </SalesForecast>
41
     <Paging
Paging

Detailed paging information for this list.

>
42
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
43
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
44
          <Page
Page

Page index

>{Integer}</Page>
45
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
46
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
47
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
48
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
49
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
50
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
51
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
52
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
53
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
54
     </Paging>
55
</SalesForecasts>
1
{
2
     "salesForecasts": [
3
          {
4
               "salesForecastId
SalesForecastId

Sales forecast identifier

": "{Integer}",
5
               "status
Status

Status of the sales forecast

Possible domain values can be found here

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "customersReference
CustomersReference

Customers reference. Typically a person.

": "{String}",
8
               "customersReferenceNumber
CustomersReferenceNumber

Customers reference number. E.g. the internal sales order id the customer use in their own system.

": "{String}",
9
               "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
10
               "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
11
               "source
Source

Source of the sales forecast

Possible domain values can be found here

": "{Integer}",
12
               "quantity
Quantity

Number of units ordered

": "{Decimal}",
13
               "probabilityPercent
ProbabilityPercent

Probability of receiving a firm sales order

": "{Decimal}",
14
               "customer": {
15
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
16
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
17
                    "customerLink
CustomerLink

Customer reference

": "{String}"
18
               },
19
               "product": {
20
                    "productId
ProductId

Product identifier

": "{Integer}",
21
                    "name
Name

Name of the product

": "{String}",
22
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
23
                    "description
Description

Description of the product

": "{String}",
24
                    "productLink
ProductLink

Product reference

": "{String}"
25
               },
26
               "location": {
27
                    "locationId
LocationId

Location identifier

": "{Integer}",
28
                    "name
Name

Name of warehouse location

": "{String}",
29
                    "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
30
                    "locationLink
LocationLink

Location reference

": "{String}"
31
               },
32
               "salesOrderItem
SalesOrderItem

Item this item was forwarded to.

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": {
33
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": "{Integer}",
34
                    "salesOrder
SalesOrder

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": {
35
                         "salesOrderId
SalesOrderId

Sales order identifier

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": "{Integer}",
36
                         "salesOrderLink
SalesOrderLink

Sales order reference

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": "{String}"
37
                    },
38
                    "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

This field is greyed out because it is an expandable field. You have to add $expand=SalesForecast.SalesOrderItem in your request URI to get this field

": "{String}"
39
               },
40
               "salesForecastLink
SalesForecastLink

Sales forecast reference

": "{String}"
41
          }
42
     ],
43
     "paging
Paging

Detailed paging information for this list.

": {
44
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
45
          "position
Position

Position of the first element in the list

": "{Integer}",
46
          "page
Page

Page index

": "{Integer}",
47
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
48
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
49
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
50
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
51
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
52
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
53
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
54
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
55
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
56
     }
57
}

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