HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos principales
  2. Invoices

Listar Invoices

get
https://api.trytoku.com/invoices

Devuelve una lista paginada de Invoices de la organización.

Se usa para recorrer o conciliar Invoices; para obtener una Invoice puntual por su identificador prefiere el endpoint de detalle. Los filtros (Account, Customer, Subscription, estado, rango de fechas) son opcionales y se combinan con AND. Si la autenticación selecciona una Account, los resultados se acotan a ella. La paginación es por cursor: reenvía el next_cursor de la respuesta para avanzar de 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

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

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

string

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

string

Filtra las Invoices por el identificador público de la Subscription (sub_...).

general_status
array of objects

Filtra por estado general de la Invoice: paid está pagada por completo, partially_paid tiene abonos que no cubren el total, unpaid no registra pagos, void fue anulada y expired venció sin pagarse. Un cobro en curso no cambia el estado general. Puede repetirse para incluir varios estados.

general_status
Allowed:
boolean

Si es true, devuelve solo las Invoices con un cobro en curso (un pago aún no confirmado ni rechazado).

date-time

Devuelve solo las Invoices creadas desde esta fecha y hora (inclusive), en formato ISO 8601.

date-time

Devuelve solo las Invoices creadas hasta esta fecha y hora (inclusive), en formato ISO 8601.

string

Filtra por fecha de vencimiento exacta, en formato YYYY-MM-DD.

string

Devuelve solo las Invoices que vencen desde esta fecha (inclusive), en formato YYYY-MM-DD.

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

Updated 5 days ago

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

Updated 5 days ago

Did this page help you?