fx_rate

Read a sourced exchange rate for a date, or the latest observation. This is a reference rate, not evidence of a payment’s executed rate.

What it shows

Read an exact sourced exchange rate without posting. Omit date for today’s latest observation; quote defaults to the business’s functional currency. Payment amounts still require independent evidence.

Example MCP App view

The read-only example below uses illustrative demo data and the same report component as the MCP App. These are not your books or the result of the request example.

Open the full example view.

Inputs

Send the fixed kind and these parameters at the top level of the report request, not inside input.

Required means required within its containing object; an optional parent can be omitted.

FieldTypeRequiredMeaning and accepted values
basestringYesSource ISO 4217 currency code. Example: "USD".
quotestringNoDestination ISO 4217 currency code; defaults to functional currency. Example: "USD".
datestringNoRequested rate day (YYYY-MM-DD or UTC RFC 3339 instant); defaults to the runtime day. Future days are refused. A calendar date means midnight UTC at its start; an explicit timestamp keeps the stated instant. Format: moment. Example: "2026-09-01".

Reading the result

Running this report does not change the books. Its description above distinguishes recorded-book summaries from previews based on supplied facts or assumptions. Interpret its totals, grouping, missing-data indicators and pagination using that description. Monetary amounts are integer strings in the reported unit; ratios and assumptions can be fractional numbers. An empty result is not evidence that the business had no activity.

The public OpenAPI contract does not enumerate this report’s result fields. Fetch GET /v1/reports for its live description and parameters, and inspect the returned JSON rather than assuming an output shape.

Example request

{
  "kind": "fx_rate",
  "base": "USD",
  "quote": "USD",
  "date": "2026-09-01"
}

All reports · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "const": "fx_rate"
    },
    "base": {
      "description": "Source ISO 4217 currency code.",
      "type": "string",
      "minLength": 1
    },
    "quote": {
      "description": "Destination ISO 4217 currency code; defaults to functional currency.",
      "type": "string",
      "minLength": 1
    },
    "date": {
      "description": "Requested rate day (YYYY-MM-DD or UTC RFC 3339 instant); defaults to the runtime day. Future days are refused.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "base"
  ]
}
Navigate documentation