Forecast line

Endpoints

Get list of forecast lines

/forecast/companies/{companycode}/establishments/{establishmentcode}/forecast-lines

Description

Returns forecast lines.

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

Query

planCode
optional

Plan code

string

10 characters max

Query

internalLineNumber
optional

Internal line number

integer (int32)

Query

state
optional

State

string

within (PRG, CAN) :

PRG = In progress
CAN = Canceled

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< ForecastLine > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

ForecastLine

Forecast line data structure for Get.

Name Description Value Business rules

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

planCode
required

Plan code

string

10 characters max

internalLineNumber
required

Internal line number

integer (int32)

lineNumber
required

Line number

integer (int32)

state
optional

State

string

within (PRG, CAN) :

PRG = In progress
CAN = Canceled

custDesc
optional

Customer description

string

50 characters max

custHierarchyCode
optional

Customer hierarchy code

string

10 characters max

custHierarchyLevel
optional

Customer hierarchy level

integer (int32)

custHierarchyValue
optional

Customer hierarchy value code

string

20 characters max

customerCode
optional

Customer code

string

10 characters max

itemtDesc
optional

Item description

string

50 characters max

itemHierarchyCode
optional

Item hierarchy code

string

10 characters max

itemHierarchyLevel
optional

Item hierarchy level

integer (int32)

itemHierarchyValue
optional

Item hierarchy value code

string

20 characters max

items
optional

Items

Item list

creationDate
required

Creation date

datetime (ISO-8601)

updateDate
required

Update date

datetime (ISO-8601)

unitCode
required

Unit code

string

5 characters max

hierarchies
optional

GroupLink list

Item

Item data structure.

Name Description Value Business rules

itemCode
required

Item code

string

20 characters max