Data Access Sales lines

Endpoints

Get list of sales lines

/forecast/companies/{companycode}/establishments/{establishmentcode}/data-access/sales-lines

Description

Returns sales lines (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

internalLineNumber
optional

Forecast line internal number

integer (int32)

Query

updateStartDate
optional*

Start of update date

datetime (ISO-8601)

Query

updateEndDate
optional*

End of update date

datetime (ISO-8601)

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

*At least planCode or updateStartDate/updateEndDate is required

Responses

HTTP Code Description Schema

200

Successfull

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

SalesLine

Sales line 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

internalLineNumber
required

Forecast line internal number

integer

actType
required

Sales act type

string within (ORD, DEL)

chrono
required

Sales act chrono

integer

nb1
required

Sales act internal number

integer

itemCode
optional

Item code

string

statUnit1PollutionQuantity
optional

Statistical unit 1 pollution quantity

double

statUnit1Code
optional

Statistical unit 1 code

string

creationDate
optional

Creation date

datetime (ISO-8601)

updateDate
optional

Update date

datetime (ISO-8601)