Data Access Sales history

Endpoints

Get list of sales history

/forecast/companies/{companycode}/establishments/{establishmentcode}/start-date/{startDate}/end-date/{endDate}/plans/{planCode}/data-access/sales-history

Description

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

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Query

planCode
optional*

Forecast plan code

string

Query

lineNumber
optional

Forecast line number

integer (int32)

Query

startDate
optional*

Start of date

datetime (ISO-8601)

Query

endDate
optional*

End of date

datetime (ISO-8601)

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Query

sizeOverride
optional

Entity count per page for wide view

integer (int32)

*At least planCode and startDate/endDate are required

Responses

HTTP Code Description Schema

200

Successfull

< SalesHistory > 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

SalesHistory

Sales history data structure for Get.

Name Description Value

companyCode
optional

Current company code

string

establishmentCode
optional

Current establishment code

string

planCode
required

Forecast plan code

string

lineNumber
required

Forecast line number

integer

startDate
required

Start date

datetime (ISO-8601)

endDate
required

End date

datetime (ISO-8601)

salesQuantity
required

Sales quantity

double

readjustedQuantity
required

Readjusted quantity

double