Exchange Rate

Documentation Index

Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

API operations

​

Data model

​

Attributes

​

Relationships

​

System-computed

• exchange_rate_id is generated server-side via gen_random_uuid() as the Postgres column default, with a JavaScript fallback randomUUID() set at entity construction time in the MikroORM entity. Never supplied by the client.
• created_at is set by the MikroORM onCreate lifecycle hook (new Date()) and never subsequently updated.
• updated_at is set by both onCreate and onUpdate lifecycle hooks, reflecting the timestamp of the most recent mutation.
• deleted_at is null by default. Soft-delete is applied by setting this field to a non-null timestamp; hard deletes are not used. All read queries must filter deleted_at IS NULL.
• Composite uniqueness constraint: UNIQUE(workspace_pk, source_currency, target_currency, rate_date) — enforced at the database level. This makes the table an upsert target: the FX pipeline can safely attempt INSERT … ON CONFLICT (workspace_pk, source_currency, target_currency, rate_date) DO UPDATE.
• rate carries a database-level CHECK (rate > 0) constraint added in Migration20260306100000 DDL, even though the column is nullable — when rate is non-null, it must be strictly positive.
• The CHECK (source_currency != target_currency) constraint is enforced at the database level (Migration20260306100000). The MikroORM entity does not replicate this at the application layer; it is a DB-only guard.
• The workspace relation is nullable (nullable: true on the @ManyToOne decorator), allowing global rates to exist without a workspace owner. Workspace-scoped rates take precedence over global rates in the FX resolution service.
• Index idx_exchange_rates_workspace_date on (workspace_pk, rate_date) supports the FX rate lookup pattern: given a workspace and a date, resolve the applicable rate for a currency pair.
• Invoices reference ExchangeRate via invoices.exchange_rate_pk FK (added in Migration20260306100000). InvoiceTransaction rows reference ExchangeRate via invoice_transactions.exchange_rate_pk FK (added in Migration20260311100000_data_model_v2_accounting). ExchangeRate rows are pipeline-written; they are not created through the standard REST API by end users.
• The composites.yml file defines two composites for the exchange_rates root: composite_invoices_list (relation_list of linked invoices) and composite_invoice_transactions_list (relation_list of linked invoice_transactions). These are read-only aggregate views surfaced in the Records table.
• The workspace relation on exchange_rates is not guarded by the standard workspace-scoped Hasura RLS filter because the nullable workspace_pk means global rows have no workspace. This is an intentional architectural exception documented in the entity design.

​

Example

{
  "data": {
    "type": "exchange_rate",
    "id": "c3e1b2f4-09d7-4a8e-b5e0-7f2a1d3c6890",
    "attributes": {
      "exchange_rate_id": "c3e1b2f4-09d7-4a8e-b5e0-7f2a1d3c6890",
      "source_currency": "USD",
      "target_currency": "EUR",
      "rate": "0.92150000",
      "rate_date": "2026-05-15",
      "source": "ecb-daily-feed",
      "created_at": "2026-05-15T08:00:14.000Z",
      "updated_at": "2026-05-15T08:00:14.000Z",
      "deleted_at": null
    },
    "relationships": {
      "workspace": {
        "data": {
          "type": "workspace",
          "id": "a1b2c3d4-1111-2222-3333-444455556666"
        }
      }
    }
  }
}