Consultar agenda específica

Use este endpoint para consultar agenda pelo id da agenda ou pela loja e data de vencimento.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/agenda-lojista/agenda/analitico?idAgenda&idLoja&dataVencimento&pageLancamento&sizeLancamento&pagePagamento&sizePagamento' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json'

{ "lancamentos": { "totalPages": 52, "totalElements": 1000, "size": 20, "content": [ { "idAgenda": 1, "idOrigem": "123", "idTransacao": "123", "idLoja": 1, "parcelaAtual": 2, "totalParcelas": 5, "dataProcessamento": "2025-03-17T14:38:24.637Z", "dataVencimentoAgenda": "2025-03-17T14:38:24.637Z", "valorOriginal": 100, "valorTaxa": 10, "valor": 110 } ], "number": 0, "sort": { "empty": false, "sorted": true, "unsorted": true }, "pageable": { "offset": 0, "sort": { "empty": false, "sorted": true, "unsorted": true }, "pageNumber": 0, "pageSize": 20, "paged": true, "unpaged": false }, "numberOfElements": 1000, "first": true, "last": false, "empty": false }, "pagamentos": { "totalPages": 50, "totalElements": 1000, "size": 20, "content": [ { "id": "1", "valor": 1, "dataHoraRecebimento": "2025-03-17T14:36:01.330Z", "dataHoraProcessamento": "2025-03-17T14:36:01.330Z", "meioPagamento": "PIX", "agenda": { "id": 1 } } ], "number": 1, "sort": { "empty": false, "sorted": true, "unsorted": true }, "pageable": { "offset": 0, "sort": { "empty": false, "sorted": true, "unsorted": true }, "pageNumber": 0, "pageSize": 20, "paged": true, "unpaged": false }, "numberOfElements": 20, "first": true, "last": false, "empty": false } }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Query

idAgenda

integer <int64>

opcional

Identificador da agenda.

Padrão:

Exemplo:

idLoja

integer <int64>

opcional

Identificador do estabelecimento.

Padrão:

Exemplo:

dataVencimento

string <date>

opcional

Data de vencimento da agenda.

Padrão:

2025-03-19

Exemplo:

2025-03-19

pageLancamento

integer <int32>

opcional

A quantidade de páginas de lançamentos.

Padrão:

Exemplo:

sizeLancamento

integer <int32>

opcional

A quantidade de lançamentos por página.

Padrão:

Exemplo:

pagePagamento

integer <int32>

opcional

A quantidade de páginas de pagamentos.

Padrão:

Exemplo:

sizePagamento

integer <int32>

opcional

A quantidade de pagamentos por página.

Padrão:

Exemplo:

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

Objeto de resposta da Agenda Analítica.

lancamentos

object (PageLancamentoAnaliticoResponse)

opcional

totalPages

integer <int32>

opcional

Número total de páginas.

Exemplo:

totalElements

integer <int64>

opcional

Número total de elementos ou registros disponíveis no conjunto de dados completo.

Exemplo:

1000

size

integer <int32>

opcional

Número de registros retornados por página.

Exemplo:

content

array[object (LancamentoAnaliticoResponse) {11}]

opcional

number

integer <int32>

opcional

Número da página atual.

sort

object (Sort)

opcional

pageable

object (PageableObject)

opcional

numberOfElements

integer <int32>

opcional

Número de registros na página.

Exemplo:

1000

first

boolean

opcional

Indica se a página atual é a primeira página de resultados.

Exemplo:

true

last

boolean

opcional

Indica se é a última página.

Exemplo:

false

empty

boolean

opcional

Indica que é vazio

Exemplo:

false

pagamentos

object (PageRecebimentoAnaliticoResponse)

opcional

totalPages

integer <int32>

opcional

Número total de páginas.

Exemplo:

totalElements

integer <int64>

opcional

Número total de elementos ou registros disponíveis no conjunto de dados completo.

Exemplo:

1000

size

integer <int32>

opcional

Número de registros retornados por página.

Exemplo:

content

array[object (RecebimentoAnaliticoResponse) {6}]

opcional

number

integer <int32>

opcional

Número da página atual.

Exemplo:

sort

object (Sort)

opcional

pageable

object (PageableObject)

opcional

numberOfElements

integer <int32>

opcional

Número de registros na página.

Exemplo:

first

boolean

opcional

Indica se a página atual é a primeira página de resultados.

Exemplo:

true

last

boolean

opcional

Indica se é a última página.

Exemplo:

false

empty

boolean

opcional

Indica que é vazio

Exemplo:

false

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor