Listar débitos da empresa

GET

/v2/debts

Lista os débitos da empresa do usuário, exibidos na aba Débitos da tela Saldo e Consumo.

Os débitos surgem quando a cobrança mensal de custódia de CPR não encontra saldo suficiente e são quitados automaticamente quando a empresa recebe créditos. Na quitação parcial, o débito original fica paid com o valor pago e um novo débito open é criado com o restante. month e year filtram pela data do débito (debtDate); sem filtro, vêm todos os meses. total conta os débitos do filtro sem a paginação, e totalOpen soma o amount dos débitos em aberto (open) no filtro.

Lista apenas os débitos da empresa do usuário. offset, limit (de 1 a 100), month ou year inválidos devolvem 422.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Dívidas da empresa

Bodyapplication/json

🟠401Unauthorized

🟠422Parâmetros de consulta inválidos

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/debts?offset=0&limit=20&month=11&year=2026' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "id": "8d2f6a10-0000-4000-8000-00000000d001",
            "debtDate": "2026-11-30T03:00:00.000Z",
            "amount": 14,
            "status": "open",
            "paidAt": null,
            "userName": null,
            "productName": "Custódia de CPR",
            "clientName": "Fazenda Exemplo Ltda",
            "taxId": "11222333000181",
            "details": {
                "cprId": "3f2b8c1e-0000-4000-8000-00000000c001",
                "requestDate": "2026-03-02T14:11:00.000Z",
                "dueDate": "2026-09-10T03:00:00.000Z",
                "value": 400000
            }
        }
    ],
    "total": 1,
    "totalOpen": 14
}

Modificado em 2026-10-22 14:09:50

Página anterior

Listar pessoas do grupo econômico de um cliente

Próxima página

ClientResponse