Obter Histórico de Débitos

Descrição

Retorna uma lista de débitos e seus respectivos status atuais, de forma semelhante ao relatório de Cobranças - Inadimplência. Permite filtrar por datas de vencimento, registro, pagamento, membros específicos, filial, status do membro e status da dívida. Os resultados podem ser paginados e acompanhados por um resumo financeiro com totais e médias.

🔑 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

A resposta retorna uma lista paginada de débitos com informações do membro, valores, datas e status, além de um resumo com totais e médias.

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.

🧩 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.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "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"
        }
    ],
    "total": 0,
    "summary": {
        "recoveredValue": 0,
        "recoveryAverage": 0,
        "pendingValue": 0,
        "pendingAverage": 0
    }
}

🟠400Bad Request

Gets a list of debts and current status (Similar to the Collections - Default report)

Obter Histórico de Débitos#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto results#

🧩 Estrutura do Objeto summary#

Requisição