HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Actualizar documento de ajuste

Actualiza un documento de ajuste. is_void controla su disponibilidad al momento del cobro (los documentos anulados se excluyen y no pueden aplicarse como saldo a favor); metadata reemplaza la metadata libre almacenada. Ambos campos son opcionales: omite un campo para dejarlo sin cambios y envía metadata={} para vaciarla. La llamada es idempotente: fijar un campo a su valor actual no tiene efecto y devuelve el documento sin cambios.

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
^ad_[a-zA-Z0-9_\-]{32}$

Identificador público del documento de ajuste (ad_...).

Body Params

Subclass of BaseModel that allows public aliases for fields. _aliases defines aliases in the way "external": "internal"

boolean

Envía true para anular el documento (se excluirá de la disponibilidad al momento del cobro) o false para restaurar un documento previamente anulado. Omítelo para dejarlo sin cambios.

date-time

Fija la fecha y hora de emisión (UTC) cuando se envía. Omítelo para dejarlo sin cambios.

metadata
object

Reemplaza la metadata libre almacenada cuando se envía. Omítelo para dejarlo sin cambios; envía {} para vaciarla.

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