> ## Documentation Index
> Fetch the complete documentation index at: https://docs.piriod.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create boleto



## OpenAPI

````yaml POST /boletos/
openapi: 3.0.3
info:
  title: Piriod API
  version: 1.0.0
  description: >
    Piriod API for billing, payments, procurement and collections.


    All requests require:

    - `Authorization: Token <api_token>` header.

    - `x-simple-workspace: <workspace_id>` header (the account/workspace
    identifier).

    - Optionally `x-piriod-test-mode: true` to operate against test-mode data.


    See the Documentation tab for getting started, integration flows,
    authentication,

    error handling and pagination/filtering guides.
servers:
  - url: https://api.piriod.com
    description: Production
security:
  - TokenAuth: []
paths:
  /boletos/:
    post:
      tags:
        - Payments
      summary: Create boleto
      parameters:
        - $ref: '#/components/parameters/WorkspaceHeader'
        - $ref: '#/components/parameters/TestModeHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Boleto'
      responses:
        '201':
          description: Boleto created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Boleto'
components:
  parameters:
    WorkspaceHeader:
      name: x-simple-workspace
      in: header
      required: true
      schema:
        type: string
      description: Workspace (account) identifier. Required for every request.
      example: acc_01H8XYZ123ABC
    TestModeHeader:
      name: x-piriod-test-mode
      in: header
      required: false
      schema:
        type: boolean
        default: false
      description: Whether to operate against test-mode data. Defaults to `false`.
  schemas:
    Boleto:
      type: object
      description: |
        Brazilian boleto bancário associated to a payment. Stores the bar code,
        bill ID and a PDF artifact.
      properties:
        id:
          type: integer
          readOnly: true
        payment:
          type: integer
          description: Payment ID.
        bill_id:
          type: string
          maxLength: 128
        barcode:
          type: string
        qr_code:
          type: string
        pdf:
          type: string
          format: uri
          nullable: true
          description: Signed URL to the rendered boleto PDF.
        created:
          type: string
          format: date-time
          readOnly: true
      required:
        - payment
        - bill_id
        - barcode
        - qr_code
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use header `Authorization: Token <api_token>`.
        API tokens are obtained from the Piriod dashboard.

````