Criar um carnê

post

https://api.iugu.com/v1/payment_booklets

Crie seus carnês através desta endpoint

Body Params

customer_id

string

required

ID do cliente na iugu que você deseja criar o carnê

installments

string

required

Quantidade de parcelas presentes no carnê. Deve ser escolhido entre 1-24 parcelas.

description

string

required

Descrição da Capa do Carnê

custom_instruction

string

Campo de instruções complementares ao carnê com limite de até 150 caracteres, incluindo caracteres especiais

started_at

date

Data de início da cobrança do carnê. Se não enviado, o início será imediato. YYYY-MM-DD

invoice_fines

boolean

Habilita multa por atraso de pagamento

invoice_fines_value

string

Determine a % da multa a ser cobrada para pagamentos efetuados após a data de vencimento

invoice_per_day_interest

boolean

Booleano que determina se cobra ou não juros por dia de atraso. Necessário passar a multa como true

invoice_per_day_interest_value

string

Informar o valor percentual de juros por atraso que deseja cobrar

price_cents

string

required

Valor total do carnê em centavos. Mínimo de 1$ real (100) por parcela.

invoice_payable_with_pix

boolean

Envie 'true' para gerar o Carnê com o método PIX habilitado (QR code). Caso não envie este campo (ou envie 'false'), o carnê será gerado apenas com os boletos bancários.

invoice_early_payment_discount

boolean

Ativa ou desativa os descontos por pagamento antecipado. Quando true, sobrepõe as configurações de desconto da conta.

early_payment_discounts

object

Detalhes dos desconto de pagamento antecipado

external_reference

string

Referência externa do carnê

ignore_due_email

boolean

Se true, o cliente final não irá receber nenhum e-mail notificando a cobrança.

expires_in

string

Expira uma fatura e impossibilita o seu pagamento depois 'x' dias após o vencimento. Valor enviado precisa estar entre 0 e 30. Se for enviado "0", a fatura ficará disponível para ser paga até às 23:59:59 do dia de vencimento.

Responses

200200

400400

401401

403403