--- title: "Atualizar o Boleto" method: PUT path: "/v1/bank_billets/{id}" tags: ["Boletos"] --- # Atualizar o Boleto `PUT /v1/bank_billets/{id}` Atualiza informações específicas de um Boleto. Você pode alterar boletos no status de Aberto(`opened`) ou Vencido(`overdue`) Você receberá webhooks `generating` e `opened` para o boleto alterado. Em carteiras registradas, a alteração irá entrar na remessa e pode ser cobrada taxa bancária. ## Path parameters - `id` string, required ## Headers - `User-Agent` string - `X-Idempotency-Key` string ## Request body - BankBilletUpdateObject - `amount` number, float — Valor do Boleto - `expire_at` string, date — Data de vencimento - `tags` string[], nullable — Tags associadas ao boleto - `notes` string, nullable — Observações - `days_for_sue_type` null | 0 | 1, nullable — Tipo de dias para protesto: * `0` Corridos * `1` Úteis - `days_for_sue` integer, nullable — Dias corridos para Protesto - `days_for_revoke` integer, nullable — Dias corridos para Baixa Bancos Suportados: Itaú - `sue_code` string, nullable — Código de Protesto(Somente por CNAB 240). Consulte os possíveis valores para cada banco. - `instructions` string, nullable — Instruções para o Caixa - `description` string, nullable — Descrição do produto ou serviço - `interest_type` 0 | 1 | 2 | 7, nullable — Tipo de juros/mora: * `0` Inexistente (Padrão) * `1` Para porcentagem diária * `2` Para valor diário * `7` Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi - `days_for_interest` integer, nullable — Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento). - `interest_percentage` number, float, nullable — Porcentagem de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais. - `interest_value` number, float, nullable — Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. Até 2 casas decimais. - `discount_type` 0 | 1 | 2, nullable — Tipo de desconto: O tipo de desconto será o mesmo para todos os três descontos, caso existam. : * `0` Inexistente (Padrão) * `1` Para valor fixo * `2` Para percentual do valor do boleto - `days_for_discount` integer, nullable — Dias para desconto. Obrigatório se discount_type é diferente de 0(zero) - `discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2 - `discount_value` number, float, nullable — Valor do desconto (R$). Obrigatório se discount_type é igual a 1. - `days_for_second_discount` integer, nullable — Dias para segundo desconto. - `second_discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao segundo desconto. - `second_discount_value` number, float, nullable — Valor do segundo desconto (R$). - `days_for_third_discount` integer, nullable — Dias para terceiro desconto. - `third_discount_percentage` number, float, nullable — Percentual do valor do boleto equivalente ao terceiro desconto. - `third_discount_value` number, float, nullable — Valor do terceiro desconto (R$). - `reduction_type` 1 | 2 | 3, nullable — Tipo de abatimento: `1`: Valor. `2`: Porcentagem. `3`: Sem abatimento - `reduction_amount` number, float — Valor do abatimento. Obrigatório se reduction_type é igual a 1. - `reduction_percentage` number, float, nullable — Porcentagem de Abatimento. Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se reduction_type é igual a 2. Até 2 casas decimais. - `divergent_payment_type` null | 1 | 2 | 3 | 4, nullable — Tipo de pagamento divergente: * `1` Aceita qualquer valor divergente * `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais * `3` Não aceita pagamento de valores divergentes * `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo Bancos suportados: Itaú - `divergent_payment_value_type` null | 1 | 2, nullable — Tipo de valor a considerar para os limites de pagamentos: Válido apenas para Itaú e Caixa. * `1` Informa pagamentos divergentes por valores * `2` Informa pagamentos divergentes por percentuais Bancos suportados: Itaú - `divergent_payment_maximum_value` number, float, nullable — Valor máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú - `divergent_payment_minimum_value` number, float, nullable — Valor mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú - `divergent_payment_maximum_percentage` number, float, nullable — Percentual máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú - `divergent_payment_minimum_percentage` number, float, nullable — Percentual mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú - `fine_type` 0 | 1 | 2, nullable — Tipo de multa: * `0` Inexistente (Padrão) * `1` Para percentual do valor do boleto * `2` Para valor fixo - `days_for_fine` integer, nullable — Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento). - `credit_bureau` null | 0 | 1 | 2, nullable — Birô de Crédito/Órgão Negativador. `0`: Serasa. `1`: Quod. `2`: SPC Opções disponíveis para cada banco suportado: * Banco do Brasil: Serasa e Quod. - `days_for_negativation` integer, nullable — Quantidade de dias após o vencimento para negativar o título. - `fine_percentage` number, float, nullable — Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1. Até 2 casas decimais. - `fine_value` number, float, nullable — Valor da multa (R$). Obrigatório se fine_type é igual a 2. Até 2 casas decimais. - `document_number` string, nullable — Número do Documento, Tamanho depende do banco, formato e forma de envio (API / EDI): * Itau |`Cnab240`| 10 | * Itau |`Cnab400`| 10 | - `customer_person_name` string — Nome do cliente. Bancos Suportados: Santander - `customer_cnpj_cpf` string — CPF/CNPJ do cliente. Bancos Suportados: Santander - `customer_state` string — Estado. Bancos Suportados: Santander - `customer_city_name` string — Cidade(Nome deve estar correto e completo). Bancos Suportados: Santander - `customer_zipcode` string — CEP (formato 99999999). Bancos Suportados: Santander - `customer_address` string — Endereço. Bancos Suportados: Santander - `customer_neighborhood` string — Bairro. Bancos Suportados: Santander - `guarantor_name` string, nullable — Nome do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander - `guarantor_cnpj_cpf` string, nullable — CNPJ/CPF do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander - `document_type` '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '99' — Tipo de Documento: * `Código` | `Sigla` | Descrição * `01` | `CH` | Cheque * `02` | `DM` | Duplicata Mercantil (Padrão) * `03` | `DMI` | Duplicata Mercantil p/ Indicação * `04` | `DS` | Duplicata de Serviço * `05` | `DSI` | Duplicata de Serviço p/ Indicação * `06` | `DR` | Duplicata Rural * `07` | `LC` | Letra de Câmbio * `08` | `NCC` | Nota de Crédito Comercial * `09` | `NCE` | Nota de Crédito a Exportação * `10` | `NCI` | Nota de Crédito Industrial * `11` | `NCR` | Nota de Crédito Rural * `12` | `NP` | Nota Promissória * `13` | `NPR` | Nota Promissória Rural * `14` | `TM` | Triplicata Mercantil * `15` | `TS` | Triplicata de Serviço * `16` | `NS` | Nota de Seguro * `17` | `RC` | Recibo * `18` | `FAT` | Fatura * `19` | `ND` | Nota de Débito * `20` | `AP` | Apólice de Seguro * `21` | `ME` | Mensalidade Escolar * `22` | `PC` | Parcela de Consórcio * `23` | `NF` | Nota Fiscal * `24` | `DD` | Documento de Dívida * `25` | `CPR` | Cédula de Produto Rural * `26` | `CTR` | Contrato * `27` | `CSG` | Cosseguros * `28` | `EC` | Encargos Condominiais * `29` | `CPS` | Conta de Prestação de Serviços * `30` | `WR` | Warrant * `31` | `DP` | Duplicata Prestação * `32` | `CSR` | Cobrança Seriada * `33` | `CAR` | Carnê * `34` | `ARE` | Apólice Ramos Elementares * `35` | `CC` | Cartão de Crédito * `36` | `BDP` | Boleto de Proposta * `37` | `NPD` | Nota Promissória Direta * `38` | `DAE` | Dívida Ativa de Estado * `39` | `DAM` | Divida Ativa de Município * `40` | `DAU` | Dívida Ativa União * `41` | `CCB` | Célula de Crédito Bancário * `42` | `FI` | Financiamento * `43` | `RD` | Rateio de Despesas * `44` | `DRI` | Duplicata Rural p/ Indicação * `45` | `ECI` | Encargos Condominiais p/ Indicação * `99` | `Outros` | Outros Bancos Suportados: Santander - `control_number` string, nullable — Número de controle: Pode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno. Bancos Suportados: Santander - `payment_count` integer, nullable — Quantidade de pagamentos parciais aceitos para este boleto. Bancos Suportados: Santander - `issued_at` string, date, nullable — Data de emissão. Bancos Suportados: Santander - `bolepix_key` string, nullable — Chave do bolepix. Bancos Suportados: Santander - `pix_txid` string, nullable — TxId do pix. Bancos Suportados: Santander ## Response `204` Boleto atualizado ## Other responses - `401` — Falha de autenticação. Token inválido - `403` — Falha de permissão. Você não tem o Scope obrigatório para essa chamada. - `404` — Boleto não encontrado - `422` — Campos não suportados pelo banco --- [API](https://skmtc.net/kobana/apis/cobran-as.md) · [All operations](https://skmtc.net/kobana/apis/cobran-as/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kobana/cobran-as/versions/728c362ec4d7/schema)