Data Access Sales forecasts

Endpoints

Get list of sales forecasts from VIF Forecast

/forecast/companies/{companycode}/establishments/{establishmentcode}/plans/{planCode}/versions/{versionCode}/periods/{period}/data-access/sales-forecasts

Description

Returns sales forecasts (conditional on the Data Access offer).

Parameters

Type Name Description Schema Business rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Path

planCode
required

Forecast plan

string

10 characters max

Path

versionCode
required

Forecast version

string

10 characters max

Path

period
required

Period size

string

within (DAY, WEEK, WEEK_OF_MONTH, MONTH)

Query

referenceDate
optional

Reference date

string

within (VERSION_START_DATE = export forecasts from the version start date, TODAY_DATE = export forecasts from the today date).

If TODAY_DATE and "period" is WEEK or WEEK_OF_MONTH, then start at the first day of the current week.

If TODAY_DATE and "period" is MONTH, then start at the first day of the current month

Query

nbPeriods
optional

Number of periods (if it’s not necessary to export all periods : export only first periods)

integer (int32)

Number of periods in WEEK or MONTH according to "period" value

Query

afterNbPeriods
optional

Beyond a number of periods (if it’s not necessary to export all periods : export only periods beyond a number of periods)

integer (int32)

Number of periods in WEEK or MONTH according to "period" value

Query

siteCode
optional

Site code

string

Query

levelOfDetail
optional

Level of detail

string

within (ITEM, FORECAST_LINE_ITEM) :

ITEM = by item
FORECAST_LINE_ITEM = by forecast line and item

Query

withZeroForecast
optional

True if it’s necessary to export forecast at 0

boolean

Query

withStatUnits
optional

True if it’s necessary to export quantities in statistical units

boolean

Query

withDiscounts
optional

True if it’s necessary to export discount amounts

boolean

Query

withCosts
optional

True if it’s necessary to export cost amounts

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

403

Not allowed without Data Access offer

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

GetSalesForecasts

Sales forecast data structure for Get.

Name Description Value Business rules

companyCode
optional

string

2 characters max

establishmentCode
optional

string

2 characters max

planCode
required

Forecast plan

string

10 characters max

versionCode
required

Version code

string

10 characters max

internalLineNumber
required

Internal line number

integer

itemCode
required

Item code

string

20 characters max

siteCode
optional

Site code

string

10 characters max

forecasts
optional

Forecasts

Forecast list

Forecast

Name Description Value Business rules

startDate
required

Start date

datetime

YYYY-MM-DDTHH:MM:SSZ

endDate
required

End date

datetime

YYYY-MM-DDTHH:MM:SSZ

quantity
optional

Quantity

double

computedQuantity
optional

Computed quantity

double

eventQuantity
optional

Event quantity

double

promotionQuantity
optional

Promotional quantity

double

eventPromotionQuantity
optional

Event promotional quantity

double

unitCode
optional

Unit code

string

5 characters max

quantityStatUnit1
optional

Quantity in statistical unit 1

double

computedQuantityStatUnit1
optional

Computed quantity in statistical unit 1

double

eventQuantityStatUnit1
optional

Event quantity in statistical unit 1

double

promotionQuantityStatUnit1
optional

Promotional quantity in statistical unit 1

double

eventPromotionQuantityStatUnit1
optional

Event promotional quantity in statistical unit 1

double

statUnitCode1
optional

Statistical unit code 1

string

5 characters max

quantityStatUnit2
optional

Quantity in statistical unit 2

double

computedQuantityStatUnit2
optional

Computed quantity in statistical unit 2

double

eventQuantityStatUnit2
optional

Event quantity in statistical unit 2

double

promotionQuantityStatUnit2
optional

Promotional quantity in statistical unit 2

double

eventPromotionQuantityStatUnit2
optional

Event promotional quantity in statistical unit 2

double

statUnitCode2
optional

Statistical unit code 2

string

5 characters max

quantityStatUnit3
optional

Quantity in statistical unit 3

double

computedQuantityStatUnit3
optional

Computed quantity in statistical unit 3

double

eventQuantityStatUnit3
optional

Event quantity in statistical unit 3

double

promotionQuantityStatUnit3
optional

Promotional quantity in statistical unit 3

double

eventPromotionQuantityStatUnit3
optional

Event promotional quantity in statistical unit 3

double

statUnitCode3
optional

Statistical unit code 3

string

5 characters max

quantityStatUnit4
optional

Quantity in statistical unit 4

double

computedQuantityStatUnit4
optional

Computed quantity in statistical unit 4

double

eventQuantityStatUnit4
optional

Event quantity in statistical unit 4

double

promotionQuantityStatUnit4
optional

Promotional quantity in statistical unit 4

double

eventPromotionQuantityStatUnit4
optional

Event promotional quantity in statistical unit 4

double

statUnitCode4
optional

Statistical unit code 4

string

5 characters max

amount
optional

Amount

double

currencyCode
optional

Currency code

string

3 characters max

discountAmount1
optional

Discount amount 1

double

discountAmount2
optional

Discount amount 2

double

discountAmount3
optional

Discount amount 3

double

discountAmount4
optional

Discount amount 4

double

discountAmount5
optional

Discount amount 5

double

discountAmount6
optional

Discount amount 6

double

discountAmount7
optional

Discount amount 7

double

discountAmount8
optional

Discount amount 8

double

discountAmount9
optional

Discount amount 9

double

discountAmount10
optional

Discount amount 10

double

costAmount1
optional

Cost amount 1

double

costAmount2
optional

Cost amount 2

double

costAmount3
optional

Cost amount 3

double

costAmount4
optional

Cost amount 4

double

costAmount5
optional

Cost amount 5

double

costAmount6
optional

Cost amount 6

double

costAmount7
optional

Cost amount 7

double

costAmount8
optional

Cost amount 8

double

costAmount9
optional

Cost amount 9

double

costAmount10
optional

Cost amount 10

double