Sales price

Endpoints

Get list of sales prices from S&OP

/processes/{processcode}/sales-prices

Description

Returns sales prices from S&OP.

Parameters

Type Name Description Schema

Path

processCode
required

Process code

string

Query

onlyForcedSalesPrices
optional

Only forced sales prices ?

boolean

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< GetSalesPricesFromSupply > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Get list of sales prices from VIF Forecast

/forecast/companies/{companycode}/establishments/{establishmentcode}/sales-prices

Description

Returns sales prices from VIF Forecast.

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

string

Query

priceTypeCode
optional

Price type

string

Query

onlyForcedPrices
optional

Only forced prices ?

boolean

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< GetSalesPricesFromForecast > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/sales-prices/import

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Body

body
required

ImportSalesPriceList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

GetSalesPricesFromSupply

Sales price data structure for Get.

Name Description Value

companyCode
optional

string

establishmentCode
optional

string

effectiveDate
required

Effective date

datetime (YYYY-MM-DDTHH:MM:SSZ)

itemCode
required

Item code

string

customerCode
optional

Customer code

string

groupCode
optional

Customer group code

string

groupLevel
optional

Customer group level

integer

groupValueCode
optional

Customer group value code

string

price
optional

Price

double

currencyCode
required

Currency code

string

unitCode
required

Unit code

string

isValidated
optional

True if sales price is validated

boolean

GetSalesPricesFromForecast

Sales price data structure for Get.

Name Description Value

companyCode
optional

string

establishmentCode
optional

string

effectiveDate
required

Effective date

datetime (YYYY-MM-DDTHH:MM:SSZ)

itemCode
required

Item code

string

customerCode
optional

Customer code

string

groupCode
optional

Customer group code

string

groupLevel
optional

Customer group level

integer

groupValueCode
optional

Customer group value code

string

price
optional

Price

double

initialPrice
optional

Initial price

double

currencyCode
required

Currency code

string

unitCode
required

Unit code

string

planCode
required

Forecast plan code

string

priceTypeCode
required

Price type code

string

priceState
required

Price state

string

ImportSalesPriceList

Name Value

callback
optional

string

data
optional

ImportSalesPrice list

parameters
optional

ImportSalesPriceParameters

ImportSalesPrice

Sales price data structure for Import.

Name Description Value Business rules

companyCode
optional

string

2 characters max

establishmentCode
optional

string

2 characters max

effectiveDate
required

Effective date

datetime

YYYY-MM-DDTHH:MM:SSZ

itemCode
required

Item code

string

20 characters max

customerCode
optional

Customer code

string

10 characters max

groupCode
optional

Customer group code

string

10 characters max

groupLevel
optional

Customer group level

integer

groupValueCode
optional

Customer group value code

string

20 characters max

price
optional

Price

double

currencyCode
required

Currency code

string

3 characters max

unitCode
required

Unit code

string

5 characters max

ImportSalesPriceParameters

Sales price parameters structure for Import.

Name Description Value

deleteBeforeImport
optional

Delete sales prices of the scope before import ?

boolean

priceTypeCode
required

Price type code

string