---
title: "Consultar posição do crédito por contrato"
method: GET
path: "/prepayment/{contract_number}/balance"
tags: ["Prepayment"]
---

# Consultar posição do crédito por contrato

`GET /prepayment/{contract_number}/balance`

O objetivo dessa rota é exibir a posição do contrato.

## Path parameters

- `contract_number` string, required — Identificador do contrato

## Query parameters

- `fund_tax_id` string, required — CNPJ/CPF
- `position_date` string — Data de vencimento

## Response `200`

Sucesso

- BalanceSchema[]
  - `amortization_type` string — Tipo de amortização
  - `balance_date` string — Data da posição
  - `contract_number` string — Identificação do contrato da operação
  - `currency` string — Moeda
  - `installments` object[]
    - `amount_at_maturity` number — Valor de vencimento da parcela
    - `curve_value` number — Valor da parcela na curva
    - `discount` number — Valor de desconto da parcela
    - `installment_number` number — Número da parcela
    - `principal` number — Valor de principal da parcela
    - `status_description` string — Status da parcela
  - `is_vnp` boolean — Indicador se o contrato está inadimplente
  - `position_date` string — Data da posição
  - `trade_id` string — Identificador do trade

## Other responses

- `400` — Erro
- `401` — Não autorizado

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)