Currencies

Disable a currency.

POST

https://firefly.example.com/api/v1/currencies/{code}/disable

Disable a currency.

curl -X POST 'https://firefly.example.com/api/v1/currencies/GBP/disable' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/currencies/GBP/disable', {
  method: 'POST',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://firefly.example.com/api/v1/currencies/GBP/disable',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

{
  "data": {
    "type": "currencies",
    "id": "2",
    "attributes": {
      "created_at": "2026-10-01T00:00:00+00:00",
      "updated_at": "2026-10-01T00:00:00+00:00",
      "enabled": true,
      "primary": false,
      "code": "AMS",
      "name": "Ankh-Morpork dollar",
      "symbol": "AM$",
      "decimal_places": 2
    }
  }
}

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Parameters

X-Trace-Idstring<uuid>header

Unique identifier associated with this request.

codestringrequiredpath

The currency code.

Response

204No ContentCurrencySingle

Currency was disabled.

Response fields application/vnd.api+json

dataCurrencyReadrequired

Show child attributes

typestringrequired

Immutable value

Example

currencies

idstringrequired

Example

attributesCurrencyPropertiesrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

enabledbooleantrue

Defaults to true

Example

true

primaryboolean

Is the primary currency?

Example

false

codestringrequired

Example

AMS

namestringrequired

Example

Ankh-Morpork dollar

symbolstringrequired

Example

AM$

decimal_placesinteger<int32>

Supports 0-16 decimals.

Example

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

409ConflictInternalExceptionResponse

Currency cannot be disabled, because it is still in use.

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.