CodeLabelValidity

Entity data structure.

Name Description Value

code
required

Entity code

string

companyCode
required

Current company code

string

establishmentCode
required

Current establishment code

string

label
required

Entity label

string

publicUuid
optional
read-only

Entity public uuid

string

validityEndDate
optional

datetime (ISO-8601)

CodeLabel

Entity data structure.

Name Description Value

code
required

Entity code

string

label
required

Entity label

string

ContextOfUse

Name Value

contextCode
optional

string

priority
optional

integer

ImportCodeLabelValidityList

Name Value

callback
optional

string

data
optional

CodeLabelValidity list

Group

Description of an entity group.

Name Description Value

code
required

Group code

string

companyCode
required

Current company code

string

description

This operation is deprecated

optional

string

entityCodeOnly
optional

boolean

establishmentCode
optional

required if "establishmentReservation" is true

Current establishment code

string

establishmentReservation
optional

boolean

label
required

Group label

string

levels
optional

GroupLevel list

mandatory
optional

boolean

publicUuid
optional
read-only

Entity group public uuid

string

tag
optional

boolean

validityEndDate
optional

datetime (ISO-8601)

values
optional

GroupValue list

GroupLevel

Name Description Value

label
required

Level label

string

level
required

Level depth

integer

GroupValue

Name Description Value

code
required

Value code

string

companyCode
required

Current company code

string

establishmentCode
optional

string

label
required

Value label

string

labels
optional

Translation labels (only for Item, Customer and Resource groups)

TranslationLabel list

level
required

Value depth

integer

upperValue
required

Father value code

string

GroupLink

Name Value

code
optional

string

establishmentCode
optional

string

value
optional

string

KeyValue

Name Value

key
optional

string

value
optional

string

Tag

Description of an entity tag.

Name Description Value

code
required

Group code

string

companyCode
required

Current company code

string

establishmentCode
required

Current establishment code

string

description
optional

string

establishmentReservation
optional

boolean

tag
optional

boolean

values
optional

TagValue list

TagValue

Name Description Value

code
required

Value code

string

companyCode
required

Current company code

string

establishmentCode
optional

Current establishment code

string

label
required

Value label

string

TagLink

Name Value

code
optional

string

establishmentCode
optional

string

label
optional

string

TranslationLabel

Name Value Business Rules

language
required

string

2 characters max (FR, EN, ES or PT)

label
required

string

50 characters max