Actual sales

Endpoints

Import entity list

/companies/{companycode}/actual-sales/import

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Body

body
required

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

ActualSales

Actual sales data structure.

Name Description Value Business rules

amount
optional

Amount

double

companyCode
required

Current company code

string

2 characters max

currencyCode
optional

Currency code

string

3 characters max

customerCode
optional

Customer code

string

10 characters max

depositCode
optional

Deposit code

string

10 characters max

endDate
required

End date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

establishmentCode
required

Current establishment code

string

2 characters max

firstBaselineQuantity
optional

First baseline quantity

double

firstPromotionalQuantity
optional

First promotional quantity

double

firstUnitCode
optional

First unit code

string

5 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

itemCode
required

Item code

string

20 characters max

secondBaselineQuantity
optional

Second baseline quantity

double

secondPromotionalQuantity
optional

Second promotional quantity

double

secondUnitCode
optional

Second unit code

string

5 characters max

startDate
required

Start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

ImportActualSalesList

Name Value

callback
optional

string

data
optional

parameters
optional

ActualSalesParameters

Actual sales parameters structure.

Name Description Value

dateType
required

Date type

string (LAST_MONTH, CUSTOM)

deleteBeforeImport
optional

Delete actual sales of the scope before import ?

boolean

endDate
optional

End date

datetime (ISO-8601)

establishmentCode
optional

Establishment code

string

startDate
optional

Start date

datetime (ISO-8601)