Archivar documento fiscal
Archiva o restaura un CFDI o documento de retención sin eliminar su historial.
archive_fiscal_documentPropósito
- Usar cuando
- Debe ocultarse de las vistas de trabajo normales.
- No usar cuando
- Necesitas cancelarlo ante SAT o aún está en elaboración.
- Permisos requeridos
- Efectos secundarios
- Modifica datos
- Idempotencia
- Idempotente
Esquema de entrada
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" }, "documentRef": { "type": "string", "pattern": "^invoice:.+$" } }, "required": [ "archived", "documentRef" ], "additionalProperties": false }, { "type": "object", "properties": { "archived": { "$ref": "#/definitions/__schema0" }, "documentRef": { "type": "string", "pattern": "^withholding:.+$" } }, "required": [ "archived", "documentRef" ], "additionalProperties": false } ] } }, "required": [ "idempotencyKey", "input" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "type": "boolean", "description": "true archives a fiscal document; false restores it" } }}Esquema de salida
JSON Schema{ "type": "object", "properties": { "data": { "type": "object", "properties": { "simulated": { "allOf": [ { "type": "boolean", "const": true } ] }, "documentRef": { "type": "string", "pattern": "^(invoice|withholding|sales_receipt|declaration|tax_compliance_opinion|sales_receipt_refund):.+$" }, "archived": { "type": "boolean" } }, "required": [ "documentRef", "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": "^(invoice|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" ] } ]}Flujo relacionado
Consulta los flujos canónicos en Inicio rápidoHerramientas relacionadas
Cancelar documento fiscal
Solicita la cancelación de un CFDI o retención timbrados. pending: true indica que se recibió la solicitud, sin confirmar la cancelación. Para retenciones, get_document lee el estado almacenado; no hay actualización automática ante el SAT. Verifica de forma independiente en el [portal de verificación de retenciones del SAT](https://prodretencionverificacion.clouda.sat.gob.mx/). Un acuse disponible no confirma por sí solo que la cancelación haya concluido. Ante recovery_required o un resultado incierto, no reenvíes automáticamente ni cambies la clave de idempotencia.
Descargar archivo de documento
Descarga un archivo como recurso binario. Usa preview_pdf para renderizar un borrador CFDI sin timbrar; la vista previa no tiene validez fiscal.