---
title: "Create boleto"
method: POST
path: "/boletos/"
tags: ["Payments"]
---

# Create boleto

`POST /boletos/`

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Request body

- Boleto — Brazilian boleto bancário associated to a payment. Stores the bar code, bill ID and a PDF artifact.
  - `id` integer
  - `payment` integer, required — Payment ID.
  - `bill_id` string, required
  - `barcode` string, required
  - `qr_code` string, required
  - `pdf` string, uri, nullable — Signed URL to the rendered boleto PDF.
  - `created` string, date-time

## Response `201`

Boleto created.

- Boleto — Brazilian boleto bancário associated to a payment. Stores the bar code, bill ID and a PDF artifact.
  - `id` integer
  - `payment` integer, required — Payment ID.
  - `bill_id` string, required
  - `barcode` string, required
  - `qr_code` string, required
  - `pdf` string, uri, nullable — Signed URL to the rendered boleto PDF.
  - `created` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)