MCP serverAvailable tools
Archive account document
Archive or restore one PPD invoice in receivables (sent) or payables (received). Preserves fiscal balances and general invoice visibility; archived invoices leave active balances, overdue totals, and payment reminders.
MCP tool
archive_account_documentPurpose
Exclude or restore one document in active receivables or payables.
- Use when
- An invoice no longer needs collection or payment follow-up, or should return to its active account.
- Do not use when
- Recording a payment, issuing a credit note, or changing fiscal status.
- Required permissions
- Side effects
- Destructive
- Idempotency
- Idempotent
Input schema
JSON Schema{ "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Unique retry key for this exact operation. Reuse it only when retrying the same request." }, "input": { "anyOf": [ { "type": "object", "properties": { "archived": { "$ref": "#/definitions/__schema0" }, "kind": { "const": "receivable" }, "customerId": { "type": "string" }, "documentRef": { "type": "string", "pattern": "^cfdi:.+$" } }, "required": [ "archived", "kind", "customerId", "documentRef" ], "additionalProperties": false }, { "type": "object", "properties": { "archived": { "$ref": "#/definitions/__schema0" }, "kind": { "const": "payable" }, "supplierId": { "type": "string" }, "documentRef": { "type": "string", "pattern": "^cfdi:.+$" } }, "required": [ "archived", "kind", "supplierId", "documentRef" ], "additionalProperties": false } ] } }, "required": [ "idempotencyKey", "input" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "boolean" } }}Output schema
JSON Schema{ "type": "object", "properties": { "data": { "type": "object", "properties": { "archived": { "type": "boolean" } }, "required": [ "archived" ], "additionalProperties": false }, "error": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "enum": [ "validation_error", "unauthenticated", "forbidden", "payment_required", "not_found", "method_not_allowed", "conflict", "idempotency_conflict", "operation_in_progress", "recovery_required", "migration_required", "rate_limited", "provider_unavailable", "internal" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentRef": { "type": "string", "pattern": "^(cfdi|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" }, "editable": { "type": "boolean" } }, "required": [ "documentRef", "editable" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "retryable": { "type": "boolean" }, "retryAfterSeconds": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "reason": { "type": "string" }, "balanceMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "topUpUrl": { "type": "string" } }, "additionalProperties": false } }, "required": [ "code", "message" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "oneOf": [ { "required": [ "data" ] }, { "required": [ "error" ] } ]}Related workflow
See the canonical workflows in the introductionRelated tools
Read accounts
Search receivable/payable accounts or retrieve one account. Use customerId for receivables and supplierId for payables.
Set payment plan
Create, replace, or clear the payment terms of an unpaid PPD invoice in receivables (sent) or payables (received). Installments and overdue amounts are derived from the terms and the fiscal balance. Use the same idempotencyKey when retrying the exact change.