> ## Documentation Index > Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List boletos > List all available boletos ## OpenAPI ````yaml v2/api-reference/openapi.json GET /v2/in/boletos openapi: 3.0.0 info: title: Trio API v2 version: 2026-10-19.v2 servers: - url: https://api.sandbox.trio.com.br variables: {} - url: https://api.qa.trio.com.br variables: {} - url: https://api.trio.com.br variables: {} security: [] tags: [] paths: /v2/in/boletos: parameters: - description: >- Version of the v2 contract the client is written against. Each breaking change publishes a new version. example: 2026-10-19.v2 in: header name: Trio-Version required: true schema: enum: - 2026-10-19.v2 type: string x-struct: null x-validate: null - description: >- ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org. in: header name: Trio-Target-Org-Id required: false schema: format: uuid type: string x-struct: null x-validate: null get: tags: - Receivables (in) - Boletos summary: List boletos description: List all available boletos operationId: TrioFoundationWeb.V2.In.BoletoController.index parameters: - description: Entity UUID in: query name: entity_id required: false schema: $ref: '#/components/schemas/UUID' - description: Bank account UUID in: query name: bank_account_id required: false schema: $ref: '#/components/schemas/UUID' - description: Group UUID in: query name: group_id required: false schema: $ref: '#/components/schemas/UUID' - description: External ID in: query name: external_id required: false schema: type: string x-struct: null x-validate: null - description: Counterparty ID in: query name: counterparty_id required: false schema: $ref: '#/components/schemas/UUID' - description: Status in: query name: status required: false schema: type: string x-struct: null x-validate: null - description: From datetime in: query name: from_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: To datetime in: query name: to_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: Search term in: query name: search_term required: false schema: type: string x-struct: null x-validate: null - description: >- Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page. example: >- g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ== in: query name: before required: false schema: type: string x-struct: null x-validate: null - description: >- Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page. example: >- g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ== in: query name: after required: false schema: type: string x-struct: null x-validate: null - description: Query limit, default is 50 and max is 100 in: query name: limit required: false schema: $ref: '#/components/schemas/Limit' responses: '200': content: application/json: schema: $ref: '#/components/schemas/V2_Boleto_list' description: Boletos '400': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Malformed request: a body that is not valid JSON (MALFORMED_REQUEST), or a Trio-Version header that is missing or not the current one (INVALID_TRIO_VERSION). '401': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: Missing or invalid API key credentials (INVALID_CREDENTIALS). '403': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- The API key may not do this (FORBIDDEN): for instance Trio-Target-Org-Id names an org it has no access to, or writes through a read-only access. '422': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of the rule the request breaks). A request outside the operation's schema lists the offending fields in `errors`. '503': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- A service needed to answer is unavailable (TRIO_SERVICE_UNAVAILABLE). callbacks: {} security: - authorization: [] components: schemas: UUID: description: Unique identifier format: uuid title: UUID type: string x-struct: null x-validate: null DATETIME: description: Datetime schema format: date-time title: DATETIME type: string x-struct: null x-validate: null Limit: description: Limit list minimum: 10 title: Limit type: integer x-struct: null x-validate: null V2_Boleto_list: description: Boleto list response example: data: - amount: amount: 10000 currency: BRL bank_account_id: 0196f83d-cafa-f412-1f1d-129cdf2dda49 barcode: '12341111222233334444555566667777888899990000' boleto_url: https://example.com/boleto_1 counterparty: id: 000a89cb-f0c9-07ce-79c2-fc049bc253e0 description: description digitable_line: '12341111222233334444555566667777888899990000' due_detail: discount: fixed_until_due: amounts: - amount: amount: 300 currency: BRL date: '2026-12-13' - amount: amount: 100 currency: BRL date: '2026-12-15' calculation_type: amount due_date: '2026-12-16' fine: calculation_type: percentage value: 200 interest: amount: amount: 10 currency: BRL calculation_type: daily_rate expiration_date: '2026-12-30' external_id: 0190b2a4-8a3b-d123-050e-8d659ace1e2d fee: amount: 0 currency: BRL id: 0196f83d-cafa-f412-1f1d-129cdf2dda49 inserted_at: '2026-12-01T10:00:00.000000Z' invoice_type: invoice issue_date: '2026-12-01' notes: - note 1 - note 2 - note 3 status: confirmed updated_at: '2026-12-01T10:00:00.000000Z' wallet_type: book_entry_electronic_bloquete metadata: after: null before: null has_more: false properties: data: items: $ref: '#/components/schemas/V2_Boleto_Response_Params' type: array x-struct: null x-validate: null metadata: description: Pagination cursors properties: after: description: Cursor to the next page nullable: true type: string x-struct: null x-validate: null before: description: Cursor to the previous page nullable: true type: string x-struct: null x-validate: null has_more: description: Whether a next page exists type: boolean x-struct: null x-validate: null type: object x-struct: null x-validate: null title: V2 Boleto_list type: object x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.ListResponse x-validate: null V2_error: example: error: error_code: INVALID_PARAMETER error_message: 'Invalid parameters: /amount: Invalid integer. Got: string' errors: - field: /amount message: 'Invalid integer. Got: string' properties: error: properties: error_code: description: >- Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message. type: string x-struct: null x-validate: null error_message: description: Human readable explanation of the error. type: string x-struct: null x-validate: null errors: description: >- Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field. items: properties: field: description: JSON pointer to the field, e.g. /amount. type: string x-struct: null x-validate: null message: description: What is wrong with it. type: string x-struct: null x-validate: null required: - field - message type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null required: - error_code - error_message type: object x-struct: null x-validate: null required: - error title: V2 error type: object x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error x-validate: null V2_Boleto_Response_Params: description: A boleto example: amount: amount: 10000 currency: BRL bank_account_id: 0196f83d-cafa-f412-1f1d-129cdf2dda49 barcode: '12341111222233334444555566667777888899990000' boleto_url: https://example.com/boleto_1 counterparty: id: 000a89cb-f0c9-07ce-79c2-fc049bc253e0 description: description digitable_line: '12341111222233334444555566667777888899990000' due_detail: discount: fixed_until_due: amounts: - amount: amount: 300 currency: BRL date: '2026-12-13' - amount: amount: 100 currency: BRL date: '2026-12-15' calculation_type: amount due_date: '2026-12-16' fine: calculation_type: percentage value: 200 interest: amount: amount: 10 currency: BRL calculation_type: daily_rate expiration_date: '2026-12-30' external_id: 0190b2a4-8a3b-d123-050e-8d659ace1e2d fee: amount: 0 currency: BRL id: 0196f83d-cafa-f412-1f1d-129cdf2dda49 inserted_at: '2026-12-01T10:00:00.000000Z' invoice_type: invoice issue_date: '2026-12-01' notes: - note 1 - note 2 - note 3 status: confirmed updated_at: '2026-12-01T10:00:00.000000Z' wallet_type: book_entry_electronic_bloquete properties: amount: description: Amount of the boleto properties: amount: description: Amount in cents minimum: 1 type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null bank_account_id: description: Bank account that receives the payment format: uuid type: string x-struct: null x-validate: null barcode: description: Barcode of the boleto type: string x-struct: null x-validate: null boleto_url: description: URL of the boleto type: string x-struct: null x-validate: null counterparty: description: Payer the boleto is issued to properties: id: description: Counterparty ID format: uuid nullable: true type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null description: description: Description of the boleto nullable: true type: string x-struct: null x-validate: null digitable_line: description: Digitable line of the boleto type: string x-struct: null x-validate: null due_detail: $ref: '#/components/schemas/V2_BoletoDueDetail' expiration_date: description: Last day on which the boleto can be paid format: date type: string x-struct: null x-validate: null external_id: description: External ID of the boleto nullable: true type: string x-struct: null x-validate: null fee: description: Fee charged on the payment nullable: true properties: amount: description: Fee in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null id: description: ID of the boleto format: uuid type: string x-struct: null x-validate: null inserted_at: description: When the boleto was created format: date-time type: string x-struct: null x-validate: null invoice_type: $ref: '#/components/schemas/Boleto_invoice_type' issue_date: description: Day the boleto was issued format: date type: string x-struct: null x-validate: null notes: items: type: string x-struct: null x-validate: null type: array x-struct: null x-validate: null status: $ref: '#/components/schemas/Boleto_Status' updated_at: description: When the boleto was last updated format: date-time type: string x-struct: null x-validate: null wallet_type: $ref: '#/components/schemas/Boleto_wallet_type' title: V2 Boleto_Response_Params type: object x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Boleto.ResponseParams x-validate: null V2_BoletoDueDetail: description: >- Due detail of a boleto. `due_date` is always present; each rule only when set. A rule has `amount` (money) for an amount calculation type and `value` (basis points, 100 = 1%) for a percentage one. example: discount: fixed_until_due: amounts: - amount: amount: 300 currency: BRL date: '2026-12-13' - amount: amount: 100 currency: BRL date: '2026-12-15' calculation_type: amount due_date: '2026-12-16' fine: calculation_type: percentage value: 200 interest: amount: amount: 10 currency: BRL calculation_type: daily_rate properties: discount: description: Discount for payments before the due date; only one option is set properties: fixed_until_due: description: Discount granted until each date properties: amounts: items: properties: amount: description: Amount, for an amount calculation type properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null date: description: Last date on which the discount applies format: date type: string x-struct: null x-validate: null value: description: >- Percentage in basis points (100 = 1%), for a percentage calculation type type: integer x-struct: null x-validate: null type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null calculation_type: enum: - amount - percentage type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null per_day_antecipated: description: Discount per day paid in advance properties: amount: description: Amount, for an amount calculation type properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null calculation_days: enum: - calendar - working type: string x-struct: null x-validate: null calculation_type: enum: - amount - percentage type: string x-struct: null x-validate: null value: description: >- Percentage in basis points (100 = 1%), for a percentage calculation type type: integer x-struct: null x-validate: null type: object x-struct: null x-validate: null type: object x-struct: null x-validate: null due_date: description: Due date of the boleto format: date type: string x-struct: null x-validate: null fine: description: Fine charged after the due date properties: amount: description: Amount, for an amount calculation type properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null calculation_type: enum: - amount - percentage type: string x-struct: null x-validate: null value: description: >- Percentage in basis points (100 = 1%), for a percentage calculation type type: integer x-struct: null x-validate: null type: object x-struct: null x-validate: null interest: description: Interest charged after the due date properties: amount: description: Amount, for an amount calculation type properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null calculation_type: enum: - daily_rate - monthly_fee - exempt - bank_control type: string x-struct: null x-validate: null value: description: >- Percentage in basis points (100 = 1%), for a percentage calculation type type: integer x-struct: null x-validate: null type: object x-struct: null x-validate: null required: - due_date title: V2 BoletoDueDetail type: object x-struct: null x-validate: null Boleto_invoice_type: description: Boleto invoice type enum: - commercial_duplicate - indicated_commercial_duplicate - service_duplicate - indicated_service_duplicate - rural_duplicate - bill_of_exchange - commercial_credit_note - export_credit_note - industrial_credit_note - rural_credit_note - promissory_note - rural_promissory_note - triplicate_commercial - triplicate_service - insurance_note - receipt - invoice - debit_note - insurance_policy - school_fee - consortium_installment - invoice_note - debt_document - rural_product_certificate - warrant - state_active_debt - municipal_active_debt - federal_active_debt - condominium_fee - credit_card - others nullable: true title: Boleto_invoice_type type: string x-struct: null x-validate: null Boleto_Status: description: Status of the boleto enum: - created - confirmed - settled - onhold - refunded - failed - cancelled example: created nullable: true title: Boleto Status type: string x-struct: null x-validate: null Boleto_wallet_type: description: Boleto wallet type enum: - direct_electronic_partial_emission_booklet - book_entry_electronic_booklet - direct_electronic_with_emission_booklet - direct_electronic_no_emission_block_client - direct_electronic_no_emission_block_us - book_entry_electronic_bloquete - direct_electronic_no_emission_block_client2 - direct_electronic_partial_emission_bloquete - direct_electronic_with_emission_bloquete - direct_electronic_no_emission_us_emission - direct_electronic_our_number_emission_banks_bloquete - direct_electronic_our_number_emission_banks_booklet title: Boleto_wallet_type type: string x-struct: null x-validate: null securitySchemes: authorization: scheme: basic type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.