HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Listar documentos de ajuste

Devuelve una lista paginada de los documentos de ajuste de la organización, del más reciente al más antiguo. Se usa para recorrer o conciliar los documentos registrados, por ejemplo todos los de un Customer con customer_id. Incluye los documentos anulados, con status=void. Los filtros son opcionales y se combinan con AND. La paginación es por cursor: reenvía el next_cursor de la respuesta para avanzar de página; es null en la última página.

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…
Query Params
integer
≤ 100
Defaults to 50

Cantidad máxima de elementos por página (entre 1 y 100).

string
length ≤ 512
^[A-Za-z0-9_\-]+$

Cursor de la página siguiente. Envía el next_cursor devuelto en la respuesta anterior para continuar; omítelo en la primera llamada.

string
^cus_[A-Za-z0-9_\-]{32}$

Filtra por el identificador público del Customer (cus_...).

string
^acc_[A-Za-z0-9_\-]{32}$

Filtra por el identificador público de la Account (acc_...).

string
^in_[A-Za-z0-9_\-]{32}$

Filtra por el identificador público de la Invoice de origen (in_...).

enum

Filtra por categoría del documento: credit_note o supplier_invoice.

Allowed:
status
array of objects

Filtra por estado del documento: available, used o void. Puede repetirse para incluir varios estados, hasta 3 veces.

status
Allowed:
string
length between 1 and 256
^[^\u0000-\u001F\u007F-\u009F]+$

Filtra por el identificador definido por la organización (1 a 256 caracteres).

date-time

Devuelve solo los documentos emitidos desde esta fecha y hora (inclusive), en formato ISO 8601 con hora; una fecha sola se rechaza. Sin zona horaria se interpreta como UTC.

date-time

Devuelve solo los documentos emitidos hasta esta fecha y hora (inclusive), en formato ISO 8601 con hora; una fecha sola se rechaza. Sin zona horaria se interpreta como UTC. No puede ser anterior a issued_at_from.

Headers
string

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

Responses

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