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
Obter Histórico de Débitos
Descrição
🔑 Parâmetros de Consulta (Query Params)
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
| dueDateStart | string (date-time) | Não | Filtrar por data de vencimento a partir de uma data inicial (formato yyyy-mm-dd). |
| dueDateEnd | string (date-time) | Não | Filtrar por data de vencimento até uma data final (formato yyyy-mm-dd). |
| registrationDateStart | string (date-time) | Não | Filtrar por data de registro a partir de uma data inicial (formato yyyy-mm-dd). |
| registrationDateEnd | string (date-time) | Não | Filtrar por data de registro até uma data final (formato yyyy-mm-dd). |
| paymentDateStart | string (date-time) | Não | Filtrar por data de pagamento a partir de uma data inicial (formato yyyy-mm-dd). |
| paymentDateEnd | string (date-time) | Não | Filtrar por data de pagamento até uma data final (formato yyyy-mm-dd). |
| membersIds | string | Não | Lista de IDs de membros separados por vírgula. |
| take | int32 | Não | Quantidade de registros a serem retornados (máximo 50). Padrão: 50. |
| skip | int32 | Não | Quantidade de registros a serem ignorados na listagem (paginação). Padrão: 0. |
| idBranch | int32 | Não | Filtrar por ID da filial (apenas para uso com chaves multilocal e quando membersIds não está vazio). |
| memberStatus | string | Não | Filtrar por status do membro. Valores possíveis: 1 = Ativo, 2 = Inativo. Pode ser informado mais de um valor separado por vírgula (ex.: 1,2). |
| debtStatus | string | Não | Filtrar por status da dívida. Valores possíveis: 1 = Aberta, 2 = Recuperada, 3 = Cancelada. Pode ser informado mais de um valor separado por vírgula (ex.: 1,2). |
📤 Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| results | array<objeto> | Lista de débitos encontrados. |
| total | int32 | Quantidade total de registros encontrados. |
| summary | objeto | Resumo com valores totais e médias de cobrança. |
🧩 Estrutura do Objeto results
| Campo | Tipo | Descrição |
|---|---|---|
| memberId | int32 | ID do membro associado à dívida. |
| name | string | Nome do membro. |
| memberStatus | string | Status do membro (Ativo/Inativo). |
| receivableId | int32 | ID da conta a receber. |
| receivableIdOrigin | int32 | ID de origem da conta a receber. |
| branchId | int32 | ID da filial associada à dívida. |
| branchName | string | Nome da filial associada à dívida. |
| dueDate | string (date-time) | Data de vencimento da dívida. |
| paymentDate | string (date-time) | Data de pagamento da dívida (se houver). |
| registerDate | string (date-time) | Data de registro da dívida. |
| originalDueDate | string (date-time) | Data de vencimento original da dívida. |
| chargeDate | string (date-time) | Data de cobrança. |
| daysLate | int32 | Número de dias de atraso. |
| debtAmount | number | Valor da dívida. |
| paymentType | string | Tipo de pagamento utilizado (ex.: cartão, boleto). |
| idPaymentType | int32 | ID do tipo de pagamento. |
| debtStatus | string | Status da dívida (Aberta, Recuperada, Cancelada). |
| checkoutLink | string | Link de pagamento parcial da dívida. |
| checkoutLinkFullDebt | string | Link de pagamento do valor total da dívida. |
| paymentOrigin | string | Origem do pagamento. |
| idMemberMembership | int32 | Identificador do contrato do aluno. |
| chargeAttemptsCount | int32 | Contagem de tentativas de cobrança. |
| lastAcquirerDeclineReason | string | Último motivo para recusa do adquirente. |
🧩 Estrutura do Objeto summary
| Campo | Tipo | Descrição |
|---|---|---|
| recoveredValue | number | Valor total recuperado. |
| recoveryAverage | number | Valor médio recuperado por cobrança. |
| pendingValue | number | Valor total pendente. |
| pendingAverage | number | Valor médio pendente por cobrança. |
Request
Query Params
Responses
Request Request Example
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' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 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
}
}Modified at 2026-05-15 04:38:45