Gets a list of debts and current status (Similar to the Collections - Default report)
GET
https://evo-integracao-api.w12app.com.br/api/v1/receivables/debtors
🌐 API Reference/Receivables
Obtener Historial de Deudas
Descripción
🔑 Parámetros de Consulta (Query Params)
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| dueDateStart | string (date-time) | No | Filtrar por fecha de vencimiento a partir de una fecha inicial (formato yyyy-mm-dd). |
| dueDateEnd | string (date-time) | No | Filtrar por fecha de vencimiento hasta una fecha final (formato yyyy-mm-dd). |
| registrationDateStart | string (date-time) | No | Filtrar por fecha de registro a partir de una fecha inicial (formato yyyy-mm-dd). |
| registrationDateEnd | string (date-time) | No | Filtrar por fecha de registro hasta una fecha final (formato yyyy-mm-dd). |
| paymentDateStart | string (date-time) | No | Filtrar por fecha de pago a partir de una fecha inicial (formato yyyy-mm-dd). |
| paymentDateEnd | string (date-time) | No | Filtrar por fecha de pago hasta una fecha final (formato yyyy-mm-dd). |
| membersIds | string | No | Lista de IDs de miembros separados por comas. |
| take | int32 | No | Cantidad de registros a devolver (máximo 50). Valor por defecto: 50. |
| skip | int32 | No | Cantidad de registros a omitir (paginación). Valor por defecto: 0. |
| idBranch | int32 | No | Filtrar por ID de la sucursal (solo para claves multilocal y cuando membersIds no está vacío). |
| memberStatus | string | No | Filtrar por estado del miembro. Valores posibles: 1 = Activo, 2 = Inactivo. Se pueden indicar varios valores separados por coma (ej.: 1,2). |
| debtStatus | string | No | Filtrar por estado de la deuda. Valores posibles: 1 = Abierta, 2 = Recuperada, 3 = Cancelada. Se pueden indicar varios valores separados por coma (ej.: 1,2). |
📤 Estructura de la Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| results | array<objeto> | Lista de deudas encontradas. |
| total | int32 | Cantidad total de registros encontrados. |
| summary | objeto | Resumen con valores totales y promedios de cobranza. |
🧩 Estructura del Objeto results
| Campo | Tipo | Descripción |
|---|---|---|
| memberId | int32 | ID del miembro asociado a la deuda. |
| name | string | Nombre del miembro. |
| memberStatus | string | Estado del miembro (Activo/Inactivo). |
| receivableId | int32 | ID de la cuenta por cobrar. |
| receivableIdOrigin | int32 | ID de origen de la cuenta por cobrar. |
| branchId | int32 | ID de la sucursal asociada a la deuda. |
| branchName | string | Nombre de la sucursal asociada a la deuda. |
| dueDate | string (date-time) | Fecha de vencimiento de la deuda. |
| paymentDate | string (date-time) | Fecha de pago de la deuda (si aplica). |
| registerDate | string (date-time) | Fecha de registro de la deuda. |
| originalDueDate | string (date-time) | Fecha de vencimiento original de la deuda. |
| chargeDate | string (date-time) | Fecha de cobro. |
| daysLate | int32 | Número de días de atraso. |
| debtAmount | number | Valor de la deuda. |
| paymentType | string | Tipo de pago utilizado (ej.: tarjeta, boleto). |
| idPaymentType | int32 | ID del tipo de pago. |
| debtStatus | string | Estado de la deuda (Abierta, Recuperada, Cancelada). |
| checkoutLink | string | Enlace para pago parcial de la deuda. |
| checkoutLinkFullDebt | string | Enlace para pago total de la deuda. |
| paymentOrigin | string | Origen del pago. |
| idMemberMembership | int32 | Identificador del contrato del alumno. |
| chargeAttemptsCount | int32 | Cantidad de intentos de cobro. |
| lastAcquirerDeclineReason | string | Último motivo de rechazo por el adquirente. |
🧩 Estructura del Objeto summary
| Campo | Tipo | Descripción |
|---|---|---|
| recoveredValue | number | Valor total recuperado. |
| recoveryAverage | number | Valor promedio recuperado por cobro. |
| pendingValue | number | Valor total pendiente. |
| pendingAverage | number | Valor promedio pendiente por cobro. |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/receivables/debtors?dueDateStart=undefined&dueDateEnd=undefined®istrationDateStart=undefined®istrationDateEnd=undefined&paymentDateStart=undefined&paymentDateEnd=undefined&membersIds=undefined&take=undefined&skip=undefined&idBranch=undefined&memberStatus=undefined&debtStatus=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
"results": [
{
"memberId": 0,
"name": "string",
"memberStatus": "string",
"receivableId": 0,
"receivableIdOrigin": 0,
"branchId": 0,
"branchName": "string",
"dueDate": "2019-08-24T14:15:22.123Z",
"paymentDate": "2019-08-24T14:15:22.123Z",
"registerDate": "2019-08-24T14:15:22.123Z",
"originalDueDate": "2019-08-24T14:15:22.123Z",
"chargeDate": "2019-08-24T14:15:22.123Z",
"daysLate": 0,
"debtAmount": 0,
"paymentType": "string",
"idPaymentType": 0,
"debtStatus": "string",
"checkoutLink": "string",
"checkoutLinkFullDebt": "string",
"paymentOrigin": "string",
"idMemberMembership": 0,
"chargeAttemptsCount": 0,
"lastAcquirerDeclineReason": "string"
}
],
"total": 0,
"summary": {
"recoveredValue": 0,
"recoveryAverage": 0,
"pendingValue": 0,
"pendingAverage": 0
}
}Modificado en 2026-05-15 13:34:34