Boletos

List boletos

get

List all available boletos

Query parameters

org_idstring · uuidOptional

Unique identifier

entity_idstring · uuidOptional

Unique identifier

group_idstring · uuidOptional

Unique identifier

boleto_idstring · uuidOptional

Unique identifier

bank_account_idstring · uuidOptional

Unique identifier

external_idstringOptional

External ID

seu_numerostringOptional

Seu numero

counterparty_tax_numberstringOptional

Counterparty tax number

statusstringOptional

Status

from_datetimestring · date-timeOptional

Datatime schema

to_datetimestring · date-timeOptional

Datatime schema

search_termstringOptional

Search term

beforestringOptional

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==

afterstringOptional

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==

limitinteger · min: 10Optional

Limit list

load_stagesbooleanOptional

Load stages

load_due_detailsbooleanOptional

Load due details

Responses

200

Boletos

application/json

401

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /boleto HTTP/1.1
Host: localhost:5800
Accept: */*

{
  "data": [
    {
      "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
      "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
      "stages": [
        {
          "amount": 10000,
          "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
          "discount": 1000,
          "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
          "expiration_date": "2024-02-30T23:59:59.999999Z",
          "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
          "inserted_at": "2024-01-10T10:00:00.000000Z",
          "status": "created",
          "timestamp": "2024-01-10T10:00:00.000000Z",
          "updated_at": "2024-01-10T10:00:00.000000Z"
        },
        {
          "amount": 10000,
          "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
          "discount": 1000,
          "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
          "expiration_date": "2024-02-30T23:59:59.999999Z",
          "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
          "inserted_at": "2024-01-10T10:05:00.000000Z",
          "status": "confirmed",
          "timestamp": "2024-01-10T10:05:00.000000Z",
          "updated_at": "2024-01-10T10:05:00.000000Z"
        }
      ],
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "settlement_type": "commercial_duplicate",
      "digitable_line": "12341111222233334444555566667777888899990000",
      "bank_code": "1234",
      "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
      "discount": 1000,
      "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
      "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
      "expiration_date": "2024-08-30T23:59:59.999999Z",
      "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
      "status": "confirmed",
      "updated_at": "2024-01-10T10:05:00.000000Z",
      "description": "description",
      "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
      "barcode": "12341111222233334444555566667777888899990000",
      "nosso_numero": "00011122233",
      "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
      "error_code": "Error code of the boleto",
      "error_message": "Error message of the boleto",
      "seu_numero": "1753294458903ac",
      "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
      "due_detail": {
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 2,
        "discount_amounts": [],
        "discount_antecipation_type": "per_day_antecipated",
        "discount_calculation_days": "working",
        "discount_calculation_type": "amount",
        "discount_dates": [],
        "due_date": "2024-08-10",
        "due_datetime": "2024-08-10T23:59:59.999999Z",
        "fine": 10,
        "fine_calculation_type": "percentage",
        "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "interest": 20,
        "mora_interest_calculation_type": "daily_rate",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      },
      "in_document_document_type": "boleto",
      "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
      "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
      "issue_date": "2024-07-24T10:00:00.000000Z",
      "in_document_amount": 10000,
      "amount": 10000,
      "wallet_type": "direct_electronic_partial_emission_booklet",
      "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
      "notes": [
        "note 1",
        "note 2",
        "note 3"
      ],
      "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
    }
  ]
}

Create boleto

post

Creates a boleto

Body

Params to create boleto

amountintegerRequired

Amount

bank_account_idstringRequired

Bank Account UUID

descriptionstringOptional

Description

expiration_datestring · date-timeRequired

Expiration Date

notesstring[] | nullableOptional

Notes of the boleto

Example: ["note 1","note 2","note 3"]

org_idstringRequired

Org UUID

wallet_typestring · enum | nullableRequired

Wallet type of the boleto

Example: direct_electronic_partial_emission_bookletPossible values:

Responses

201

Boleto

application/json

401

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

post

HTTPcURLJavaScriptPython

POST /boleto HTTP/1.1
Host: localhost:5800
Content-Type: application/json
Accept: */*
Content-Length: 1009

{
  "amount": 10000,
  "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
  "counterparty": {
    "address": "Rua de Teste, 123 - Ap. 21",
    "city": "São Paulo",
    "district": "Centro",
    "name": "Paulo da Silva",
    "postal_code": "89123-456",
    "state": "SP",
    "tax_number": "75274480080"
  },
  "description": "description",
  "due_detail": {
    "discount": 2,
    "discount_amounts": [],
    "discount_antecipation_type": "per_day_antecipated",
    "discount_calculation_days": "working",
    "discount_calculation_type": "amount",
    "discount_dates": [],
    "due_date": "2024-08-10T23:59:59.999999Z",
    "fine": 10,
    "fine_calculation_type": "percentage",
    "interest": 20,
    "mora_interest_calculation_type": "daily_rate"
  },
  "expiration_date": "2024-02-30T23:59:59.999999Z",
  "merchant": {
    "address": "Av. Paulista, 1000 - Bloco 1",
    "city": "São Paulo",
    "district": "Centro",
    "name": "Merchant Ltda",
    "postal_code": "90321-876",
    "state": "SP",
    "tax_number": "75834207000160"
  },
  "notes": [
    "note 1",
    "note 2",
    "note 3"
  ],
  "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
  "wallet_type": "direct_electronic_partial_emission_booklet"
}

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}

Update boleto

put

Updates a boleto

Path parameters

boleto_idstring · uuidRequired

Unique identifier

Body

Params to update boleto

boleto_idstringRequired

Boleto UUID

org_idstringOptional

Org UUID

Responses

200

Boleto

application/json

401

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

put

HTTPcURLJavaScriptPython

PUT /boleto/{boleto_id} HTTP/1.1
Host: localhost:5800
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
  "due_detail": {
    "discount": 2,
    "discount_amounts": [],
    "discount_antecipation_type": "per_day_antecipated",
    "discount_calculation_days": "working",
    "discount_calculation_type": "amount",
    "discount_dates": [],
    "due_date": "2024-08-12T23:59:59.999999Z"
  },
  "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b"
}

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}

Cancel boleto

put

Cancels a boleto

Path parameters

boleto_idstring · uuidRequired

Unique identifier

Query parameters

org_idstring · uuidOptional

Unique identifier

Responses

200

Boleto

application/json

401

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

put

HTTPcURLJavaScriptPython

PUT /boleto/{boleto_id}/cancel HTTP/1.1
Host: localhost:5800
Accept: */*

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}

Show boleto by external ID

get

Shows a boleto by external ID

Path parameters

external_idstringRequired

External ID

Query parameters

org_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages

load_due_detailsbooleanOptional

Load due details

Responses

200

Boleto

application/json

401

Unprocessable Entity

application/json

404

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /boleto/{external_id}/get_by_external_id HTTP/1.1
Host: localhost:5800
Accept: */*

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}

Show boleto

get

Shows a boleto

Path parameters

idstring · uuidRequired

Unique identifier

Query parameters

org_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages

load_due_detailsbooleanOptional

Load due details

Responses

200

Boleto

application/json

401

Unprocessable Entity

application/json

404

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /boleto/{id} HTTP/1.1
Host: localhost:5800
Accept: */*

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}

Show boleto by seu numero

get

Shows a boleto by seu numero

Path parameters

seu_numerostringRequired

Seu numero

Query parameters

org_idstring · uuidOptional

Unique identifier

load_stagesbooleanOptional

Load stages

load_due_detailsbooleanOptional

Load due details

Responses

200

Boleto

application/json

401

Unprocessable Entity

application/json

404

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /boleto/{seu_numero}/get_by_seu_numero HTTP/1.1
Host: localhost:5800
Accept: */*

{
  "data": {
    "group_id": "0196f83d-cfec-29bd-838e-06bfbf0fcd51",
    "counterparty_id": "0197ef72-bd8c-7855-52d3-08c868f715ff",
    "stages": [
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0197ef72-bd8c-b94b-cecd-e1963d891400",
        "inserted_at": "2024-01-10T10:00:00.000000Z",
        "status": "created",
        "timestamp": "2024-01-10T10:00:00.000000Z",
        "updated_at": "2024-01-10T10:00:00.000000Z"
      },
      {
        "amount": 10000,
        "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
        "discount": 1000,
        "due_detail_id": "01954d92-31df-8194-e7c6-b4656fec40fd",
        "expiration_date": "2024-02-30T23:59:59.999999Z",
        "id": "0190c195-00b0-3366-32a9-3a14cc2550c7",
        "inserted_at": "2024-01-10T10:05:00.000000Z",
        "status": "confirmed",
        "timestamp": "2024-01-10T10:05:00.000000Z",
        "updated_at": "2024-01-10T10:05:00.000000Z"
      }
    ],
    "inserted_at": "2024-01-10T10:05:00.000000Z",
    "settlement_type": "commercial_duplicate",
    "digitable_line": "12341111222233334444555566667777888899990000",
    "bank_code": "1234",
    "entity_id": "0196f83d-cdb5-927f-a413-8bb01eb8102e",
    "discount": 1000,
    "dynamic_brcode_id": "0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "company_id": "0196f83d-cd61-619c-a259-a342dd9f99f6",
    "expiration_date": "2024-08-30T23:59:59.999999Z",
    "due_detail_id": "0191b8f8-6878-e57c-2a0a-30421a36ea94",
    "status": "confirmed",
    "updated_at": "2024-01-10T10:05:00.000000Z",
    "description": "description",
    "id": "0196f83d-cafa-f412-1f1d-129cdf2dda49",
    "barcode": "12341111222233334444555566667777888899990000",
    "nosso_numero": "00011122233",
    "in_document_transaction_date": "2024-07-25T13:35:27.098235Z",
    "error_code": "Error code of the boleto",
    "error_message": "Error message of the boleto",
    "seu_numero": "1753294458903ac",
    "external_id": "0190b2a4-8a3b-d123-050e-8d659ace1e2d",
    "due_detail": {
      "boleto_id": "0198387e-5017-6bf1-56c0-2e520b1fa254",
      "discount": 2,
      "discount_amounts": [],
      "discount_antecipation_type": "per_day_antecipated",
      "discount_calculation_days": "working",
      "discount_calculation_type": "amount",
      "discount_dates": [],
      "due_date": "2024-08-10",
      "due_datetime": "2024-08-10T23:59:59.999999Z",
      "fine": 10,
      "fine_calculation_type": "percentage",
      "id": "0197ef72-badc-77d7-bd6a-a507faa93dc9",
      "inserted_at": "2024-01-10T10:05:00.000000Z",
      "interest": 20,
      "mora_interest_calculation_type": "daily_rate",
      "timestamp": "2024-01-10T10:00:00.000000Z",
      "updated_at": "2024-01-10T10:05:00.000000Z"
    },
    "in_document_document_type": "boleto",
    "end_to_end_id": "b_0191b8f8-67e0-ebd9-7c38-b16326fbc802",
    "timestamp": "2024-01-10T10:00:00.000000Z",
    "in_document_id": "0197ef72-bc94-473e-4bd6-860244b795bb",
    "org_id": "0196f83d-ce89-cd06-c7f5-f80a6ff7257b",
    "issue_date": "2024-07-24T10:00:00.000000Z",
    "in_document_amount": 10000,
    "amount": 10000,
    "wallet_type": "direct_electronic_partial_emission_booklet",
    "bank_account_id": "019225c4-a533-3e2f-ae94-e0f676c37a38",
    "notes": [
      "note 1",
      "note 2",
      "note 3"
    ],
    "counterparty_info_id": "0197ef72-bd8c-b94b-cecd-e1963d891400"
  }
}