Get

[POST] .../v1/currency/get

Returns information about currency. Use this method to list currencies for document pricing, payment accounts, exchange-rate maintenance and reference selectors. The response returns paged Currency records with next_offset and total and supports filters id, code_num, code_chr, name, exchange_rate, is_base and last_update; ids and search as aliases. The caller must have currency select permission; missing body, denied access, invalid filters or sorting and persistent storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for: name, code_chr (alphabetic code).
sort_orders Array of CurrencySortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
code_chr string
code_num int
exchange_rate decimal
id int Currency IDs.
is_base bool
last_update int
name string

Sortable Fields

Field
code_chr
code_num
exchange_rate
id
last_update
name

Request Example

{
  "filters": [
    {
      "field": "code_chr",
      "operator": "Equal",
      "value": "UZS"
    }
  ],
  "sort_orders": [
    {
      "column": "code_chr",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Currency Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 860,
      "code_num": 860,
      "code_chr": "UZS",
      "name": "Uzbek sum",
      "exchange_rate": 1.00000000,
      "is_base": true,
      "deleted": false,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}