currency_exchange_rates

Store new currency exchange rates under this date

Stores a new set of exchange rates. The date is fixed (in the URL parameter) and the data required can be submitted as a JSON body.

post/v1/exchange-rates/by-date/{date}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/exchange-rates/by-date/{date}
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

datestring string required

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

fromstring string required

The 'from'-currency

ratesobject required

The actual entries for this data set. They 'key' value is 'to' currency. The value is the exchange rate.

Example request

{
  "from": "EUR",
  "rates": {
    "USD": "1.2345",
    "GBP": "6.3456"
  }
}

Response

New exchange rates stored, result in response. If a rate already existed for any submitted entry, it will be updated.

Example response

{
  "data": [
    {
      "type": "currency_exchange_rates",
      "id": "2",
      "attributes": {
        "created_at": "2025-12-01T00:00:00+00:00",
        "updated_at": "2025-12-01T00:00:00+00:00",
        "from_currency_id": "12",
        "from_currency_name": "Euro",
        "from_currency_code": "EUR",
        "from_currency_symbol": "$",
        "from_currency_decimal_places": 2,
        "to_currency_id": "12",
        "to_currency_name": "EUR",
        "to_currency_code": "EUR",
        "to_currency_symbol": "$",
        "to_currency_decimal_places": 2,
        "rate": "1.10340",
        "date": "2025-12-01T00:00:00+00:00"
      },
      "links": {
        "0": {
          "rel": "self",
          "uri": "/OBJECTS/1"
        },
        "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "links": {
    "self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
    "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
    "next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
    "prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
    "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.