Listar cobranças.

GET

/invoices

Cobranças

Lista as cobranças (invoices) da conta, com paginação.

Use filter para buscar por descrição ou nome do pagador.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

invoices.read-Permite consultar cobranças/faturas

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠422

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location '/invoices?page=undefined&perPage=undefined&filter=undefined' \
--header 'x-account-id;'

Response Example

200 - Exemplo 1

{
    "meta": {
        "total": 0,
        "perPage": 0,
        "currentPage": 0,
        "firstPage": 0,
        "lastPage": 0,
        "nextPage": 0,
        "prevPage": 0
    },
    "data": [
        {
            "id": 0,
            "txId": "string",
            "amount": 0,
            "status": "DRAFT",
            "type": "IMMEDIATE",
            "dueDate": "2019-08-24T14:15:22.123Z",
            "paymentMethod": "PIX",
            "boletoBarcode": "string",
            "boletoDigitableLine": "string",
            "customer": {
                "id": 0,
                "name": "string",
                "document": "string"
            }
        }
    ]
}

Página anterior

Criar cobrança Pix, boleto ou híbrida.

Próxima página

Consultar cobrança.