Import baseline quantities parameters

Directory

/data/sales-forecasts

Files reference

  • filename : header

Other parameters

Context (companyCode, establishmentCode, planCode and horizonCode)

The import is set by a context defined by the company code (companyCode), the establishment code (establishmentCode), the forecast plan code (planCode) and the horizon code (horizonCode)

Files content

Data structure

Field Column Data type Required Business rules

Item code

itemCode

String

X

20 characters max

Customer code

customerCode

String

10 characters max

Customer group code

groupCode

String

10 characters max

Customer group level

groupLevel

Integer

Customer group value code

groupValueCode

String

20 characters max

Start date

startDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

End date

endDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

Baseline quantity

baselineQuantity

Double

Unit code

unitCode

String

X

5 characters max

Comment

comment

String

1000 characters max

Example

itemCode;customerCode;groupCode;groupLevel;groupValueCode;startDate;endDate;baselineQuantity;unitCode
ART1;;01;1;01;2014-05-21T00:00:00Z;2014-05-28T00:00:00Z;100.0;KG
ART2;02;;;;2014-05-22T00:00:00Z;2014-05-29T00:00:00Z;150.0;COL

Export sales forecasts parameters

Directory

/data/export/sales-forecasts

Files reference

  • filename : header

Other parameters

Context (companyCode, establishmentCode, horizonCode and period)

The export is set by a context defined by the company code (companyCode), the establishment code (establishmentCode), the horizon code (horizonCode) and the period size (period)

Optional parameters

  • forecastPlans : list of forecast plans

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

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

  • siteCode : site code (only sales forecasts of a site)

  • levelOfDetail : within (ITEM = by item, FORECAST_LINE_ITEM = by forecast line and item)

  • withZeroForecast : true if it’s necessary to export forecast at 0

  • withStatUnits : true if it’s necessary to export quantities in statistical units

  • withDiscounts : true if it’s necessary to export discount amounts

  • withCosts : true if it’s necessary to export cost amounts

Files content

Header

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Version code

versionCode

String

Internal line number

internalLineNumber

Integer

only if levelOfDetail = FORECAST_LINE_ITEM

Item code

itemCode

String

Site code

siteCode

String

Start date

startDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

End date

endDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Quantity

quantity

Double

Computed quantity

computedQuantity

Double

Event quantity

eventQuantity

Double

Promotional quantity

promotionQuantity

Double

Unit code

unitCode

String

Quantity in statistical unit 1

quantityStatUnit1

Double

only if withStatUnits = true

Computed quantity in statistical unit 1

computedQuantityStatUnit1

Double

only if withStatUnits = true

Event quantity in statistical unit 1

eventQuantityStatUnit1

Double

only if withStatUnits = true

Promotional quantity in statistical unit 1

promotionQuantityStatUnit1

Double

only if withStatUnits = true

Statistical unit code 1

statUnitCode1

String

only if withStatUnits = true

Quantity in statistical unit 2

quantityStatUnit2

Double

only if withStatUnits = true

Computed quantity in statistical unit 2

computedQuantityStatUnit2

Double

only if withStatUnits = true

Event quantity in statistical unit 2

eventQuantityStatUnit2

Double

only if withStatUnits = true

Promotional quantity in statistical unit 2

promotionQuantityStatUnit2

Double

only if withStatUnits = true

Statistical unit code 2

statUnitCode2

String

only if withStatUnits = true

Quantity in statistical unit 3

quantityStatUnit3

Double

only if withStatUnits = true

Computed quantity in statistical unit 3

computedQuantityStatUnit3

Double

only if withStatUnits = true

Event quantity in statistical unit 3

eventQuantityStatUnit3

Double

only if withStatUnits = true

Promotional quantity in statistical unit 3

promotionQuantityStatUnit3

Double

only if withStatUnits = true

Statistical unit code 3

statUnitCode3

String

only if withStatUnits = true

Quantity in statistical unit 4

quantityStatUnit4

Double

only if withStatUnits = true

Computed quantity in statistical unit 4

computedQuantityStatUnit4

Double

only if withStatUnits = true

Event quantity in statistical unit 4

eventQuantityStatUnit4

Double

only if withStatUnits = true

Promotional quantity in statistical unit 4

promotionQuantityStatUnit4

Double

only if withStatUnits = true

Statistical unit code 4

statUnitCode4

String

only if withStatUnits = true

Amount

amount

Double

Currency code

currencyCode

String

Discount amount 1

discountAmount1

Double

only if withDiscounts = true

Discount amount 2

discountAmount2

Double

only if withDiscounts = true

Discount amount 3

discountAmount3

Double

only if withDiscounts = true

Discount amount 4

discountAmount4

Double

only if withDiscounts = true

Discount amount 5

discountAmount5

Double

only if withDiscounts = true

Discount amount 6

discountAmount6

Double

only if withDiscounts = true

Discount amount 7

discountAmount7

Double

only if withDiscounts = true

Discount amount 8

discountAmount8

Double

only if withDiscounts = true

Discount amount 9

discountAmount9

Double

only if withDiscounts = true

Discount amount 10

discountAmount10

Double

only if withDiscounts = true

Cost amount 1

costAmount1

Double

only if withCosts = true

Cost amount 2

costAmount2

Double

only if withCosts = true

Cost amount 3

costAmount3

Double

only if withCosts = true

Cost amount 4

costAmount4

Double

only if withCosts = true

Cost amount 5

costAmount5

Double

only if withCosts = true

Cost amount 6

costAmount6

Double

only if withCosts = true

Cost amount 7

costAmount7

Double

only if withCosts = true

Cost amount 8

costAmount8

Double

only if withCosts = true

Cost amount 9

costAmount9

Double

only if withCosts = true

Cost amount 10

costAmount10

Double

only if withCosts = true

Customer description

custDesc

String

only if levelOfDetail = FORECAST_LINE_ITEM

Customer hierarchy code

custHierarchyCode

String

only if levelOfDetail = FORECAST_LINE_ITEM

Customer hierarchy level

custHierarchyLevel

Integer

only if levelOfDetail = FORECAST_LINE_ITEM

Customer hierarchy value code

custHierarchyValue

String

only if levelOfDetail = FORECAST_LINE_ITEM

Customer code

customerCode

String

only if levelOfDetail = FORECAST_LINE_ITEM