---
title: "Criar um carnê"
method: POST
path: "/payment_booklets"
---

# Criar um carnê

`POST /payment_booklets`

Crie seus carnês através desta endpoint

## Request body

- object
  - `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` string, 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
    - `days` integer, required — Número de dias antes do vencimento para aplicação do desconto.
    - `percent` number, float — Valor do desconto em porcentagem. Não pode ser usado com `value_cents`.
    - `value_cents` integer — Valor do desconto em centavos. Não pode ser usado com `percent`.
  - `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.

## Response `200`

200

- object
  - `id` string
  - `external_reference` unknown
  - `custom_instruction` string
  - `description` string
  - `price_cents` integer
  - `started_at` string
  - `finish_at` string
  - `status` string
  - `invoices` object[]
    - `id` string
    - `due_date` string
    - `currency` string
    - `discount_cents` unknown
    - `email` string
    - `items_total_cents` integer
    - `notification_url` unknown
    - `return_url` unknown
    - `status` string
    - `tax_cents` unknown
    - `total_cents` integer
    - `total_paid_cents` integer
    - `taxes_paid_cents` unknown
    - `paid_at` unknown
    - `paid_cents` unknown
    - `cc_emails` string
    - `financial_return_date` unknown
    - `payable_with` string[]
    - `overpaid_cents` unknown
    - `ignore_due_email` boolean
    - `ignore_canceled_email` unknown
    - `advance_fee_cents` unknown
    - `commission_cents` unknown
    - `early_payment_discount` boolean
    - `order_id` unknown
    - `updated_at` string
    - `credit_card_brand` unknown
    - `credit_card_bin` unknown
    - `credit_card_last_4` unknown
    - `credit_card_captured_at` unknown
    - `credit_card_tid` unknown
    - `external_reference` unknown
    - `max_installments_value` unknown
    - `payer_name` string
    - `payer_email` string
    - `payer_cpf_cnpj` string
    - `payer_phone` string
    - `payer_phone_prefix` string
    - `payer_address_zip_code` string
    - `payer_address_street` string
    - `payer_address_district` string
    - `payer_address_city` string
    - `payer_address_state` string
    - `payer_address_number` string
    - `payer_address_complement` string
    - `payer_address_country` unknown
    - `late_payment_fine` integer
    - `late_payment_fine_cents` unknown
    - `split_id` unknown
    - `external_payment_id` unknown
    - `external_payment_description` unknown
    - `payment_booklet_id` string
    - `subscription_id` unknown
    - `variables` object[]
      - `variable` string
      - `value` string
    - `custom_variables` object[]
    - `logs` object[]
      - `id` string
      - `description` string
      - `notes` string
      - `created_at` string
    - `credit_card_transaction` unknown
    - `account_id` string
    - `bank_account_branch` string
    - `bank_account_number` string
    - `account_name` string
    - `secure_id` string
    - `secure_url` string
    - `customer_id` string
    - `customer_ref` string
    - `customer_name` string
    - `user_id` unknown
    - `total` string
    - `taxes_paid` string
    - `total_paid` string
    - `total_overpaid` string
    - `total_refunded` string
    - `commission` string
    - `fines_on_occurrence_day` string
    - `total_on_occurrence_day` string
    - `fines_on_occurrence_day_cents` integer
    - `total_on_occurrence_day_cents` integer
    - `refunded_cents` integer
    - `remaining_captured_cents` integer
    - `advance_fee` unknown
    - `estimated_advance_fee` unknown
    - `paid` string
    - `original_payment_id` unknown
    - `double_payment_id` unknown
    - `per_day_interest` boolean
    - `per_day_interest_value` integer
    - `per_day_interest_cents` integer
    - `interest` unknown
    - `discount` unknown
    - `duplicated_invoice_id` unknown
    - `bank_slip_extra_due` integer
    - `created_at` string
    - `created_at_iso` string
    - `authorized_at` unknown
    - `authorized_at_iso` unknown
    - `expired_at` unknown
    - `expired_at_iso` unknown
    - `refunded_at` unknown
    - `refunded_at_iso` unknown
    - `canceled_at` unknown
    - `canceled_at_iso` unknown
    - `protested_at` unknown
    - `protested_at_iso` unknown
    - `chargeback_at` unknown
    - `chargeback_at_iso` unknown
    - `occurrence_date` unknown
    - `refundable` unknown
    - `installments` unknown
    - `transaction_number` integer
    - `payment_method` unknown
    - `financial_return_dates` unknown
    - `bank_slip` object
      - `digitable_line` string
      - `barcode_data` string
      - `barcode` string
      - `bank_slip_bank` integer
      - `bank_slip_status` string
      - `bank_slip_error_code` unknown
      - `bank_slip_error_message` unknown
      - `recipient_cpf_cnpj` string
    - `pix` object
      - `qrcode` string
      - `qrcode_text` string
      - `status` string
      - `payer_cpf_cnpj` unknown
      - `payer_name` unknown
      - `end_to_end_id` unknown
      - `end_to_end_refund_id` unknown
      - `account_number_last_digits` unknown
    - `items` object[]
      - `id` string
      - `description` string
      - `price_cents` integer
      - `quantity` integer
      - `created_at` string
      - `updated_at` string
      - `price` string
    - `early_payment_discounts` object[]
    - `split_rules` unknown
  - `customer` object
    - `id` string
    - `datasource_id` string
    - `email` string
    - `created_at` string
    - `updated_at` string
    - `name` string
    - `notes` string
    - `cc_emails` string
    - `cpf_cnpj` string
    - `zip_code` string
    - `number` string
    - `complement` string
    - `street` string
    - `district` string
    - `phone` string
    - `phone_prefix` string
    - `trade_name` string
    - `login_allowed` unknown
    - `default_payment_method_id` string
    - `proxy_payments_from_customer_id` unknown
  - `payment_booklet_installments` integer
  - `secure_url` string

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403

---

[API](https://skmtc.net/iugu/apis/tokens-de-api.md) · [All operations](https://skmtc.net/iugu/apis/tokens-de-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/iugu/tokens-de-api/versions/4590fc729d1e/schema)