--- title: "Listar Carnês" method: GET path: "/v1/installments" tags: ["Carnês"] --- # Listar Carnês `GET /v1/installments` Lista Carnês. ## Query parameters - `page` integer - `per_page` integer ## Headers - `User-Agent` string ## Response `200` Sucesso na listagem de carnês - InstallmentObject[] - `id` integer — ID do carnê - `bank_billet_account_id` integer, required — ID da Carteira de Cobrança. Se não informado, usará a carteira padrão. - `bank_billet_layout_id` integer, nullable — ID do Modelo de Boleto - `amount` number, float, required — Quantia - `customer_id` integer, nullable — ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios. - `customer_person_name` string, required — Nome do cliente - `customer_cnpj_cpf` string, required — CPF/CNPJ do cliente - `customer_state` string, required — Estado - `customer_city_name` string, required — Cidade(Nome deve estar correto e completo) - `customer_zipcode` string, required — CEP (formato 99999999) - `customer_address` string, required — Endereço - `customer_address_complement` string — Complemento - `customer_address_number` string — Número - `customer_email` string, email — E-mail do Pagador - `customer_email_cc` string, email — E-mail alternativo do Pagador - `customer_neighborhood` string, required — Bairro - `customer_phone_number` string — Telefone (com DDD) - `customer_ignore_email` boolean, nullable — Nunca enviar e-mail para este cliente - `customer_ignore_sms` boolean, nullable — Nunca enviar SMS para este cliente - `customer_mobile_local_code` string, nullable — DDD do Celular - `customer_mobile_number` string, nullable — Celular - `customer_nickname` string, nullable — Apelido ou Nome Fantasia do Pagador - `customer_notes` string, nullable — Observações do Pagador - `customer_contact_person` string, nullable — Contato - `customer_update` string, nullable — Contato - `start_at` string, date, required — Data da primeira cobrança - `end_at` string, date, nullable — Data da última cobrança - `cycle` 'biweekly' | 'bimonthly' | 'monthly' | 'quarterly' | 'semiannual' | 'annual', nullable — Ciclo do carnê. Default: monthly * `biweekly` Quinzenal * `bimonthly` Bimestral * `monthly` Mensal * `quarterly` Trimestral * `semiannual` Semestral * `annual` Anual - `total` integer, required — Quantidade de parcelas - `custom_bank_billets` CustomBankBilletsObject[], nullable — Carnê customizado. Quando enviado, os valores de amount, start_at e end_at serão ignorados. - `amount_cents` integer, required — Valor da parcela (R$) com 2 casas decimais. Formato: 134556 corresponde 1.345,56 - `expire_at` string, date, required — Data de vencimento - `bank_billet_ids` integer[], nullable — IDs de boletos vinculados ao carnê - `interest_type` 0 | 1 | 2, nullable — Tipo de juros/mora: * `0` Inexistente (Padrão) * `1` Para porcentagem diária * `2` Para valor diário - `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 diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1. - `interest_value` number, float, nullable — Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. - `interest_days_type` 0 | 1, nullable — Tipo de Dias para juros: * `0` Corridos * `1` Úteis - `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). - `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 - `fine_value` number, float, nullable — Valor da multa (R$). Obrigatório se fine_type é igual a 2. - `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), Não pode resultar numa data passada referente a criação. - `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$). - `tags` string[], nullable — Tags associadas ao boleto - `guarantor_name` string, nullable — Nome do Beneficiário final (Sacador/Avalista) - `guarantor_cnpj_cpf` string, nullable — CNPJ/CPF do Beneficiário final (Sacador/Avalista) - `guarantor_address_number` string, nullable — Número do Beneficiário final (Sacador/Avalista) - `guarantor_neighborhood` string, nullable — Bairro do Beneficiário final (Sacador/Avalista) - `guarantor_phone_number` string, nullable — Telefone (com DDD) do Beneficiário final (Sacador/Avalista) - `guarantor_city_name` string, nullable — Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista) - `guarantor_state` string, nullable — Estado do Beneficiário final (Sacador/Avalista) - `guarantor_zipcode` string, nullable — CEP (formato 99999999) do Beneficiário final (Sacador/Avalista) - `guarantor_address` string, nullable — Endereço do Beneficiário final (Sacador/Avalista) - `guarantor_address_complement` string, nullable — Complemento do Beneficiário final (Sacador/Avalista) - `description` string, nullable — Descrição do produto ou serviço - `instructions` string, nullable — Instruções para o Caixa - `document_date` string, date, nullable — Data do Documento - `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', required — 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 - `document_number` string, nullable — Número do Documento, Tamanho depende do banco e formato do arquivo Remessa: * Banco | Formato| Tamanho | * Abc |`Cnab240`| 15 | * Ailos |`Cnab240`| 15 | * Arbi |`Cnab240`| 15 | * Banese |`Cnab240`| 15 | * Banestes |`Cnab400`| 10 | * Banrisul |`Cnab240`| 15 | * Banrisul |`Cnab400`| 10 | * Bb |`Cnab240`| 15 | * Bb |`Cnab400`| 10 | * Bib |`Cnab240`| 15 | * Bnb |`Cnab400`| 10 | * Bnpparibas |`Cnab400`| 10 | * Bradesco |`Cnab240`| 15 | * Bradesco |`Cnab400`| 10 | * Brb |`Cnab400`| 10 | * Caixa |`Cnab240`| 11 | * Caixa |`Cnab400`| 10 | * Caruana |`Cnab400`| 10 | * Citibank |`Cnab400`| 10 | * Credisis |`Cnab240`| 15 | * Cresol |`Cnab240`| 10 | * Cresol |`Cnab400`| 10 | * Cresol Bradesco |`Cnab240`| 15 | * Cresol Bradesco |`Cnab400`| 10 | * Daycoval |`Cnab400`| 10 | * Itau |`Cnab240`| 10 | * Itau |`Cnab400`| 10 | * Mercantil |`Cnab240`| 10 | * Moneyplus |`Cnab240`| 10 | * Rendimento |`Cnab400`| 10 | * Safra |`Cnab400`| 102 | * Santander |`Cnab240`| 15 | * Santander |`Cnab400`| 10 | * Semear |`Cnab400`| 10 | * Sicoob |`Cnab240`| 15 | * Sicoob |`Cnab400`| 10 | * Sicredi |`Cnab240`| 15 | * Sicredi |`Cnab400`| 10 | * Sofisa |`Cnab240`| 15 | * Unicred |`Cnab240`| 15 | * Uniprime |`Cnab400`| 10 | * Uniprime99 |`Cnab400`| 10 | * Santander |`Cnab400`| 10 - `days_for_revoke` integer, nullable — Dias corridos para Baixa/Devolução: Nulo/Branco: Obedece ao padrão do banco. 0: Baixa/Devolução no mesmo dia do vencimento. 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos). - `days_for_negativation` integer, nullable — Dias corridos para Negativação: Disponível apenas para os seguintes bancos e formatos. * Banco | CNAB 240| CNAB 400 |Webservice * Bradesco | Sim | Sim | Não * Itaú | Não | Sim | Não - `days_for_sue` integer, nullable — Dias corridos para Protesto - `divergent_payment_type` null | 1 | 2 | 3 | 4, nullable — Tipo de pagamento divergente: Válido apenas para Itaú e Caixa. * `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 - `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 - `divergent_payment_maximum_value` number, float, nullable — Valor máximo para a faixa de pagamentos divergentes. - `divergent_payment_minimum_value` number, float, nullable — Valor mínimo para a faixa de pagamentos divergentes. - `divergent_payment_maximum_percentage` number, float, nullable — Percentual máximo para a faixa de pagamentos divergentes. - `divergent_payment_minimum_percentage` number, float, nullable — Percentual mínimo para a faixa de pagamentos divergentes. - `divergent_payment_limit` integer, nullable — Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa. - `prevent_registration` boolean, nullable — Impedir envio de registro ao banco: Caso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema. - `notes` string, nullable — Observações - `custom_attachment_name` string, nullable — Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID. - `created_via_api` boolean, nullable — Indica se o boleto foi criado por API - `created_at` string, date-time, nullable — Data e hora de criação do boleto - `updated_at` string, date-time, nullable — Data e hora da última atualização do boleto - `payment_count` integer, nullable — Quantidade de pagamentos parciais aceitos para este boleto. - `url` string, nullable — URL para visualização do carnê - `status` 'created' | 'processed' | 'generated' — Situação do carnê: * `created` Gerando * `processed` Parcelas criadas * `generated` Aberto - `import_id` integer, nullable — ID da Importação - `ignore_whatsapp` boolean, nullable — Nunca enviar este carnê por WhatsApp ## 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. --- [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)