Gestão de Pagamentos - Boletos

Retorna uma pesquisa de boleto com notas

Este endpoint retorna os boletos com notas baseado em uma série de filtros

post/v2/bank-billet/search

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v2/bank-billet/search
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Request body

ownersstring[]

Array contendo os CPFs ou CNPJs para pesquisa

document_identifierstring

Identificador único do boleto/documento

status'open' | 'overdue' | 'paid' | 'canceled' | 'closed' | 'blocked'

Status do boleto

trust_level'high' | 'medium' | 'low'

Nível de confiança dos boletos

linked_document_typestring[]

Tipos de documentos anexados a serem procurados

limitinteger

Número máximo de itens por página

nextstring

Cursor retornado na requisição anterior (caso exista)

Example request

{
  "owners": [
    "19427033000140"
  ],
  "issue_date": {
    "from": "2023-01-01",
    "to": "2023-12-31"
  },
  "due_date": {
    "from": "2023-01-01",
    "to": "2023-12-31"
  },
  "updated_at": {
    "from": "2023-01-01",
    "to": "2023-12-31"
  },
  "document_identifier": "03397060000000000000450000012345678909876543",
  "status": "open",
  "trust_level": "high",
  "linked_document_type": [
    "nfse",
    "nfe"
  ],
  "limit": 10,
  "next": "eyJjdXJzb3IiOiIxMjM0NTYifQ=="
}

Response

Requisição bem sucedida

Example response

{
  "meta": {
    "limit": 10,
    "next": "eyJjdXJzb3IiOiIxMjM0NTYifQ==",
    "previous": "eyJjdXJzb3IiOiIxMjM0NTYifQ==",
    "current page": 6
  },
  "data": [
    {
      "beneficiary": {
        "name": "ARQUIVEI SERVICOS ON LINE LTDA",
        "document": "19427033000140",
        "bank_number": "341",
        "bank_name": "Itaú Unibanco S.A."
      },
      "final_beneficiary": {
        "name": "ARQUIVEI SERVICOS ON LINE LTDA",
        "document": "19427033000140"
      },
      "owner": {
        "name": "ARQUIVEI SERVICOS ON LINE LTDA",
        "document": "19427033000140",
        "address": {
          "uf": "SP",
          "city": "São Carlos",
          "public_place": "Avenida Doutor Carlos Botelho, 1863"
        }
      },
      "issue_date": "2024-10-16",
      "due_date": "2024-10-28",
      "currency": "BRL",
      "cost": "6697.51",
      "cost_updated": "0",
      "discounts": [
        {
          "currency": "BRL",
          "value": "433.72",
          "date": "2024-08-30"
        }
      ],
      "fine": "264.1",
      "interest": "911.6",
      "bar_code": "28193710760346025632108371649224332004168051",
      "digitable_line": "23794020000000000000670000012345678902109876",
      "pdf_path": "https://api.arquivei.com.br/v1/bank-billet/19427033000140/23794020000000000000670000012345678902109876/pdf",
      "linked_documents": [
        {
          "document_type": "NFSe",
          "document_identifier": "23794020000000000000670000012345678902109876",
          "search_id": "23794020000000000000670000012345678902109876",
          "emitter_cnpj": "00062914000187"
        },
        {
          "document_type": "NFe",
          "document_identifier": "35230901737623000104550010000226191358056851",
          "search_id": "35230901737623000104550010000226191358056851"
        }
      ],
      "trust_level": "high",
      "status": "paid",
      "document_number": "001347589",
      "our_number": "491382749559767141"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.