Loss reason

Endpoints

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/loss-reasons

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

< Loss reason > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Loss reason

Loss reason data structure.

Name Description Value Business Rules

code
required

Loss reason code

String

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

companyCode
required

Current company code

String

2 characters max

deductedFromDone
required

boolean

false by default

establishmentCode
required

Current establishment code

String

2 characters max

hierarchies
optional

Hierarchy list

imageCode
optional

Image code

String

label
required

Loss reason label

String

50 characters max

publicUuid
optional
read-only

Loss reason public uuid

String

tags
required

Tag list

validityEndDate
optional

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

Hierarchy

Name Description Value Business Rules

code
mandatory

String

10 characters max

value
mandatory

String

establishmentCode
optional

String

2 characters

Tag

Name Description Value Business Rules

code
mandatory

String

10 characters max

label
mandatory

String

50 characters max

establishmentCode
optional

String

2 characters