Discount type

Endpoints

Create new discount type

/companies/{companycode}/establishments/{establishmentcode}/discount-types

Description

Returns created discount type.

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

Body

body
required

CodeLabelValidity

Responses

HTTP Code Description Schema

201

Successfully created

CodeLabelValidity

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/discount-types

Description

Returns entities.

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

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< CodeLabelValidity > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/discount-types/import

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

Body

body
required

ImportCodeLabelValidityList

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

Get one discount type

/companies/{companycode}/establishments/{establishmentcode}/discount-types/{code}

operation.deprecated

Description

Returns retrieved discount type.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

CodeLabelValidity

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete discount type

/companies/{companycode}/establishments/{establishmentcode}/discount-types/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/discounts/import

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

Body

body
required

ImportDiscountList

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

ImportDiscountList

Name Value

callback
optional

string

data
optional

Discount list

parameters
optional

DiscountParameters

Discount

Discount data structure.

Name Description Value Business Rules

companyCode
optional

string

2 characters max

currencyCode
optional

Currency code

string

customerCode
optional

Customer code

string

discountNatureCode
required

Discount nature code

string

effectiveDate
required

Effective date

datetime (ISO-8601)

establishmentCode
optional

string

2 characters max

groupCode
optional

Customer group code

string

groupLevel
optional

Customer group level

integer

groupValueCode
optional

Customer group value code

string

itemCode
required

Item code

string

percent
optional

Percent

double

price
optional

Price

double

unitCode
optional

Unit code

string

DiscountParameters

Dsicount parameters structure.

Name Description Value Business Rules

deleteBeforeImport
optional

Delete discounts of the scope before import ?

boolean

discountTypeCode
required

Discount type code

string