---
title: "Emissão de carnê"
method: POST
path: "/installments"
---

# Emissão de carnê

`POST /installments`

Gere um boleto parcelado através desta API

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `code` string — Código definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura.
  - `customer` object, required
    - `name` string, required
    - `email` string, required
    - `document` object
      - `identity` string, required
      - `type` string
    - `address` object
      - `street` string
      - `number` string
      - `district` string
      - `city` string
      - `state` string
      - `complement` string
      - `zip_code` string
  - `service` object, required — Objeto para descrição do serviço prestado ao pagador do boleto
    - `name` string, required
    - `description` string
    - `amount` integer, required
  - `payment_terms` object
  - `installment` object, required
  - `notification` object
    - `name` string, required — Nome do contato para quem será enviada a notificação de cobrança.
    - `channels` object[] — Lista de objetos que representam os canais de notificação desejados com suas respectivas regras.
      - `channel` 'EMAIL' | 'SMS', required — Array de Strings que representam os canais de comunicação escolhidos. Hoje aceita o canal "EMAIL" e "SMS"
      - `contact` string, required — Contato para quem será enviada a notificação de cobrança. Deve ser informado um endereço de e-mail para canal do tipo EMAIL, e um número de telefone para o canal SMS
      - `rules` unknown[], required
        - unknown
  - `payment_forms` string[]

## Response `200`

200

- object
  - `document_url` string
  - `result` object[]
    - `id` string
    - `amount_total` integer
    - `status` string
    - `document_url` string
    - `buyer` object
      - `name` string
      - `document` string
      - `email` string
      - `type` string
      - `address` object
        - `street` string
        - `number` string
        - `district` string
        - `city` string
        - `state` string
        - `complement` string
        - `zip_code` string
    - `seller` object
      - `business_id` string
      - `name` string
      - `document` string
      - `type` string
    - `bank_slip` object
      - `barcode` string
      - `digitable` string
      - `our_number` string
      - `registered` boolean
      - `amount_paid` integer
      - `url` string
      - `fine` integer
      - `interest` integer
      - `document_sequence` integer
      - `interest_monthly_percent` number
      - `fine_percent` integer
      - `fine_value` integer
      - `discount_percent` integer
      - `discount_value` integer
      - `bill_type` string
      - `tax_type` unknown
      - `allow_change_amount` unknown
      - `min_amount` unknown
    - `pix` unknown
    - `services` object[]
      - `name` string
      - `description` string
      - `amount` integer
    - `payment_terms` object
      - `due_date` string
      - `available_date` unknown
      - `interest` object
        - `value` integer
        - `type` string
      - `fine` object
        - `value` integer
        - `type` string
        - `start_at` string
      - `discount` object
        - `value` integer
        - `type` string
        - `due_date` unknown
    - `payments` unknown[]
      - unknown
    - `payment_forms` string[]
    - `additional_information` unknown[]
      - unknown
    - `created_at` string
    - `authentication_id` string
    - `tax_info` unknown
    - `recurrence` unknown

## Other responses

- `400` — 400
- `401` — 401
- `415` — 415

---

[API](https://skmtc.net/cora/apis/boletos.md) · [All operations](https://skmtc.net/cora/apis/boletos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cora/boletos/versions/c1a8281b252f/schema)