Abonos
Anular una nota de crédito
Anula una nota de crédito VALIDADA con un motivo, que es obligatorio y se conserva.
invoices:writeinvoices:write- 120/min
- Anotación del servidor: Destructiva
- Requiere confirmación humana
- No reversible
Resultado
generado desde el esquema
No reversible
Anular lleva el documento a voided y ninguna operación lo deshace.
Requiere confirmación humana
Pon esta herramienta en la lista de «preguntar antes de ejecutar» de tu cliente. Las anotaciones son pistas que declara el servidor, no garantías: no decidas la aprobación solo por destructiveHint. El servidor marca esta herramienta con _meta["anthropic, que los clientes que lo respetan usan para preguntar a una persona antes de cada llamada.
Conserva su número y pasa a voided. Solo desde validated: un borrador se elimina desde la aplicación, no se anula. No toca la factura que corregía. Devuelve la nota de crédito completa, la misma proyección que su GET.
Argumentos
Identificador de la nota de crédito.
Límites: longitud mín. 1
Motivo de la anulación. Se guarda en la nota de crédito y en su historial.
Límites: longitud mín. 1, longitud máx. 500
Clave de idempotencia elegida por el cliente (se recomienda un UUID). Repetir la misma clave con los mismos argumentos en 24 h devuelve la respuesta almacenada sin volver a ejecutar; con argumentos distintos responde 422. Es la forma segura de reintentar tras un fallo de red.
Límites: longitud mín. 1, longitud máx. 255
Bloqueo optimista: el meta.etag que obtuviste de la lectura de detalle de este recurso (o "*"). Si el recurso ha cambiado desde entonces, la llamada falla con 412 precondition_failed antes de escribir nada; léelo de nuevo y reintenta. Omítelo para escribir sin condiciones.
Límites: longitud mín. 1
Resultado
En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.
Ver los atributos de data
Identificador de la nota de crédito.
Número de la nota de crédito; null mientras es un borrador.
Estado del ciclo de vida del documento: draft, validated o voided (los mismos valores que admite el filtro status).
Opciones disponibles: draft, validated, voided
Fecha de emisión en ISO 8601 UTC; null si no consta.
Moneda, como código ISO 4217.
Contacto al que se emite la nota de crédito; null si no consta.
Factura que rectifica esta nota de crédito; null si no está asociada a ninguna.
Subtotal antes de descuentos e impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total de impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Base imponible, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total con impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Fecha de creación en ISO 8601 UTC.
Fecha de la última modificación en ISO 8601 UTC.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta POST /api/v1/credit-notes/{creditNoteId}/void.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasAbonos
Anular una nota de crédito
Anula una nota de crédito VALIDADA con un motivo, que es obligatorio y se conserva.
Guías
Escrituras seguras
Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.
Guías
Errores
Un error de herramienta es un resultado con
isError: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?