Skip to content
aimrack

Currency

The currency resource.

Base/currency
GET/currency

List currencies

Retrieve a paginated list of currencies. 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/currency
curl --request GET \
  --url '<your-host>/currency?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "code": "string",
    "decimalPlaces": 0,
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "companyGroupId": "xyz789",
    "updatedBy": "string"
  }
]
GET/currency

Retrieve a currency

Fetch a single currency by filtering on `id`.

Query parameters

idstring

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

GET/currency
curl --request GET \
  --url '<your-host>/currency?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "code": "string",
  "decimalPlaces": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyGroupId": "xyz789",
  "updatedBy": "string"
}
POST/currency

Create a currency

Create a new currency.

Body parameters

codestringrequired

References currencyCode.code

decimalPlacesnumberrequired
activebooleanrequired
customFieldsobject
tagsarray
companyGroupIdstringrequired

References companyGroup.id

historicalExchangeRatenumber
POST/currency
curl --request POST \
  --url <your-host>/currency \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string","decimalPlaces":0,"active":true,"companyGroupId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "code": "string",
  "decimalPlaces": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyGroupId": "xyz789",
  "updatedBy": "string"
}
PATCH/currency

Update a currency

Update an existing currency, matched on `id`.

Body parameters

codestringrequired

References currencyCode.code

decimalPlacesnumberrequired
activebooleanrequired
customFieldsobject
tagsarray
companyGroupIdstringrequired

References companyGroup.id

historicalExchangeRatenumber
PATCH/currency
curl --request PATCH \
  --url '<your-host>/currency?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string"}'
Response
{
  "id": "abc123def456",
  "code": "string",
  "decimalPlaces": 0,
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyGroupId": "xyz789",
  "updatedBy": "string"
}
DELETE/currency

Delete a currency

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

Query parameters

idstring

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

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