payments.unallocate

Undo all or part of a payment allocation. Reopens the claim and restores unapplied funds without moving cash.

What it does

Undo all or part of a later payments.allocate match, reopening identified claims (or their live explicit vendor-bill replacements) and restoring the payment’s unapplied funds without cash movement. Evidence is required. Earlier unallocations, including later-dated ones, reduce the available match. A match across currencies is undone in both its amount and its cashAmount, each bounded by what remains. Initial allocations made by payments.record require whole-payment reversal and corrected recording instead.

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 payments.unallocate 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
allocationIdstringYesMinimum length: 1.
sourceFactIdstringYesMinimum length: 1.
effectiveAtstringYesFormat: date-time.
evidencearrayYesItems: object. Minimum items: 1.
evidence[].kindstringYesChoose "tap_message", "x402_receipt", "chain_tx", "signed_doc", "stripe_object", "other".
evidence[].refstringYesMinimum length: 1.
evidence[].signerstringNoMinimum length: 1.
allocationsarrayYesItems: object. Minimum items: 1. 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
unallocationIdstringYesMinimum length: 1.
paymentIdstringYesMinimum length: 1.
amountstringYes

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": "payments.unallocate"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "allocationId",
        "sourceFactId",
        "effectiveAt",
        "evidence",
        "allocations"
      ],
      "properties": {
        "allocationId": {
          "type": "string",
          "minLength": 1
        },
        "sourceFactId": {
          "type": "string",
          "minLength": 1
        },
        "effectiveAt": {
          "type": "string",
          "format": "date-time"
        },
        "evidence": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "properties": {
              "kind": {
                "enum": [
                  "tap_message",
                  "x402_receipt",
                  "chain_tx",
                  "signed_doc",
                  "stripe_object",
                  "other"
                ]
              },
              "ref": {
                "type": "string",
                "minLength": 1
              },
              "signer": {
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "kind",
              "ref"
            ],
            "additionalProperties": false
          }
        },
        "allocations": {
          "type": "array",
          "minItems": 1,
          "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
    },
    "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))$"
    }
  },
  "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": [
        "unallocationId",
        "paymentId",
        "amount"
      ],
      "properties": {
        "unallocationId": {
          "type": "string",
          "minLength": 1
        },
        "paymentId": {
          "type": "string",
          "minLength": 1
        },
        "amount": {
          "type": "string"
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
Navigate documentation

On this page