Listar boletos
Request
ENDPOINT
/bank_slip/person/BENEFICIARY_KEYMÉTODO
GETAtenção
Note que em ambos os exemplos a lista bank_slip_file é vazia. Isto significa que não existe um arquivo pdf para este boleto. Caso o cliente deseje uma via PDF do boleto explicaremos como fazê-lo nos próximos passos.
Path params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
beneficiary_key * | string | Chave de identificação do beneficiário | chave uuid |
Query params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
payer_document | string | Número do documento do pagador | - |
bank_slip_status | enum | Status do boleto. | Enumeradores |
requester_profile | string | Número da carteira de boletos | - |
protest_status | enum | Status de protesto. | Enumeradores |
from | date | Data inicial de criação do boleto. | 10 |
to | date | Data final de criação do boleto. | 10 |
number_search | string | Nosso número (our_number) ou numero do documento (document_number). | - |
page | integer | Pagina a ser consultada >= 1. | - |
page_size | integer | Número máximo de registros retornados <= 100. | - |
Enumeradores bank_slip_status
| Campo | Descrição |
|---|---|
| accepted | Boleto na fila para registro |
| rejected | Boleto rejeitado |
| registered | Boleto registrado (disponível para pagamento) |
| payment_notice | Boleto pago - mas sem liquidação financeira |
| notary_office_payment_notice | rejected |
| paid | Boleto pago - baixado com liquidação financeira. |
| written_off | Boleto baixado sem liquidação financeira. |
Enumeradores protest_status
| Campo | Descrição |
|---|---|
| accepted | Boleto na fila para registro |
Response
STATUS
200Response Body
{
"data": [
{
"amount": 3,
"asset_type": {
"created_at": "2019-02-01T16:44:11",
"enumerator": "invoice",
"translation_path": "bank_slip.AssetType.invoice"
},
"automatic_bankruptcy_protest": true,
"automatic_protest": false,
"automatic_write_off": false,
"bank_slip_file": [],
"bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
"bank_slip_status": {
"created_at": "2019-02-01T16:44:07",
"enumerator": "accepted",
"translation_path": "bank_slip.BankSlipStatus.accepted"
},
"bank_teller_instructions": "Não aceitar após vencimento",
"beneficiary_account_branch": "0001",
"beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
"beneficiary_account_number": "67049",
"beneficiary_document_number": "12345678905",
"beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
"beneficiary_name": "Greg Brown",
"billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
"business_date_expiration": "2020-06-01",
"created_at": "2020-05-15T21:00:25",
"days_before_fine": null,
"days_before_interest": null,
"days_to_bankruptcy_protest": 1,
"days_to_protest": null,
"days_to_write_off": null,
"discount_limit_date": null,
"discount_value": null,
"document_number": "123456/01",
"expenses": [],
"expiration": "2020-06-01",
"fine_percentage": 0.1,
"guarantor_address": null,
"guarantor_city": null,
"guarantor_document": null,
"guarantor_name": null,
"guarantor_person_type": null,
"guarantor_postal_code": "00000000",
"guarantor_state": null,
"historical_our_number": 2,
"institution_registration_date": null,
"interest_daily_value": 0.34,
"lock_origin_type": null,
"nfe_key": null,
"nfe_url": null,
"occurrences": [
{
"created_at": "2020-05-15T21:00:25",
"discount_amount": null,
"discount_limit_date": null,
"iof_amount": null,
"new_bank_slip_status": null,
"new_due_date": "2020-06-01",
"new_protest_status": {
"created_at": "2019-02-01T16:44:08",
"enumerator": "not_protested",
"translation_path": "bank_slip.ProtestStatus.not_protested"
},
"notary_office_number": null,
"notary_office_protocol": null,
"occurrence_expenses": null,
"occurrence_feedback": null,
"occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
"occurrence_reasons": [],
"occurrence_type": {
"created_at": "2019-02-01T16:44:14",
"enumerator": "registration",
"translation_path": "bank_slip.OccurrenceType.registration"
},
"old_bank_slip_status": {
"created_at": "2019-02-01T16:44:07",
"enumerator": "accepted",
"translation_path": "bank_slip.BankSlipStatus.accepted"
},
"old_due_date": null,
"old_protest_status": null,
"paid_amount": null,
"paid_fine_amount": null,
"paid_interest_amount": null,
"payment_bank": null,
"payment_branch": null,
"payment_credit_date": null,
"payment_method": null,
"payment_origin": null,
"protest_confirmation": null,
"protest_expenses": null,
"rebate_amount": null,
"registration_institution_occurrence_date": "2020-05-15",
"registration_institution_occurrence_event": [
{
"cnab_file": {
"cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
"company_code": null,
"created_at": "2020-05-15T21:00:22",
"downloads": [],
"file_size": "None",
"filename": null,
"line_length": null,
"remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
"requester_profile_code": null,
"type": {
"created_at": "2019-02-01T16:44:17",
"enumerator": "api_instruction",
"translation_path": "bank_slip.CNABFileType.api_instruction"
},
"url": null,
"version": null
},
"cnab_file_occurrence_order": 1,
"created_at": "2020-05-15T21:00:25",
"new_status": {
"created_at": "2019-02-01T16:44:15",
"enumerator": "waiting_submission",
"translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
},
"old_status": null
}
],
"registration_institution_occurrence_status": {
"created_at": "2019-02-01T16:44:15",
"enumerator": "waiting_submission",
"translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
},
"requester_occurrence_event": [
{
"cnab_file": {
"cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
"company_code": null,
"created_at": "2020-05-15T21:00:22",
"downloads": [],
"file_size": "None",
"filename": null,
"line_length": null,
"remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
"requester_profile_code": null,
"type": {
"created_at": "2019-02-01T16:44:17",
"enumerator": "api_instruction",
"translation_path": "bank_slip.CNABFileType.api_instruction"
},
"url": null,
"version": null
},
"cnab_file_occurrence_order": 1,
"created_at": "2020-05-15T21:00:25",
"new_status": {
"created_at": "2019-02-01T16:44:16",
"enumerator": "accepted",
"translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
},
"old_status": null
}
],
"requester_occurrence_status": {
"created_at": "2019-02-01T16:44:16",
"enumerator": "accepted",
"translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
}
}
],
"our_number": 2,
"paid_amount": null,
"paid_fine_amount": null,
"paid_interest_amount": null,
"participant_control_number": null,
"payer_account_digit": null,
"payer_account_number": null,
"payer_account_type": null,
"payer_address": "Rua Carlos Tampaio, 112",
"payer_bank": null,
"payer_branch_digit": null,
"payer_branch_number": null,
"payer_document": "45508922008",
"payer_name": "John Nobody",
"payer_person_type": {
"created_at": "2019-02-01T16:44:09",
"enumerator": "natural",
"translation_path": "bank_slip.PersonType.natural"
},
"payer_postal_code": "00000000",
"payment_date": null,
"printing_policy": {
"created_at": "2019-02-01T16:44:10",
"enumerator": "no_printing",
"translation_path": "bank_slip.PrintingPolicy.no_printing"
},
"protest_status": {
"created_at": "2019-02-01T16:44:08",
"enumerator": "not_protested",
"translation_path": "bank_slip.ProtestStatus.not_protested"
},
"rebate_amount": null,
"registration_institution": {
"created_at": "2020-03-26T19:36:16",
"enumerator": "qi_scd",
"febraban_code": "329",
"remittance_sequence": 72,
"settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
},
"requester_profile": 1,
"requester_profile_code": "329-01-0001-0067049",
"requester_registration_date": "2020-05-15"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100,
},
"totals": {
"delayed_bank_slip_amount": 0,
"delayed_bank_slip_number": 0,
"due_bank_slip_amount": 3,
"due_bank_slip_number": 2,
"paid_bank_slip_amount": 0,
"paid_bank_slip_number": 0,
"total_bank_slip_amount": 3,
"total_bank_slip_number": 1,
"written_off_bank_slip_amount": 0,
"written_off_bank_slip_number": 0
}
}
STATUS
400Response Body
{
{"title": "Bad Request", "description": "Invalid request body.", "translation": "Corpo da requisição inválido.", "extra_fields": {}, "code": "LEG000069"}
}
Observações Gerais:
- O tamanho máximo da página (page_size) é 100.
- Caso o número de registros retornados na página corrente seja menor que o page_size o atributo next_page virá nulo.