# presentation_rate.record

## What it does

Freeze one exact, human-approved presentation-currency rate, optionally verified against a dated shared-store observation.

## Before you send it

Requires an interactive OAuth connection; headless credentials are refused. Effective membership, application grant and token permissions still apply. Describe `presentation_rate.record` through `GET /v1/catalog/commands/{name}` before acting.

The envelope may reference a registered source document of kind `source_document`; this is separate from any evidence required by the input.

## Inputs

Put these fields inside the envelope's `input` object. The outer envelope names the command, a stable `idempotency_key` and `effective_at`; [request and recovery rules](/docs/api/) explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

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

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `packageId` | string | Yes |  Example: `"ch-co-ordinary-standalone-ag-gmbh-software-services-2026.1"`. |
| `baseCurrency` | string | Yes |  Example: `"USD"`. |
| `quoteCurrency` | string | Yes |  Example: `"CHF"`. |
| `numerator` | string | Yes |  Maximum length: `38`. Pattern: `"^[1-9][0-9]*$"`. Example: `"4"`. |
| `denominator` | string | Yes |  Maximum length: `38`. Pattern: `"^[1-9][0-9]*$"`. Example: `"5"`. |
| `observedAt` | string | Yes |  Example: `"2026-09-30T23:59:59.999Z"`. |
| `source` | string | Yes |  Must be `"manual_evidenced"`. Example: `"manual_evidenced"`. |
| `approvedRate` | object | No | Copy the complete rate returned by fx_rate that the human reviewed. Required with lookupDate; provenance changes require review again.  |
| `approvedRate.base` | string | Yes |   |
| `approvedRate.quote` | string | Yes |   |
| `approvedRate.requestedDate` | string | Yes |   |
| `approvedRate.date` | string | Yes |   |
| `approvedRate.numerator` | string | Yes |   |
| `approvedRate.denominator` | string | Yes |   |
| `approvedRate.source` | string | Yes |  Must be `"frankfurter"`. |
| `approvedRate.provider` | string | No |   |
| `approvedRate.settled` | boolean | Yes |   |
| `lookupDate` | string | No | Optional shared-store requested day (YYYY-MM-DD). First review fx_rate; the approved numerator, denominator and observation day must match. A human approval source_document remains required.  |

## After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns `commandId`, `replayed`, the command-specific `result` below and emitted `events` with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect `result` and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch `GET /v1/commands/{id}` with `commandId` to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with `events: []` and return a transient result and `commandId` without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain `no_change` is a separate success outcome with no persisted receipt.

### Result fields

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

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `eventId` | integer | Yes |   |


[All commands](/docs/command-reference/) · [Operation and errors](/docs/api-reference/operations/commands-execute/) · [Reusable schemas](/docs/api-reference/components/)

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

## Exact request schema


```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "presentation_rate.record"
    },
    "input": {
      "type": "object",
      "required": [
        "packageId",
        "baseCurrency",
        "quoteCurrency",
        "numerator",
        "denominator",
        "observedAt",
        "source"
      ],
      "properties": {
        "packageId": {
          "type": "string"
        },
        "baseCurrency": {
          "type": "string"
        },
        "quoteCurrency": {
          "type": "string"
        },
        "numerator": {
          "type": "string",
          "pattern": "^[1-9][0-9]*$",
          "maxLength": 38
        },
        "denominator": {
          "type": "string",
          "pattern": "^[1-9][0-9]*$",
          "maxLength": 38
        },
        "observedAt": {
          "type": "string"
        },
        "source": {
          "const": "manual_evidenced"
        },
        "approvedRate": {
          "type": "object",
          "description": "Copy the complete rate returned by fx_rate that the human reviewed. Required with lookupDate; provenance changes require review again.",
          "required": [
            "base",
            "quote",
            "requestedDate",
            "date",
            "numerator",
            "denominator",
            "source",
            "settled"
          ],
          "properties": {
            "base": {
              "type": "string"
            },
            "quote": {
              "type": "string"
            },
            "requestedDate": {
              "type": "string"
            },
            "date": {
              "type": "string"
            },
            "numerator": {
              "type": "string"
            },
            "denominator": {
              "type": "string"
            },
            "source": {
              "const": "frankfurter"
            },
            "provider": {
              "type": "string"
            },
            "settled": {
              "type": "boolean"
            }
          }
        },
        "lookupDate": {
          "type": "string",
          "description": "Optional shared-store requested day (YYYY-MM-DD). First review fx_rate; the approved numerator, denominator and observation day must match. A human approval source_document remains required."
        }
      },
      "additionalProperties": false
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    },
    "source_document_id": {
      "description": "A registered document of kind source_document that caused this command.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}
```

## Accepted command receipt


```json
{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "required": [
        "eventId"
      ],
      "properties": {
        "eventId": {
          "type": "integer"
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Example request


```json
{
  "name": "presentation_rate.record",
  "input": {
    "packageId": "ch-co-ordinary-standalone-ag-gmbh-software-services-2026.1",
    "baseCurrency": "USD",
    "quoteCurrency": "CHF",
    "numerator": "4",
    "denominator": "5",
    "observedAt": "2026-09-30T23:59:59.999Z",
    "source": "manual_evidenced"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "presentation_rate.record-example-0"
}
```