AlmondTill/G3N API

On this page

doomFxRate

mutation · in the family FX rate

What it does

Permanently retire a foreign-exchange rate your tills use for foreign cash.

Cancel a SCHEDULED FxRate window: allowed ONLY while the record is not yet effective (now < startAt). An effective or lapsed window is immutable rate history — CONFLICT/IMMUTABLE naming startAt vs now; supersede it with a new window instead. Requires the current revision (OCC) + the unrestricted capability; the record is kept, excluded from resolution (no-delete).

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Pricing — Prices, price schedules, promotions, coupons and the money rules of selling.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

FxRate FxRate! — 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.

Example request

mutation ExampleDoomFxRate($id: ID!, $revision: ID!, $reason: String) {
  doomFxRate(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    level
    fromCurrency
    toCurrency
    mode
    buyRateMicro
    sellRateMicro
    adjustPpm
    feeMinor
    startAt
    endAt
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomFxRate": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "FX-EXMP-0000-000F",
      "type": "FxRate",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "level": "<level>",
      "fromCurrency": "<from currency>",
      "toCurrency": "<to currency>",
      "mode": "<mode>",
      "buyRateMicro": 1,
      "sellRateMicro": 1,
      "adjustPpm": 1,
      "feeMinor": 1,
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer