Criar um Carnê

post https://{apiHost}/v1/installments

Body Params

Informações a serem salvas no 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 | null

ID do Modelo de Boleto

amount

float

required

Quantia

customer_id

integer | null

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

length ≤ 120

Nome do cliente

customer_cnpj_cpf

string

required

length ≤ 20

CPF/CNPJ do cliente

customer_state

string

required

length ≤ 2

Estado

customer_city_name

string

required

length ≤ 60

Cidade(Nome deve estar correto e completo)

customer_zipcode

string

required

length ≤ 8

CEP (formato 99999999)

customer_address

string

required

length ≤ 255

Endereço

customer_address_complement

string

length ≤ 120

Complemento

customer_address_number

string

length ≤ 10

Número

customer_email

string

length ≤ 80

E-mail do Pagador

customer_email_cc

string

length ≤ 80

E-mail alternativo do Pagador

customer_neighborhood

string

required

length ≤ 80

Bairro

customer_phone_number

string

length ≤ 11

Telefone (com DDD)

customer_ignore_email

boolean | null

Nunca enviar e-mail para este cliente

customer_ignore_sms

boolean | null

Nunca enviar SMS para este cliente

customer_mobile_local_code

string | null

DDD do Celular

customer_mobile_number

string | null

Celular

customer_nickname

string | null

Apelido ou Nome Fantasia do Pagador

customer_notes

string | null

Anotações do Pagador

customer_contact_person

string | null

Contato

customer_update

string | null

Contato

start_at

date

required

Data da primeira cobrança

end_at

date | null

Data da última cobrança

total

integer

required

≤ 300

Quantidade de parcelas

custom_bank_billets

array of objects | null

Carnê customizado. Quando enviado, os valores de amount, start_at e end_at serão ignorados.

custom_bank_billets

interest_type

integer | null

Defaults to 0

Tipo de juros/mora:

0 Inexistente (Padrão)
1 Para porcentagem diária
2 Para valor diário

days_for_interest

integer | null

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

float | null

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

float | null

Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.

interest_days_type

integer | null

Defaults to 0

Tipo de Dias para juros:

0 Corridos
1 Úteis

fine_type

integer | null

Defaults to 0

Tipo de multa:

0 Inexistente (Padrão)
1 Para percentual do valor do boleto
2 Para valor fixo

days_for_fine

integer | null

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

float | null

Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1

fine_value

float | null

Valor da multa (R$). Obrigatório se fine_type é igual a 2.

discount_type

integer | null

Defaults to 0

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 | null

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

float | null

Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2

discount_value

float | null

Valor do desconto (R$). Obrigatório se discount_type é igual a 1.

days_for_second_discount

integer | null

Dias para segundo desconto.

second_discount_percentage

float | null

Percentual do valor do boleto equivalente ao segundo desconto.

second_discount_value

float | null

Valor do segundo desconto (R$).

days_for_third_discount

integer | null

Dias para terceiro desconto.

third_discount_percentage

float | null

Percentual do valor do boleto equivalente ao terceiro desconto.

third_discount_value

float | null

Valor do terceiro desconto (R$).

tags

array of strings | null

Tags associadas ao boleto

tags

guarantor_name

string | null

Nome do Beneficiário final (Sacador/Avalista)

guarantor_cnpj_cpf

string | null

CNPJ/CPF do Beneficiário final (Sacador/Avalista)

guarantor_address_number

string | null

Número do Beneficiário final (Sacador/Avalista)

guarantor_neighborhood

string | null

Bairro do Beneficiário final (Sacador/Avalista)

guarantor_phone_number

string | null

Telefone (com DDD) do Beneficiário final (Sacador/Avalista)

guarantor_city_name

string | null

Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)

guarantor_state

string | null

Estado do Beneficiário final (Sacador/Avalista)

guarantor_zipcode

string | null

CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)

guarantor_address

string | null

Endereço do Beneficiário final (Sacador/Avalista)

guarantor_address_complement

string | null

Complemento do Beneficiário final (Sacador/Avalista)

description

string | null

Descrição do produto ou serviço

instructions

string | null

Instruções para o Caixa

document_date

date | null

Data do Documento

document_type

string

required

length ≤ 2

Defaults to 02

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 Promissó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 | null

days_for_revoke

integer | null

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 | null

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 | null

Dias corridos para Protesto

divergent_payment_type

integer | null

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

integer | null

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

float | null

Valor máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_value

float | null

Valor mínimo para a faixa de pagamentos divergentes.

divergent_payment_maximum_percentage

float | null

Percentual máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_percentage

float | null

Percentual mínimo para a faixa de pagamentos divergentes.

divergent_payment_limit

integer | null

Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa.

prevent_registration

boolean | null

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 | null

Anotações

custom_attachment_name

string | null

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.

payment_count

integer | null

Quantidade de pagamentos parciais aceitos para este boleto.

ignore_whatsapp

boolean | null

Defaults to false

Nunca enviar este carnê por WhatsApp

Headers

User-Agent

string

Informar um e-mail válido para contatos.

X-Idempotency-Key

string

Chave de idempotência para evitar replay de processamento.

Responses

Response body

object

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 | null

ID do Modelo de Boleto

amount

float

required

Quantia

customer_id

integer | null

customer_person_name

string

required

length ≤ 120

Nome do cliente

customer_cnpj_cpf

string

required

length ≤ 20

CPF/CNPJ do cliente

customer_state

string

required

length ≤ 2

Estado

customer_city_name

string

required

length ≤ 60

Cidade(Nome deve estar correto e completo)

customer_zipcode

string

required

length ≤ 8

CEP (formato 99999999)

customer_address

string

required

length ≤ 255

Endereço

customer_address_complement

string

length ≤ 120

Complemento

customer_address_number

string

length ≤ 10

Número

customer_email

string

length ≤ 80

E-mail do Pagador

customer_email_cc

string

length ≤ 80

E-mail alternativo do Pagador

customer_neighborhood

string

required

length ≤ 80

Bairro

customer_phone_number

string

length ≤ 11

Telefone (com DDD)

customer_ignore_email

boolean | null

Nunca enviar e-mail para este cliente

customer_ignore_sms

boolean | null

Nunca enviar SMS para este cliente

customer_mobile_local_code

string | null

DDD do Celular

customer_mobile_number

string | null

Celular

customer_nickname

string | null

Apelido ou Nome Fantasia do Pagador

customer_notes

string | null

Anotações do Pagador

customer_contact_person

string | null

Contato

customer_update

string | null

Contato

start_at

date

required

Data da primeira cobrança

end_at

date | null

Data da última cobrança

cycle

string | null

Ciclo do carnê. Default: monthly

biweekly Quinzenal
bimonthly Bimestral
monthly Mensal
quarterly Trimestral
semiannual Semestral
annual Anual

biweekly bimonthly monthly quarterly semiannual annual

total

integer

required

≤ 300

Quantidade de parcelas

custom_bank_billets

array of objects | null

Carnê customizado. Quando enviado, os valores de amount, start_at e end_at serão ignorados.

custom_bank_billets

object

amount_cents

integer

required

Valor da parcela (R$) com 2 casas decimais. Formato: 134556 corresponde 1.345,56

expire_at

date

required

Data de vencimento

bank_billet_ids

array of integers | null

IDs de boletos vinculados ao carnê

bank_billet_ids

interest_type

integer | null

Defaults to 0

Tipo de juros/mora:

0 Inexistente (Padrão)
1 Para porcentagem diária
2 Para valor diário

1 2

days_for_interest

integer | null

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

float | null

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

float | null

Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.

interest_days_type

integer | null

Defaults to 0

Tipo de Dias para juros:

0 Corridos
1 Úteis

1

fine_type

integer | null

Defaults to 0

Tipo de multa:

0 Inexistente (Padrão)
1 Para percentual do valor do boleto
2 Para valor fixo

1 2

days_for_fine

integer | null

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

float | null

Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1

fine_value

float | null

Valor da multa (R$). Obrigatório se fine_type é igual a 2.

discount_type

integer | null

Defaults to 0

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

1 2

days_for_discount

integer | null

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

float | null

Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2

discount_value

float | null

Valor do desconto (R$). Obrigatório se discount_type é igual a 1.

days_for_second_discount

integer | null

Dias para segundo desconto.

second_discount_percentage

float | null

Percentual do valor do boleto equivalente ao segundo desconto.

second_discount_value

float | null

Valor do segundo desconto (R$).

days_for_third_discount

integer | null

Dias para terceiro desconto.

third_discount_percentage

float | null

Percentual do valor do boleto equivalente ao terceiro desconto.

third_discount_value

float | null

Valor do terceiro desconto (R$).

tags

array of strings | null

Tags associadas ao boleto

tags

guarantor_name

string | null

Nome do Beneficiário final (Sacador/Avalista)

guarantor_cnpj_cpf

string | null

CNPJ/CPF do Beneficiário final (Sacador/Avalista)

guarantor_address_number

string | null

Número do Beneficiário final (Sacador/Avalista)

guarantor_neighborhood

string | null

Bairro do Beneficiário final (Sacador/Avalista)

guarantor_phone_number

string | null

Telefone (com DDD) do Beneficiário final (Sacador/Avalista)

guarantor_city_name

string | null

Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)

guarantor_state

string | null

Estado do Beneficiário final (Sacador/Avalista)

guarantor_zipcode

string | null

CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)

guarantor_address

string | null

Endereço do Beneficiário final (Sacador/Avalista)

guarantor_address_complement

string | null

Complemento do Beneficiário final (Sacador/Avalista)

description

string | null

Descrição do produto ou serviço

instructions

string | null

Instruções para o Caixa

document_date

date | null

Data do Documento

document_type

string

required

length ≤ 2

Defaults to 02

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 Promissó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

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

document_number

string | null

days_for_revoke

integer | null

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 | null

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 | null

Dias corridos para Protesto

divergent_payment_type

integer | null

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

1 2 3 4

divergent_payment_value_type

integer | null

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

1 2

divergent_payment_maximum_value

float | null

Valor máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_value

float | null

Valor mínimo para a faixa de pagamentos divergentes.

divergent_payment_maximum_percentage

float | null

Percentual máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_percentage

float | null

Percentual mínimo para a faixa de pagamentos divergentes.

divergent_payment_limit

integer | null

Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa.

prevent_registration

boolean | null

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 | null

Anotações

custom_attachment_name

string | null

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 | null

Indica se o boleto foi criado por API

created_at

date-time | null

Data e hora de criação do boleto

updated_at

date-time | null

Data e hora da última atualização do boleto

payment_count

integer | null

Quantidade de pagamentos parciais aceitos para este boleto.

url

string | null

URL para visualização do carnê

status

string

Situação do carnê:

created Gerando
processed Parcelas criadas
generated Aberto

created processed generated

import_id

integer | null

ID da Importação

ignore_whatsapp

boolean | null

Defaults to false

Nunca enviar este carnê por WhatsApp

Language

Credentials

Bearer

URL


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api-sandbox.kobana.com.br/v1/installments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "interest_type": 0,
8
  "interest_days_type": 0,
9
  "fine_type": 0,
10
  "discount_type": 0,
11
  "document_type": "02",
12
  "ignore_whatsapp": false
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Carnê Criado

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

422Carnê inválido