---
title: "Resumo do saldo devedor"
method: GET
path: "/credit-card-receivables/balance-summary"
tags: ["Credit Card Receivables"]
---

# Resumo do saldo devedor

`GET /credit-card-receivables/balance-summary`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/credit-card-receivables/balance-summary`
- Auth: OAuth 2
  - Authorization code: `https://id.btgpactual.com/oauth2/authorize`
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `brn:btg:empresas:credit:receivables-credit-card.readonly`, `brn:btg:empresas:credit:receivables-credit-card`

Obtém um resumo dos valores não quitados ou ainda não recebidos pelas credenciadoras dos recebíveis antecipados

## Response `200`

Success

- BalanceSummary
  - `companyId` string: CNPJ da empresa
  - `overdueReceivablesUnpaidAmount` string, double: Soma dos valores não quitados de recebíveis vencidos
  - `dueTodayReceivablesUnpaidAmount` string, double: Soma dos valores não quitados de recebíveis vencendo hoje
  - `receivablesOverdue` object[]: Lista de recebíveis não liquidados
    - `status` 'Available' | 'WaitingRegistration' | 'InDisbursement' | 'Settled' | 'Overdue' | 'Cancelled': Status do recebível
    - `balance` string: Saldo do recebível
    - `interestArrears` string: Juros de mora
    - `latePaymentFee` string: Taxa de atraso
    - `penaltyFee` string: Multa
    - `maturityDate` string, date: Data de vencimento da transação

## Other responses

- `400`: Validation Error
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
