---
title: "Consulta Cobrança do tipo carnê"
method: GET
path: "/api/CobrancaCarne/ConsultaCarne"
tags: ["CobrancaCarne"]
---

# Consulta Cobrança do tipo carnê

`GET /api/CobrancaCarne/ConsultaCarne`

Esta API permite realizar consulta dos carnês através do Id.

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| CarneId | GUID | ID do carnê já cadastrado| Sim |

### Resposta 
| **Campo** | **Tipo** | **Descrição** |
|--|--|--| 
| CarneId | GUID | Identificador único do carnê gerado |
| Estado | Texto | Estado que o carnê se encontra |
| ImgBase64 | Texto | Base64 do PDF completo do carnê |
| **Parcelas** | **CarneParcelas** | **Lista com o detalhamento de cada parcela** |
| CobrancaId | GUID | Identificador único da Cobrança gerada |
| Estado | Texto | Estado da cobrança |
| Valor | Numérico | Valor da parcela |
| Vencimento | Data | Data de vencimento da parcela |
| NossoNumero | Texto | Nosso Número do boleto gerado |
| LinhaDigitavel | Texto | Linha digitável do boleto gerado |
| CodigoBarras | Texto | Código de Barras do boleto gerado |
| QRCodeTexto | Texto | Copia e cola do pix (se for gerado como Boleto Híbrido) |
| QRCodeImagem | Texto | Imagem do QRCode do pix (se for gerado como Boleto Híbrido) |

## Query parameters

- `Id` string, required

## Headers

- `Aeskey` string, required

## Response `200`

Cobrança do tipo Carnê consultada

- BknBankCobrancasAPIModelsCobrancaCarneResponse
  - `CarneId` string, uuid
  - `Estado` 'Todos' | 'EmDia' | 'Finalizada' | 'Cancelada' | 'GerandoCarne'
  - `ImgBase64` string
  - `Parcelas` BknBankCobrancasAPIModelsParcela[]
    - `CobrancaId` string, uuid
    - `EstadoParcela` 'Todos' | 'Pendente' | 'Paga' | 'Inadimplente' | 'PendenteRegistro' | 'Cancelada'
    - `Valor` number, double
    - `Vencimento` string, date-time
    - `NossoNumero` string
    - `LinhaDigitavel` string
    - `CodigoBarras` string
    - `QRCodeTexto` string
    - `QRCodeImagem` string

## Other responses

- `401` — Não há permissão para acessar este carnê
- `404` — Não existe a carnê por Id
- `500` — >Id inválido do carnê ou erro carregando o mesmo

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)