# FxRate

object type

An FX rate window: ONE effective-dated conversion rate record in the tenant schedule, resolved group (default) → org → LF MOST-SPECIFIC-WINS at every conversion event. Modes: absolute (explicit buy/sell integer-micro rates — the ONLY group-level mode) · adjust (± ppm over the next-less-specific EFFECTIVE rate, both directions, optional fee) · par (1:1). Doom cancels a not-yet-effective FUTURE record only (CONFLICT/IMMUTABLE otherwise — supersede instead). The window/pair/mode/rate fields are wire-IMMUTABLE (the edit surface is caption only). Consumed by the foreign_cash tender lane at the BUY side.

## Fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (FX-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `FxRate` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The level anchor: the org group itself (group level — parentId === rootId), an Organization, or a LogicalFacility. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `level` | [String](/types/#scalars) `String!` | The resolution level this record binds (group \| org \| lf — most-specific-wins). Stored explicit, validated against the REAL parent at create; IMMUTABLE. |
| `fromCurrency` | [String](/types/#scalars) `String!` | The FROM (tendered/foreign) currency; registry-gated at create. IMMUTABLE — supersede to change. |
| `toCurrency` | [String](/types/#scalars) `String!` | The TO (settlement) currency — the org default currency at resolution. IMMUTABLE. |
| `mode` | [String](/types/#scalars) `String!` | The record mode (absolute \| adjust \| par — override grammar; group-level records are absolute). IMMUTABLE. |
| `buyRateMicro` | [Int](/types/#scalars) | ABSOLUTE only: the rate WE BUY the from-currency at, integer micro to-per-from (1.25 = 1250000). IMMUTABLE. |
| `sellRateMicro` | [Int](/types/#scalars) | ABSOLUTE only: the rate WE SELL the from-currency at, integer micro to-per-from. IMMUTABLE. |
| `adjustPpm` | [Int](/types/#scalars) | ADJUST only: the SIGNED ± ppm applied to BOTH directions (buy AND sell) of the next-less-specific effective rate. IMMUTABLE. |
| `feeMinor` | [Int](/types/#scalars) | ADJUST only, optional: a fee in TO-currency minor units, REDUCING the credited amount at conversion. IMMUTABLE. |
| `startAt` | [String](/types/#scalars) `String!` | The window start (INCLUSIVE; UTC ISO-8601) — set at birth (absent in the create input = effective NOW, server-stamped), IMMUTABLE thereafter. |
| `endAt` | [String](/types/#scalars) `String!` | The window end (EXCLUSIVE; UTC ISO-8601; ALWAYS present — far-future = the standing rate). Moves ONLY via the system splice trim. |

## Used by

- [createFxRate](/reference/fx-rate/createFxRate/)
- [doomFxRate](/reference/fx-rate/doomFxRate/)
- [fxRate](/reference/fx-rate/fxRate/)
- [updateFxRate](/reference/fx-rate/updateFxRate/)