finov.ioDocumentationHome

List currencies

API Documentation / Resources / Connections and subsidiaries

Finovio Currency settings showing enabled currencies and exchange rate controls
Currency settings control the currencies and exchange rates available to the subsidiary.

List currencies

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/currencies

Required OAuth scope: accounting:read

Lists currencies enabled for use by the subsidiary.

functional=true identifies the ledger currency. Other active currencies may be used on supported foreign-currency documents and accounts. Currency codes are ISO 4217 and should be stored instead of display names.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
page query No integer
per_page query No integer

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/currencies HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 A page of currencies available to the subsidiary.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
422 One or more supplied values failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "code": "NZD",
      "name": "New Zealand dollar",
      "functional": true,
      "active": true
    },
    {
      "code": "USD",
      "name": "United States dollar",
      "functional": false,
      "active": true
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 30,
    "last_page": 1,
    "total": 2
  }
}