claims.record_reminder
Record that a receivable open on effective_at was chased (email, phone, letter or other).
What it does
Record that the business reminded a counterparty of an open receivable it owes, such as a customer invoice: by email, phone, letter or another channel, on the command’s effective_at. Posts nothing; aging rows and the customer’s page show each claim’s latest reminder. The claim must be a trade receivable (1120) that was open on effective_at, even if paid since; the date may not be in the future or before the claim. An optional note says what was said, and documentId cites a registered document (the sent email, a letter) as evidence.
Before you send it
An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe claims.record_reminder through GET /v1/catalog/commands/{name} before acting.
This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.
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 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 |
|---|---|---|---|
claimId | string | Yes | The receivable’s claimId, as aging or activity_claims returns it. Minimum length: 1. Example: "claim_01K00000000000000000000000". |
channel | string | Yes | Choose "email", "phone", "letter", "other". Example: "email". |
note | string | No | Maximum length: 2000. Example: "Sent the invoice again and asked for a payment date.". |
documentId | string | No | A registered document evidencing the reminder. Minimum length: 1. |
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 |
|---|---|---|---|
claimId | string | Yes | |
remindedAt | string | Yes | Format: date-time. |
channel | string | Yes | Choose "email", "phone", "letter", "other". |
All commands · Operation and errors · Reusable schemas
Keep credentials out of prompts; rehearse writes only in a disposable sandbox.
Exact request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"const": "claims.record_reminder"
},
"input": {
"type": "object",
"additionalProperties": false,
"required": [
"claimId",
"channel"
],
"properties": {
"claimId": {
"type": "string",
"minLength": 1,
"description": "The receivable's claimId, as aging or activity_claims returns it."
},
"channel": {
"enum": [
"email",
"phone",
"letter",
"other"
]
},
"note": {
"type": "string",
"maxLength": 2000
},
"documentId": {
"type": "string",
"minLength": 1,
"description": "A registered document evidencing the reminder."
}
}
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "A key you choose, stable for this one command: retrying with it returns the original receipt instead of running again; reusing it for a different command is refused."
},
"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))$",
"description": "When the change takes effect in the books, in UTC with Z: the business date it happened, not when you record it."
}
},
"required": [
"name",
"input",
"idempotency_key",
"effective_at"
],
"additionalProperties": false
}Accepted command receipt
{
"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": [
"claimId",
"remindedAt",
"channel"
],
"properties": {
"claimId": {
"type": "string"
},
"remindedAt": {
"type": "string",
"format": "date-time"
},
"channel": {
"enum": [
"email",
"phone",
"letter",
"other"
]
}
}
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"cid": {
"type": "string"
}
}
}
}
}
}Example request
{
"name": "claims.record_reminder",
"input": {
"claimId": "claim_01K00000000000000000000000",
"channel": "email",
"note": "Sent the invoice again and asked for a payment date."
},
"effective_at": "2026-09-01T00:00:00Z",
"idempotency_key": "claims.record_reminder-example-0"
}