Revocar enlace de datos
Cierra el enlace abierto de un receptor, indicado con id o con name, o el de una factura, indicado con document: la dirección deja de funcionar y se puede pedir otro; el documento vuelve a poder reemplazarse. Revocar de nuevo no es un error. Devuelve revoked. Errores: invalid_state si la factura se está timbrando, not_found, invalid_input, forbidden.
Alcance (scope): cefidia:write · Características: Destructiva, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
taxpayer |
texto | No | Nombre o RFC del contribuyente. Se puede omitir si solo hay uno. |
receiver |
objeto | No | Receptor cuyo enlace abierto se revoca. |
document |
texto | No | Documento preparado (id) cuyo enlace de factura abierto se revoca. |
Esquema de entrada (JSON Schema)¶
{
"$defs": {
"ReceiverRefInput": {
"additionalProperties": false,
"description": "A receiver by `id` or by `name`, as a cancellation names it.",
"properties": {
"id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Id del receptor.",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Nombre del receptor.",
"title": "Name"
}
},
"title": "ReceiverRefInput",
"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"
},
"receiver": {
"anyOf": [
{
"$ref": "#/$defs/ReceiverRefInput"
},
{
"type": "null"
}
],
"default": null,
"description": "Receptor cuyo enlace abierto se revoca."
},
"document": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Documento preparado (id) cuyo enlace de factura abierto se revoca.",
"title": "Document"
}
},
"title": "RevokeDataLinkInput",
"type": "object"
}