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
- Token de acesso obtido em Autenticação para acesso aos serviços da Jornada do Financiador, enviado no header
Authorization: Bearer <access_token>. - Um opt-in aprovado. Agendas de opt-ins pendentes, recusados, revogados ou expirados não aparecem, nem as de outros Agentes Financiadores.
Janela de vencimento
A consulta sempre aplica uma janela sobre o vencimento (due_date) das UDs, com limites inclusivos.
| Parâmetros enviados | Janela aplicada |
|---|---|
Nenhum, agenda open | De hoje até 30 dias depois. |
Nenhum, agenda historical | De 30 dias antes até hoje. |
Nenhum, agenda all | De 30 dias antes até 30 dias depois. |
Só due_date__gte | Da data informada até 30 dias depois dela. |
Só due_date__lte | De 30 dias antes da data informada até ela. |
due_date__gte e due_date__lte | O 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.
| Filtro | Aplica-se a | Efeito |
|---|---|---|
opt_in_id, schedule_id | Agendas | Restringem as agendas listadas. |
due_date__gte, due_date__lte | UDs | Janela de vencimento. |
ud_availability, buyer_document, ud_id | UDs | Mantêm só as UDs que atendem ao filtro. |
availability, registered_invoice_type, issue_date__gte, issue_date__lte, updated_at__gte, updated_at__lte | Duplicatas | Mantêm só as duplicatas que atendem ao filtro. Uma UD que fica sem nenhuma duplicata não é retornada. |
issue_date__gteposterior aissue_date__lte, ouupdated_at__gteposterior aupdated_at__lte, retorna 400.updated_at__gteeupdated_at__lteexigem fuso horário explícito, por exemplo2026-11-01T00:00:00-03:00ou2026-11-01T03:00:00Z. Sem o fuso, retorna 400.- Os totais de
summary(total_amount,total,total_remaining_amount,total_ud_counteud_availabilities) e os indicadores deinsightssão calculados só sobre o recorte já filtrado.
Ordenação e paginação
order_byordena as UDs dentro de cada agenda, com desempate peloidda UD. Sem ele, as UDs vêm por vencimento.- As agendas vêm sempre em ordem de criação decrescente;
order_bynão altera essa ordem. - A paginação é por agenda:
limittem padrão 10 e máximo 50; valores maiores são ajustados para 50.offsettem padrão 0.limitmenor que 1 ouoffsetnegativo retorna 400. pagination.totalé a quantidade de agendas que atendem à consulta epagination.counté a quantidade retornada na página. Umoffsetalém do total retornadatavazio com ototalreal.- Qualquer parâmetro desconhecido, como
pageoupage_size, retorna 400.
Campos que podem vir null
nullUm 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énullenquanto a duplicata não foi encerrada.discount_amounteinterest_amountsãonullenquanto não houver um valor monetário único para o desconto ou para os juros.penalty_amountsó é preenchido quando a multa é de valor fixo.updated_at,issue_date,typeeavailabilityda duplicata sãonullquando a registradora não informa o dado.- Os indicadores de média em
insightssãonullquando não há duplicatas no recorte.
Resultados vazios
- Sem nenhuma agenda para a consulta, a resposta é 200 com
datavazio epagination.totaligual a0. - Uma agenda sem duplicatas na janela, ou sem nenhuma carteira, é retornada com
portfoliosvazio 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
0a100. - Datas (
due_date,issue_date) seguem o formatoAAAA-MM-DD. - Data e hora (
updated_at) seguem o padrão ISO 8601 em UTC. Exemplo:2026-11-11T20:11:51.987869Z. - O
updated_atda agenda é a última atualização da agenda na registradora. Ele indica o quão recentes são os dados retornados e pode sernullenquanto 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
| Status | Quando acontece |
|---|---|
| 400 | Parâ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. |
| 401 | Token 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.

