Retorna uma lista de agendas detalhadas

Este serviço retorna a lista paginada das agendas autorizadas ao Agente Financiador com a hierarquia completa: carteiras (portfolios), Unidades de Duplicata (uds) e duplicatas (registered_invoices). Os conceitos de agenda, carteira, UD e duplicata estão descritos na agenda resumida.

Agendas na Jornada do Financiador: Solicitar agenda online | Agenda resumida | Agenda detalhada | Acompanhar o processamento

Pré-requisitos

Janela de vencimento

A consulta sempre aplica uma janela sobre o vencimento (due_date) das UDs, com limites inclusivos.

Parâmetros enviadosJanela aplicada
Nenhum, agenda openDe hoje até 30 dias depois.
Nenhum, agenda historicalDe 30 dias antes até hoje.
Nenhum, agenda allDe 30 dias antes até 30 dias depois.
Só due_date__gteDa data informada até 30 dias depois dela.
Só due_date__lteDe 30 dias antes da data informada até ela.
due_date__gte e due_date__lteO intervalo informado, de no máximo 6 meses.

"Hoje" é a data no fuso horário de Brasília (America/Sao_Paulo). Uma janela maior que 6 meses, ou due_date__gte posterior a due_date__lte, retorna 400.

Por causa da janela, duplicatas com vencimento fora dela não são retornadas mesmo que existam na agenda. Para ver os totais da agenda inteira, use a agenda resumida.

Filtros

Todos os filtros são opcionais e combinados entre si; um item só é retornado quando atende a todos.

FiltroAplica-se aEfeito
opt_in_id, schedule_idAgendasRestringem as agendas listadas.
due_date__gte, due_date__lteUDsJanela de vencimento.
ud_availability, buyer_document, ud_idUDsMantêm só as UDs que atendem ao filtro.
availability, registered_invoice_type, issue_date__gte, issue_date__lte, updated_at__gte, updated_at__lteDuplicatasMantêm só as duplicatas que atendem ao filtro. Uma UD que fica sem nenhuma duplicata não é retornada.
  • issue_date__gte posterior a issue_date__lte, ou updated_at__gte posterior a updated_at__lte, retorna 400.
  • updated_at__gte e updated_at__lte exigem fuso horário explícito, por exemplo 2026-11-01T00:00:00-03:00 ou 2026-11-01T03:00:00Z. Sem o fuso, retorna 400.
  • Os totais de summary (total_amount, total, total_remaining_amount, total_ud_count e ud_availabilities) e os indicadores de insights são calculados só sobre o recorte já filtrado.

Ordenação e paginação

  • order_by ordena as UDs dentro de cada agenda, com desempate pelo id da UD. Sem ele, as UDs vêm por vencimento.
  • As agendas vêm sempre em ordem de criação decrescente; order_by não altera essa ordem.
  • A paginação é por agenda: limit tem padrão 10 e máximo 50; valores maiores são ajustados para 50. offset tem padrão 0. limit menor que 1 ou offset negativo retorna 400.
  • pagination.total é a quantidade de agendas que atendem à consulta e pagination.count é a quantidade retornada na página. Um offset além do total retorna data vazio com o total real.
  • Qualquer parâmetro desconhecido, como page ou page_size, retorna 400.

Campos que podem vir null

Um campo null indica que a registradora não informou o dado ou que ele não se aplica à duplicata. Os casos mais comuns:

  • closure_reason é null enquanto a duplicata não foi encerrada.
  • discount_amount e interest_amount são null enquanto não houver um valor monetário único para o desconto ou para os juros. penalty_amount só é preenchido quando a multa é de valor fixo.
  • updated_at, issue_date, type e availability da duplicata são null quando a registradora não informa o dado.
  • Os indicadores de média em insights são null quando não há duplicatas no recorte.

Resultados vazios

  • Sem nenhuma agenda para a consulta, a resposta é 200 com data vazio e pagination.total igual a 0.
  • Uma agenda sem duplicatas na janela, ou sem nenhuma carteira, é retornada com portfolios vazio e os totais zerados.

Valores, datas e atualização dos dados

  • Valores monetários são números decimais em reais (BRL), com ponto como separador decimal. Exemplo: 1381.85.
  • Percentuais vão de 0 a 100.
  • Datas (due_date, issue_date) seguem o formato AAAA-MM-DD.
  • Data e hora (updated_at) seguem o padrão ISO 8601 em UTC. Exemplo: 2026-11-11T20:11:51.987869Z.
  • O updated_at da agenda é a última atualização da agenda na registradora. Ele indica o quão recentes são os dados retornados e pode ser null enquanto a registradora não informar a data.
  • Os dados são sincronizados a partir da registradora de duas formas: de modo recorrente, na frequência definida no opt-in, e sob demanda, quando uma agenda online é solicitada. As consultas sempre refletem a última sincronização concluída.

Erros

StatusQuando acontece
400Parâmetro com valor inválido ou parâmetro desconhecido. A resposta traz error: VALIDATION_ERROR e o campo detail lista cada parâmetro recusado em field e o motivo em message.
401Token ausente, inválido ou expirado. Obtenha um novo token em Atualizar o Token de Acesso.

Um opt_in_id ou schedule_id inexistente, de opt-in não aprovado ou de outro Agente Financiador não é erro: a resposta é 200 com data vazio.

Query Params

Restringe a listagem às agendas deste opt-in.

Restringe a listagem a esta agenda.

UDs com vencimento a partir desta data (inclusive).

UDs com vencimento até esta data (inclusive).

InvoiceAvailability | null

Restringe às duplicatas com esta disponibilidade: available, committed, blocked_by_drawer ou judicially_blocked.

InvoiceType | null

Restringe às duplicatas deste tipo: mercantil ou servico.

Restringe às UDs deste Sacado (número do documento, sem máscara).

Restringe a esta UD (id da UD retornado pela própria listagem).

Restringe às duplicatas emitidas a partir desta data (inclusive).

Restringe às duplicatas emitidas até esta data (inclusive).

Restringe às duplicatas atualizadas a partir deste instante (inclusive). Exige fuso horário.

Restringe às duplicatas atualizadas até este instante (inclusive). Exige fuso horário.

UdStatus | null

Restringe às UDs com esta situação calculada: available, committed ou partially_committed.

UdOrderBy | null

Ordena as UDs de cada agenda; desempate sempre pelo id da UD. Sem este parâmetro, a ordem é por vencimento. A ordem das agendas em si é sempre por criação decrescente, não afetada por este parâmetro.

ValorDescrição
updated_at_ascPela duplicata mais recentemente atualizada da UD, crescente.
updated_at_descPela duplicata mais recentemente atualizada da UD, decrescente.
total_amount_ascPelo total_amount da UD, crescente.
total_amount_descPelo total_amount da UD, decrescente.
total_ascPelo total (quantidade de duplicatas) da UD, crescente.
total_descPelo total (quantidade de duplicatas) da UD, decrescente.
integer
≥ 1
Defaults to 10

Quantidade máxima de agendas por página. Acima de 50 é ajustado para 50.

integer
≥ 0
Defaults to 0

Quantidade de agendas a pular.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json