---
title: "Atualiza o carnê"
method: PUT
path: "/api/CobrancaCarne/AtualizaCarne"
tags: ["CobrancaCarne"]
---

# Atualiza o carnê

`PUT /api/CobrancaCarne/AtualizaCarne`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI`
- URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaCarne/AtualizaCarne`
- Auth: OAuth 2
  - Password
  - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI`

Esta API permite atualizar um carnê.

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| CarneId | GUID | ID do carnê já cadastrado | Sim |
| Descricao| Texto | Descrição do carnê | Não |
| Valor | Numérico | Valor individual de cada parcela do carnê | Não |
| QuantidadeParcelas | Número | Quantidade de parcelas do carnê (mínimo de duas parcelas) | Não |
| Vencimento | Data | Data de vencimento do carnê | Não |
| NaoReceberDepoisDe | Data | Data limite para pagamento após o vencimento da cobrança | Não |
| Multa | Numérico | Valor da multa que será aplicado em todas as cobrança/parcela, em aberto | Não | 
| MultaCorrecao | Texto | Tipo da multa a ser aplicada - Percentual, Valor | Não | 
| JurosMes | Numérico | Juros mensais que será aplicado em todas as cobranças/parcelas, em aberto   | Não | 
| JurosCorrecao | Texto |  Tipo do juros a ser aplicado - Percentual, Valor | Não | 
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento que será aplicado em todas as cobrança/parcela, em aberto| Não | 
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado - Percentual, Valor | Não | 
| Instrucao1 | Texto | Instrução adicional para o carnê | Não | 
| Instrucao2 | Texto | Instrução adicional para o carnê | Não | 
| Instrucao3 | Texto | Instrução adicional para o carnê | Não | 
| Instrucao4 | Texto | Instrução adicional para o carnê | 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** | Lista de Objetos | Lista com o detalhamento de cada parcela |
| CobrancaId | GUID | Identificador único da Cobrança gerada |
| EstadoParcela | 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) |
| DadosPagamento | Objeto | Dados do pagamento |

## Headers

- `Aeskey` string, required

## Request body

- BknBankCobrancasBusinessAtualizarCarneBusinessModel
  - `CarneId` 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 `201`

Cobrança do tipo carnê atualizada com sucesso.

- BknBankCobrancasAPIModelsCobrancaCarneResponse
  - `CarneId` string, uuid
  - `Estado` 'Todos' | 'EmDia' | 'Finalizada' | 'Cancelada' | 'GerandoCarne' | 'Erro'
  - `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
    - `DadosPagamento` BknBankCobrancasAPIModelsPagamento: Modelo de Pagamento
      - `Id` string: Id do pagamento
      - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação do pagamento
      - `DataPagamento` string, date-time: Data do pagamento
      - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento
      - `DadosPagamento` string: Dados do pagamento
      - `ValorPago` number, double: Valor pago de pagamento
      - `ValorPrincipal` number, double: Valor principal de pagamento
      - `ValorMultaJuros` number, double: Valor multa/juros de pagamento
      - `NumeroPagamento` string: Número do pagamento
      - `ValorTaxas` number, double: Valor das taxas de pagamento
      - `ValorLiquido` number, double: Valor líquido de pagamento
      - `DataDisponibilizacao` string, date-time: Data de disponibilização pagamento
      - `ReembolsadoAoCliente` boolean: Indicação de reembolsado ao cliente do pagamento
      - `Antecipado` boolean: Indicativo se o pagamento foi antecipado
      - `TransacaoId` string, uuid: Id da Transacao relacionada a este pagamento
      - `CobrancaId` string, uuid: Id da Cobrança relacionada a este pagamento
      - `CanalPagamento` integer
      - `MeioPagamento` integer

## Other responses

- `400`: Dados inválidos do carnê
- `500`: Erro atualizando carnê

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)