Sales forecasts

Endpoints

Get list of sales forecasts from SCP

/processes/{processcode}/sales-forecasts

Description

Returns sales forecasts.

Parameters

Type Name Description Schema

Path

processCode
required

Process code

string

Query

onlyForcedSalesForecasts
optional

Only forced sales forecasts ?

boolean

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< GetSalesForecasts > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

GetSalesForecasts

Sales forecast data structure for Get.

Name Description Value

companyCode
optional

string

establishmentCode
optional

string

itemCode
required

Item code

string

customerCode
optional

Customer code

string

groupCode
optional

Customer group code

string

groupLevel
optional

Customer group level

integer

groupValueCode
optional

Customer group value code

string

startDate
required

Start date

datetime (YYYY-MM-DDTHH:MM:SSZ)

endDate
required

End date

datetime (YYYY-MM-DDTHH:MM:SSZ)

baselineQuantity
optional

Baseline quantity

double

promotionalQuantity
optional

Promotional quantity

double

projectQuantity
optional

Project quantity

double

unitCode
optional

Unit code

string

isValidated
optional

True if sales forecast is validated

boolean