Consultar faturas por período

Sandbox

https://horizon-api-sb.app.rpe.tech

GET

/api/v1/faturamentos/portador/{idPortador}/faturas/periodo

Use este endpoint para listar as faturas do portador em um determinado período.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Path

Parâmetros Query

Parâmetros Header

Respostas

🟢200OK

application/json

Body

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/faturamentos/portador//faturas/periodo?dataInicial&dataFinal' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Cards

{
    "faturasResponse": [
        {
            "idFatura": "72994979",
            "dataVencimento": "2023-01-15T03:00:00.000+0000",
            "valorTotal": 2521.53,
            "valorMinimo": 451.44,
            "valorPagamentosEfetuados": 0,
            "devedor": 0,
            "status": "PASSADA",
            "faturaDisponivel": true
        }
    ],
    "limitePrincipal": 4455,
    "limiteParcelado": 0,
    "saldoDisponivel": 0,
    "saldoReservado": 0,
    "saldoDisponivelParcelado": 0,
    "devedorTotal": 4566.94,
    "devedorParcelado": 0
}

Página anterior

Consultar lançamentos futuros

Próxima página

Consultar faturas futuras