Cancelar
Cancela un documento timbrado y emitido por el contribuyente. Recibe el documento (id o folio fiscal), el motivo del SAT (01 con errores y con relación, 02 con errores y sin relación, 03 no se llevó a cabo la operación, 04 operación nominativa relacionada en una factura global) y, con el motivo 01, el documento timbrado que lo sustituye (id o folio fiscal). La primera llamada no cancela: devuelve un resumen (documento, receptor, total, motivo, sustituto y ambiente), un token de confirmación y su vencimiento. Al llamar de nuevo con el token se cancela y devuelve el estado, canceled o waiting_acceptance si el receptor debe aceptar, junto con el documento. Mientras espera, Cefidia consulta al SAT y avisa por correo cuando termina; get_document da el estado vigente. Una cancelación abierta o ya hecha responde su estado sin token. Un documento que el SAT marca como no cancelable se rechaza con invalid_state. Si el PAC rechaza la solicitud, el documento sigue timbrado y la respuesta es un error con el motivo. Un folio fiscal que Cefidia no tiene se cancela indicando también el receptor (su RFC o un receptor del directorio, {id} o {name}) y el total; el SAT lo verifica antes. Errores: not_found, invalid_input con el campo document, motivo, replacement, receiver o total, invalid_state, confirmation_invalid, confirmation_expired, pac_unavailable, forbidden.
Alcance (scope): cefidia:write · Características: Destructiva, Idempotente, Interactúa con el mundo exterior
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
taxpayer |
texto | No | Nombre o RFC del contribuyente. Se puede omitir si solo hay uno. |
document |
texto | Sí | Id del documento o su folio fiscal (UUID del SAT). |
motivo |
texto | Sí | Motivo de cancelación del SAT: 01 con errores y con relación, 02 con errores y sin relación, 03 no se llevó a cabo la operación, 04 operación nominativa relacionada en una factura global. |
replacement |
texto | No | Con el motivo 01, el documento timbrado (id o folio fiscal) que sustituye al cancelado; los demás motivos no lo llevan. |
receiver |
texto o objeto | No | Receptor del documento, solo para un folio fiscal que Cefidia no tiene: con el total, el SAT lo verifica. Es su RFC o un receptor del directorio, {id} o {name}. |
total |
número o texto | No | Total del documento, solo para un folio fiscal que Cefidia no tiene. |
confirmation_token |
texto | No | Token de confirmación que devolvió la llamada anterior. |
Esquema de entrada (JSON Schema)¶
{
"$defs": {
"ReceiverById": {
"additionalProperties": false,
"description": "A directory receiver, by its id (MCP-35).",
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "ReceiverById",
"type": "object"
},
"ReceiverByName": {
"additionalProperties": false,
"description": "A directory receiver, by its name (MCP-35).",
"properties": {
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "ReceiverByName",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"taxpayer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Nombre o RFC del contribuyente. Se puede omitir si solo hay uno.",
"title": "Taxpayer"
},
"document": {
"description": "Id del documento o su folio fiscal (UUID del SAT).",
"title": "Document",
"type": "string"
},
"motivo": {
"description": "Motivo de cancelación del SAT: 01 con errores y con relación, 02 con errores y sin relación, 03 no se llevó a cabo la operación, 04 operación nominativa relacionada en una factura global.",
"enum": [
"01",
"02",
"03",
"04"
],
"title": "Motivo",
"type": "string"
},
"replacement": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Con el motivo 01, el documento timbrado (id o folio fiscal) que sustituye al cancelado; los demás motivos no lo llevan.",
"title": "Replacement"
},
"receiver": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/ReceiverById"
},
{
"$ref": "#/$defs/ReceiverByName"
},
{
"type": "null"
}
],
"default": null,
"description": "Receptor del documento, solo para un folio fiscal que Cefidia no tiene: con el total, el SAT lo verifica. Es su RFC o un receptor del directorio, {id} o {name}.",
"title": "Receiver"
},
"total": {
"anyOf": [
{
"exclusiveMinimum": 0.0,
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Total del documento, solo para un folio fiscal que Cefidia no tiene.",
"title": "Total"
},
"confirmation_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Token de confirmación que devolvió la llamada anterior.",
"title": "Confirmation Token"
}
},
"required": [
"document",
"motivo"
],
"title": "CancelDocumentInput",
"type": "object"
}