Consulta de boletos

Changed on

Consulte boletos gerados de acordo com a data de vencimento

get/

Request

  • Base URL
    https://api.stage.cora.com.br/v2/invoices
  • URL
    https://api.stage.cora.com.br/v2/invoices/
  • Auth
    OAuth 2

Query parameters

startstring

Data início

endstring

Data final

statestring

Estado do boleto

searchstring

CPF/CNPJ do destinatário

pageinteger

Número da página

perPageinteger

Número de itens por página

Response

200

totalItemsinteger

Example response

{
  "totalItems": 2,
  "items": [
    {
      "id": "inv_OVP4p99hiRr2LJ71omCWAOg",
      "status": "OPEN",
      "created_at": "2021-11-26T14:41:27Z",
      "total_amount": 1001,
      "code": "meu_id",
      "customer": {
        "name": "Gol Transportes Aereos Sa",
        "email": "email@email.com",
        "document": {
          "identity": "34052649000178",
          "type": "CNPJ"
        },
        "address": {
          "street": "Rua Gomes de Carvalho",
          "number": "1629",
          "district": "Vila Olímpia",
          "city": "São Paulo",
          "state": "SP",
          "complement": "N/A",
          "zip_code": "00111222"
        }
      },
      "services": [
        {
          "name": "Nome Do Serviço",
          "description": "Descrição do serviço",
          "amount": 1001,
          "unit": "AMOUNT"
        }
      ],
      "payment_terms": {
        "due_date": "2021-03-01",
        "fine": {
          "date": "2021-03-02",
          "amount": 200
        },
        "interest": {
          "rate": 3.67
        }
      },
      "payment_options": {
        "bank_slip": {
          "barcode": "00199854600000010010000003202047000001569517",
          "digitable": "00190000090320204700900015695179985460000001001",
          "our_number": "41454560000075000",
          "registered": true,
          "url": "https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-975feef6-e399-49ed-9237-9a5e87d22325.pdf?generation=1637937687388008&alt=media"
        }
      }
    }
  ]
}

Changes

    • breaking

      the response's body type changed from array to object for status

    • info

      api operation id lista-de-endpoints removed and replaced with consultar-boletos

    • info

      added the new optional query request parameter end

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter perPage

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter start

    • info

      added the new optional query request parameter state

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status