Currency conversion

Endpoints

Create new currency conversion

/companies/{companycode}/currency-conversions

Description

Returns created currency conversion.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

CurrencyConversionDTO

Responses

HTTP Code Description Schema

201

Successfully created

CurrencyConversionDTO

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/currency-conversions

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company 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

< CurrencyConversionDTO > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/currency-conversions/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportCurrencyConversionList

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 conversion

/companies/{companycode}/currency-conversions/{effectdate}/{currency1}/{currency2}

operation.deprecated

Description

Returns retrieved currency conversion.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

currency1
required

First currency code

string

3 characters max

Path

currency2
required

Second currency ode

string

3 characters max

Path

effectDate
required

Effective date

string (date)

YYYY-MM-DDTHH:MM:SSZ

Responses

HTTP Code Description Schema

200

Successful

CurrencyConversionDTO

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete currency conversion

/companies/{companycode}/currency-conversions/{effectdate}/{currency1}/{currency2}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

currency1
required

First currency public uuid code

string

3 characters max

Path

currency2
required

Second currency public uuid code

string

3 characters max

Path

effectDate
required

Effective date

string (date)

YYYY-MM-DDTHH:MM:SSZ

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

CurrencyConversionDTO

Name Description Value Business Rules

coefficient1
required

First currency coefficient

double

coefficient2
required

Second currency coefficient

double

companyCode
required

Current company code

string

2 characters max

currency1
required

First currency code

string

3 characters max

currency2
required

Second currency code

string

3 characters max

effectDate
required

Conversion effect date

date

YYYY-MM-DDTHH:MM:SSZ

ImportCurrencyConversionList

Name Value

callback
optional

string

data
optional

CurrencyConversionDTO list