Deposit

Endpoints

Create new deposit

/companies/{companycode}/establishments/{establishmentcode}/deposits

Description

Returns created deposit.

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}/deposits

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}/deposits/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 deposit

/companies/{companycode}/establishments/{establishmentcode}/deposits/{code}

operation.deprecated

Description

Returns retrieved deposit.

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 deposit

/companies/{companycode}/establishments/{establishmentcode}/deposits/{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

Data structure

Deposit

Deposit data structure.

Name Description Value Business Rules

code
required

Deposit 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

establishmentCode
required

Current establishment code

string

2 characters max

label
required

Deposit label

string

50 characters max

publicUuid
optional
read-only

Deposit public uuid

string

validityEndDate
optional

Validity end date

datetime (ISO-8601)

AAAA-MM-JJTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportDepositList

Name Value

callback
optional

string

data
optional

Deposit list