# createFxRate

mutation · in the family [FX rate](/reference/fx-rate/)

## What it does

Create a new foreign-exchange rate your tills use for foreign cash at your organization.

Create an FxRate — the / splice insert; requires the unrestricted capability.

## Who may call it

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

- Owner
- Manager
- An API key whose scope allows `api:createFxRate`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `input` | [NewFxRateInput](/types/NewFxRateInput/) `NewFxRateInput!` | yes | No further notes. |

## Returns

[FxRate](/types/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

```graphql
mutation ExampleCreateFxRate($input: NewFxRateInput!) {
  createFxRate(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    level
    fromCurrency
    toCurrency
    mode
    buyRateMicro
    sellRateMicro
    adjustPpm
    feeMinor
    startAt
    endAt
  }
}
```

Variables:

```json
{
  "input": {
    "caption": "Blue jeans",
    "fromCurrency": "<from currency>",
    "toCurrency": "<to currency>",
    "mode": "<mode>",
    "endAt": "2027-01-31T00:00:00.000Z"
  }
}
```

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

## Example response

```json
{
  "data": {
    "createFxRate": {
      "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

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))

## Dry run

Add `dryRun: true` to the request envelope (`extensions.at`) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries `dryRun: true`, so a rehearsed record is never mistaken for a saved one.

## Used in

- [Take foreign cash at the till](/use-cases/take-foreign-cash/)