accounts.classify_wallet_movement

What it does

Record a confirmed wallet movement as an identified payment, allocated to explicit claims or left unapplied. Amount, token, account, direction and chain evidence come from the observation; an incoming transfer alone never becomes revenue. The cash receipt uses machine-payment: for shared MPP/feed identity.

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 accounts.classify_wallet_movement 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.

FieldTypeRequiredMeaning and accepted values
monitorIdstringYesMaximum length: 512.
referencestringYesMaximum length: 256.
partyIdstringYesMaximum length: 256.
allocationsarrayYesItems: object. Minimum items: 0. Maximum items: 100.
allocations[].claimIdstringYesMinimum length: 1.
allocations[].amountstringYesPattern: "^[1-9][0-9]*$".
allocations[].cashAmountstringNoPattern: "^[1-9][0-9]*$".
allocations[].componentobjectYes
allocations[].component.originLedgerIdstringYesMinimum length: 1.
allocations[].component.accountCodeintegerYes

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.

FieldTypeRequiredMeaning and accepted values
paymentIdstringYesMinimum length: 1.
currencystringNoThe currency the payment was recorded in: a personal account’s own, when a payment stated in a foreign bill’s currency was converted at its booking rate. Minimum length: 1.
amountstringNoThe amount recorded, in currency.
residualstringYes
recoverableClaimobjectNo
recoverableClaim.claimIdstringYesMinimum length: 1.
recoverableClaim.componentobjectYes
recoverableClaim.component.originLedgerIdstringYesMinimum length: 1.
recoverableClaim.component.accountCodeintegerYes
unappliedClaimobjectNo
unappliedClaim.claimIdstringYesMinimum length: 1.
unappliedClaim.componentobjectYes
unappliedClaim.component.originLedgerIdstringYesMinimum length: 1.
unappliedClaim.component.accountCodeintegerYes
fundingClaimsarrayYesItems: object.
fundingClaims[].claimIdstringYesMinimum length: 1.
fundingClaims[].componentobjectYes
fundingClaims[].component.originLedgerIdstringYesMinimum length: 1.
fundingClaims[].component.accountCodeintegerYes

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": "accounts.classify_wallet_movement"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "monitorId",
        "reference",
        "partyId",
        "allocations"
      ],
      "properties": {
        "monitorId": {
          "type": "string",
          "maxLength": 512
        },
        "reference": {
          "type": "string",
          "maxLength": 256
        },
        "partyId": {
          "type": "string",
          "maxLength": 256
        },
        "allocations": {
          "type": "array",
          "minItems": 0,
          "maxItems": 100,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "claimId",
              "component",
              "amount"
            ],
            "properties": {
              "claimId": {
                "type": "string",
                "minLength": 1
              },
              "amount": {
                "type": "string",
                "pattern": "^[1-9][0-9]*$"
              },
              "cashAmount": {
                "type": "string",
                "pattern": "^[1-9][0-9]*$"
              },
              "component": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "originLedgerId",
                  "accountCode"
                ],
                "properties": {
                  "originLedgerId": {
                    "type": "string",
                    "minLength": 1
                  },
                  "accountCode": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    "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",
      "properties": {
        "paymentId": {
          "type": "string",
          "minLength": 1
        },
        "currency": {
          "type": "string",
          "minLength": 1,
          "description": "The currency the payment was recorded in: a personal account's own, when a payment stated in a foreign bill's currency was converted at its booking rate."
        },
        "amount": {
          "type": "string",
          "description": "The amount recorded, in `currency`."
        },
        "residual": {
          "type": "string"
        },
        "recoverableClaim": {
          "type": "object",
          "properties": {
            "claimId": {
              "type": "string",
              "minLength": 1
            },
            "component": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "originLedgerId",
                "accountCode"
              ],
              "properties": {
                "originLedgerId": {
                  "type": "string",
                  "minLength": 1
                },
                "accountCode": {
                  "type": "integer"
                }
              }
            }
          },
          "required": [
            "claimId",
            "component"
          ]
        },
        "unappliedClaim": {
          "type": "object",
          "properties": {
            "claimId": {
              "type": "string",
              "minLength": 1
            },
            "component": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "originLedgerId",
                "accountCode"
              ],
              "properties": {
                "originLedgerId": {
                  "type": "string",
                  "minLength": 1
                },
                "accountCode": {
                  "type": "integer"
                }
              }
            }
          },
          "required": [
            "claimId",
            "component"
          ]
        },
        "fundingClaims": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "claimId": {
                "type": "string",
                "minLength": 1
              },
              "component": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "originLedgerId",
                  "accountCode"
                ],
                "properties": {
                  "originLedgerId": {
                    "type": "string",
                    "minLength": 1
                  },
                  "accountCode": {
                    "type": "integer"
                  }
                }
              }
            },
            "required": [
              "claimId",
              "component"
            ]
          }
        }
      },
      "required": [
        "paymentId",
        "residual",
        "fundingClaims"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
Navigate documentation