Currencies API

Manage currencies — retrieve, create, update and delete

Base URL

https://{tenant}.logzi.com/api/currency/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/currency/get

Retrieve a single currency — by identifier, ISO code, or default status.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the currency
cr_defaultint1 = retrieve the default currency
cr_name_shortstringSearch by ISO code (e.g. "HUF", "EUR")

Example request

GET /api/currency/get?cr_name_short=HUF
X-API-KEY: {your_api_key}
GET /api/currency/list

Retrieve a paginated list of all currencies.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionarrayArray of filter conditions

Example request

GET /api/currency/list?list_offset=0
X-API-KEY: {your_api_key}
POST /api/currency/save

Create or update a currency. For a new record use data[id] = 0.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new currency, >0 = update
cr_namestringFull currency name (e.g. "Forint")
cr_name_shortstringISO code (e.g. "HUF", "EUR")
cr_signstringCurrency sign (e.g. "Ft", "€")
cr_defaultint1 = mark as the default currency
cr_round_idintRounding rule identifier

Example request

POST /api/currency/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "cr_name": "Forint",
    "cr_name_short": "HUF",
    "cr_sign": "Ft",
    "cr_default": 1
  }
}
POST /api/currency/delete

Delete a currency by its identifier.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the currency to delete

Example request

POST /api/currency/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 2 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!