Currency
INFO
Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.
GET /currency/get-all
Get all currencies
Request body
No request body.
Response
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": [
{
"completely_deleted": false,
"code": "string",
"created_at": "2025-05-01T12:00:00Z",
"is_deleted": false,
"is_main": false,
"name": "string",
"side": "start",
"symbol": "string",
"updated_at": "2025-05-01T12:00:00Z",
"values": {
"to_currency_id": "string",
"value": 0,
"name": "string",
"numerator": 0,
"denominator": 0
}
}
],
"time": "2025-05-01T12:00:00Z"
}GET /currency/get-main
Get the main (default) currency of the tenant.
Request body
No request body.
Response
| Field | Type | Description |
|---|---|---|
completely_deleted | boolean | |
code | string | |
created_at | string (date-time) | |
is_deleted | boolean | |
is_main | boolean | |
name | string | |
side | string | One of: start, end |
symbol | string | |
updated_at | string (date-time) | |
values | object | |
values.to_currency_id | string | |
values.value | number | |
values.name | string | |
values.numerator | number | |
values.denominator | number |
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"completely_deleted": false,
"code": "string",
"created_at": "2025-05-01T12:00:00Z",
"is_deleted": false,
"is_main": false,
"name": "string",
"side": "start",
"symbol": "string",
"updated_at": "2025-05-01T12:00:00Z",
"values": {
"to_currency_id": "string",
"value": 0,
"name": "string",
"numerator": 0,
"denominator": 0
}
},
"time": "2025-05-01T12:00:00Z"
}GET /currency/get-by-id/{id}
Get a currency by its _id.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
Request body
No request body.
Response
Same response shape as GET /currency/get-main.
GET /currency/get-to-local
Get the conversion rate from a source currency to the local (main) currency.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
currency_id | string | Yes | |
amount | number | No |
Request body
No request body.
Response
| Field | Type | Description |
|---|---|---|
from_currency_id | string | |
to_currency_id | string | |
rate | number | |
converted_amount | number |
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"from_currency_id": "string",
"to_currency_id": "string",
"rate": 0,
"converted_amount": 0
},
"time": "2025-05-01T12:00:00Z"
}This page is generated from the OpenAPI spec.