API

Sales APIs

PUT sales/forecasts/{salesForecastId}

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.

Format:
1
<SalesForecast
SalesForecast

This field is optional.

>
2
     <CustomersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

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

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

This field is optional.

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

The delivery date as requested by the customer.

This field is optional.

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

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

This field is optional.

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

Source of the sales forecast

Applicable domain values can be found here

This field is optional.

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

Number of units ordered

Minimum value: 0

This field is optional.

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

Probability of receiving a firm sales order

Minimum value: 0

Maximum value: 100

This field is optional.

>{Decimal}</ProbabilityPercent>
9
     <Customer
Customer

This field is optional.

>
10
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
11
     </Customer>
12
     <Product
Product

This field is optional.

>
13
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
14
     </Product>
15
     <Location
Location

This field is optional.

>
16
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
17
     </Location>
18
</SalesForecast>
1
{
2
     "salesForecast
SalesForecast

This field is optional.

": {
3
          "customersReference
CustomersReference

Customers reference. Typically a person.

This field is optional.

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

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

This field is optional.

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

The delivery date as requested by the customer.

This field is optional.

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

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

This field is optional.

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

Source of the sales forecast

Applicable domain values can be found here

This field is optional.

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

Number of units ordered

Minimum value: 0

This field is optional.

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

Probability of receiving a firm sales order

Minimum value: 0

Maximum value: 100

This field is optional.

": "{Decimal}",
10
          "customer
Customer

This field is optional.

": {
11
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
12
          },
13
          "product
Product

This field is optional.

": {
14
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
15
          },
16
          "location
Location

This field is optional.

": {
17
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
18
          }
19
     }
20
}

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.

Format:
1
1

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