Carbon

Exchange Rate History

The exchange rate history resource.

Basehttps://rest.carbon.ms/exchangeRateHistory
GET/exchangeRateHistory

List exchange rate historys

Retrieve a paginated list of exchange rate historys. 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.

GEThttps://rest.carbon.ms/exchangeRateHistory
curl --request GET \
  --url 'https://rest.carbon.ms/exchangeRateHistory?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "currencyCode": "string",
    "rate": 0,
    "effectiveDate": "2026-01-01",
    "companyGroupId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]
GET/exchangeRateHistory

Retrieve a exchange rate history

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/exchangeRateHistory
curl --request GET \
  --url 'https://rest.carbon.ms/exchangeRateHistory?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "currencyCode": "string",
  "rate": 0,
  "effectiveDate": "2026-01-01",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
POST/exchangeRateHistory

Create a exchange rate history

Create a new exchange rate history.

Body parameters

currencyCodestringrequired

References currencyCode.code

ratenumberrequired
effectiveDatedaterequired
companyGroupIdstringrequired

References companyGroup.id

POSThttps://rest.carbon.ms/exchangeRateHistory
curl --request POST \
  --url https://rest.carbon.ms/exchangeRateHistory \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"currencyCode":"string","rate":0,"effectiveDate":"2026-01-01","companyGroupId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "currencyCode": "string",
  "rate": 0,
  "effectiveDate": "2026-01-01",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
PATCH/exchangeRateHistory

Update a exchange rate history

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

Body parameters

currencyCodestringrequired

References currencyCode.code

ratenumberrequired
effectiveDatedaterequired
companyGroupIdstringrequired

References companyGroup.id

PATCHhttps://rest.carbon.ms/exchangeRateHistory
curl --request PATCH \
  --url 'https://rest.carbon.ms/exchangeRateHistory?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",
  "rate": 0,
  "effectiveDate": "2026-01-01",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
DELETE/exchangeRateHistory

Delete a exchange rate history

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/exchangeRateHistory
curl --request DELETE \
  --url 'https://rest.carbon.ms/exchangeRateHistory?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content