Currency

Endpoints

Create new currency

/currencies

Description

Returns created currency.

Parameters

Type Name Schema

Body

body
required

Currency

Responses

HTTP Code Description Schema

201

Successfully created

Currency

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/currencies

Description

Returns entities.

Parameters

Type Name Description Schema

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Currency > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/currencies/import

Parameters

Type Name Schema

Body

body
required

ImportCurrencyList

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 currency

/currencies/{code}

operation.deprecated

Description

Returns retrieved currency.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

3 characters max

Responses

HTTP Code Description Schema

200

Successful

Currency

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete currency

/currencies/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

3 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

Currency

Currency data structure.

Name Description Value Business Rules

code
required

Currency code

string

3 characters max

label
required

Currency label

string

50 characters max

nbDecimals
required

Decimals number

integer

publicUuid
optional
read-only

Currency public uuid

string

symbol
optional

Symbol

string

3 characters max

validityEndDate
optional

Validity end date

datetime

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

ImportCurrencyList

Name Value

callback
optional

string

data
optional

Currency list