Skip to main content
GET
Listar deudas

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Parámetros de consulta

status
enum<string>

Filtrar por estado. Valor inválido devuelve 400. Como el listado no incluye canceladas, CANCELLED siempre devuelve una lista vacía.

Opciones disponibles:
PENDING,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
externalClientId
string

Filtrar por deudor

externalRequestId
string

Filtrar por llave externa (deuda única)

batchId
string

Filtrar por lote o suscripción de origen

createdAtFrom
string

Inicio del rango de creación. Acepta fecha (YYYY-MM-DD) o date-time RFC 3339; otro formato devuelve 400. Una fecha sola cubre el día UTC completo desde 00:00:00.000Z. Un date-time se convierte a UTC y la precisión del filtro es diaria (se incluye el día UTC completo que lo contiene). Un createdAtFrom futuro sin createdAtTo devuelve una lista vacía.

Ejemplo:

"2026-09-24"

createdAtTo
string

Fin del rango de creación, inclusivo. Acepta fecha (YYYY-MM-DD) o date-time RFC 3339; otro formato devuelve 400. Una fecha sola incluye el día UTC completo hasta 23:59:59.999Z, así que createdAtFrom y createdAtTo con la misma fecha devuelven las de ese día. Un date-time se convierte a UTC con precisión diaria (se incluye el día UTC que lo contiene; exactamente a las 00:00:00Z no incluye ese día). Sin createdAtTo, el rango llega hasta hoy. createdAtFrom posterior a createdAtTo devuelve 400 (createdAtFrom must be earlier than or equal to createdAtTo.).

Ejemplo:

"2026-09-24"

minAmount
number

Monto mínimo en pesos (mayor o igual a 0, hasta 2 decimales; si no, 400)

Rango requerido: x >= 0
maxAmount
number

Monto máximo en pesos (mayor o igual a 0, hasta 2 decimales). Menor a minAmount devuelve 400.

Rango requerido: x >= 0
page
integer
predeterminado:1
Rango requerido: x >= 1
limit
integer
predeterminado:50
Rango requerido: 1 <= x <= 500

Respuesta

Lista de deudas

data
object[]
meta
object

Metadatos de paginación. page default 1; limit default 50, máximo 500. Valores inválidos de page o limit toman el default (no dan 400) y un limit mayor a 500 se recorta a 500; meta.limit refleja el valor aplicado.

requestId
string