HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Anular Invoice

Anula una Invoice para dejar de cobrarla.

Detiene los cobros de la Invoice y la marca como anulada. Por defecto, además la elimina; envía delete_invoice=false para conservarla anulada como registro histórico. La metadata que se envíe se combina con la que la Invoice ya tenía, en la misma operación que la anulación. Responde 404 si la Invoice no existe bajo la organización y Account autenticadas.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identificador público de la Invoice a anular (in_...).

Body Params

Campos del cuerpo para anular una Invoice.

boolean
required

Si es true (valor por defecto cuando se omite el cuerpo), además de anular la Invoice se elimina. Envía false para conservarla anulada como registro histórico.

metadata
object

Valores adicionales a guardar en la Invoice al anularla, útiles para dejar registrado por qué se anuló. Se combinan con la metadata existente: las claves enviadas se agregan o reemplazan y las demás se conservan. Se tratan como texto y no pueden superar los 256 caracteres cada uno.

Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json