---
title: "Cria cobrança do tipo carnê"
method: POST
path: "/api/CobrancaCarne/InsereCarne"
tags: ["CobrancaCarne"]
---

# Cria cobrança do tipo carnê

`POST /api/CobrancaCarne/InsereCarne`

Esta API permite cadastrar uma cobrança do tipo carnê.

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| ClienteId | GUID | ID do pagador já cadastrado | Sim |
| Descricao| Texto | Descrição do carnê | Não |
| Valor | Numérico | Valor individual de cada parcela do carnê | Sim |
| QuantidadeParcelas | Numérico | Quantidade de parcelas do carnê (mínimo de duas parcelas) | Sim |
| Vencimento | Data | Data de vencimento do carnê | Sim |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela | Não |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança | Não | 
| MultaCorrecao | Texto | Tipo da multa a ser aplicada| Não | 
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança   | Não | 
| JurosCorrecao | Texto |  Tipo do juros a ser aplicado | Não | 
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento | Não | 
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado| Não | 

### 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) |

## Headers

- `Aeskey` string, required

## Request body

- BknBankCobrancasBusinessCriarCarneBusinessModel
  - `ClienteId` string, uuid
  - `Descricao` string
  - `Valor` number, double
  - `QuantidadeParcelas` integer
  - `Vencimento` string, date-time
  - `NaoReceberDepoisDe` string, date-time
  - `Multa` number, double
  - `MultaCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento'
  - `JurosMes` number, double
  - `JurosCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento'
  - `DescontoAteVencimento` number, double
  - `DescontoCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento'
  - `Instrucao1` string
  - `Instrucao2` string
  - `Instrucao3` string
  - `Instrucao4` string

## Response `200`

Cobrança do tipo carnê criada com sucesso.

- 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

- `400` — Dados inválidos da cobrança carnê
- `500` — Erro criando cobrança carnê

---

[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)