Exchange Rate

The exchange rate resource.

Base/exchangeRate

GET/exchangeRate

List exchange rates

Retrieve a paginated list of exchange rates. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/exchangeRate

curl --request GET \
  --url '<your-host>/exchangeRate?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "currencyCode": "string",
    "effectiveDate": "2026-01-01",
    "rate": 0,
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/exchangeRate

Retrieve a exchange rate

Fetch a single exchange rate by filtering on `id`.

Query parameters

idstring

Match on the exchange rate's `id`, e.g. `eq.{id}`.

GET/exchangeRate

curl --request GET \
  --url '<your-host>/exchangeRate?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "currencyCode": "string",
  "effectiveDate": "2026-01-01",
  "rate": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/exchangeRate

Create a exchange rate

Create a new exchange rate.

Body parameters

currencyCodestringrequired

References currencyCode.code

effectiveDatedaterequired

ratenumberrequired

POST/exchangeRate

curl --request POST \
  --url <your-host>/exchangeRate \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"currencyCode":"string","effectiveDate":"2026-01-01","rate":0}'

Response

{
  "id": "abc123def456",
  "currencyCode": "string",
  "effectiveDate": "2026-01-01",
  "rate": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/exchangeRate

Update a exchange rate

Update an existing exchange rate, matched on `id`.

Body parameters

currencyCodestringrequired

References currencyCode.code

effectiveDatedaterequired

ratenumberrequired

PATCH/exchangeRate

curl --request PATCH \
  --url '<your-host>/exchangeRate?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"currencyCode":"string"}'

Response

{
  "id": "abc123def456",
  "currencyCode": "string",
  "effectiveDate": "2026-01-01",
  "rate": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/exchangeRate

Delete a exchange rate

Delete a exchange rate, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the exchange rate to delete, e.g. `eq.{id}`.

DELETE/exchangeRate

curl --request DELETE \
  --url '<your-host>/exchangeRate?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content