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