Retorna uma lista de agendas resumidas

Este serviço retorna a lista paginada das agendas autorizadas ao Agente Financiador. Cada item resume uma agenda em totais (summary) e indicadores (insights), sem a lista de duplicatas. Para as duplicatas, use a agenda detalhada.

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

Conceitos

ConceitoO que é
AgendaConjunto das duplicatas de um Sacador que a registradora disponibiliza ao Agente Financiador com opt-in aprovado.
CarteiraAgrupamento das duplicatas da agenda por CNPJ do Sacador (matriz e filiais). Uma agenda pode ter uma, várias ou nenhuma carteira.
Unidade de Duplicata (UD)Agrupamento das duplicatas de um mesmo Sacado com o mesmo vencimento.
DuplicataTítulo escritural identificado pelo IUD (Identificador Único da Duplicata).

A hierarquia é agenda > carteiras > UDs > duplicatas. A agenda resumida entrega os totais da agenda inteira; a agenda detalhada entrega a hierarquia completa.

Tipos e abrangências

  • A agenda pode ser recorrente, gerada pela registradora na frequência do opt-in (calendar_frequency), ou online, solicitada sob demanda em Cria solicitação de agenda online. As duas aparecem nas mesmas consultas.
  • calendar_scope é a abrangência autorizada pelo opt-in: open (duplicatas em aberto), historical (duplicatas do histórico) ou all (ambas).

Pré-requisitos

Filtros e paginação

  • opt_in_id e schedule_id restringem a listagem e podem ser combinados; uma agenda só é retornada quando atende aos dois.
  • As agendas vêm em ordem de criação decrescente.
  • limit tem padrão e máximo de 100; valores maiores são ajustados para 100. 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.

Como ler os totais e indicadores

  • Os totais e indicadores cobrem todas as duplicatas de todas as carteiras da agenda, sem janela de vencimento. Cada duplicata conta uma vez, na sua versão mais recente e pelo valor atualizado.
  • A disponibilidade considera só as duplicatas ativas, isto é, sem motivo de encerramento. É comprometida toda duplicata ativa que não está available, inclusive a que não tem disponibilidade informada. Uma duplicata encerrada entra nos totais gerais, mas não em disponível nem em comprometida; por isso disponível + comprometida pode ficar abaixo do total.
  • Em agenda histórica, os campos de disponibilidade e os indicadores que dependem dela são null. As quebras e buyer_statements continuam calculados. Isso vale para toda agenda de opt-in historical e também para as agendas históricas de um opt-in all, que continuam trazendo calendar_scope: all.
  • Nas quebras por efeito de contrato, cada duplicata conta uma vez por categoria e pode aparecer em mais de uma. Todas as categorias estão sempre presentes, com count: 0 e amount: 0.0 quando vazias.
  • Os valores podem diferir dos da agenda detalhada, que aplica janela de vencimento e filtros e conta como comprometida, nos indicadores, só a duplicata com availability: committed.

Resultados vazios

  • Sem nenhuma agenda para a consulta, a resposta é 200 com data vazio e pagination.total igual a 0.
  • Uma agenda sem duplicatas é retornada normalmente, com os totais zerados e os indicadores de média em null.

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.

integer
≥ 1
Defaults to 100

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

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