1. Acompanhamento
HubDE
  • Instruções Gerais
    • Como começar
  • Integração para ERPs e Portais do Cedente
    • Integração para ERPs e Portais do Cedente
    • Cadastro do cedente
      • Cria a sessão de cadastro do cedente
      • Cria a sessão de acompanhamento
      • Consulta o cliente da credencial
      • Lista as escrituradoras disponíveis
    • Duplicatas
      • Envia as duplicatas de uma operação
      • Consulta o desfecho das duplicatas
      • Informa a liquidação de títulos
    • Acompanhamento
      • Consulta a situação dos cedentes
        GET
  1. Acompanhamento

Consulta a situação dos cedentes

GET
/erp/v1/cedentes
O par do GET /erp/v1/duplicatas, para o cadastro. Lá você pergunta o desfecho dos
títulos; aqui, o do cedente. São perguntas diferentes e a segunda explica a primeira: uma
duplicata fica pendente em silêncio enquanto o cadastro do cedente não termina, porque
ela só é roteada depois que o vínculo está ativo e a Escrituradora habilitou o cedente
a emitir.
É a rota que um portal do cedente precisa. Quando quem clica no seu sistema é o
próprio cedente, não há operador para abrir a tela de acompanhamento: quem precisa saber
"falta assinar", "está na Escrituradora" ou "está ativo" é ele, dentro do seu portal.
Filtre por documentoCedente e amarre ao seu login. O escopo que o HubDE garante é o do
cliente da chave de API — ou seja, todos os cedentes que você enviou. Quem recorta um
cedente é você. Daí a regra da seção de segurança: a chave de API nunca vai ao navegador
do cedente
; a chamada sai do seu servidor.
Varra por atualizadoDesde, com a mesma disciplina do desfecho da duplicata: guarde o
maior atualizadoEm recebido e devolva-o na chamada seguinte. O corte é inclusivo, de
propósito.
entrega vem nulo na maior parte da jornada, e isso é normal. O item de entrega à
Escrituradora só nasce quando o pacote assinado é baixado — antes disso não há o que
entregar.
A página vem da mais recente para a mais antiga (criadoEm decrescente). Como a
paginação é por deslocamento, um cadastro novo entre duas páginas desloca as seguintes:
para varrer tudo, use atualizadoDesde em vez de percorrer páginas.

Requisição

Parâmetros de Consulta

Respostas

🟢200
application/json
A página de cedentes.
Headers

Bodyapplication/json

🟠400
🟠401NaoAutenticada
🟠403Suspensa
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/erp/v1/cedentes?documentoCedente=&situacao=&atualizadoDesde=2026-11-18T22%3A40%3A00Z&pagina=&tamanho='
Response Response Example
200 - Um já ativo e um esperando o cedente assinar
{
    "pagina": 1,
    "tamanho": 50,
    "total": 2,
    "itens": [
        {
            "processoId": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
            "documentoCedente": "46182485000182",
            "nomeCedente": "PRINCE COMERCIO LTDA",
            "situacao": "ativo",
            "escrituradora": "B3",
            "criadoEm": "2026-11-18T22:25:00Z",
            "atualizadoEm": "2026-11-18T23:02:11Z",
            "prazoAssinatura": "2026-12-03T22:31:00Z",
            "entrega": {
                "situacao": "confirmado",
                "desfecho": "aprovado",
                "idExterno": "46182485000182",
                "confirmadoEm": "2026-11-18T23:02:11Z"
            }
        },
        {
            "processoId": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5c",
            "documentoCedente": "11222333000181",
            "nomeCedente": "ACME INDUSTRIA SA",
            "situacao": "aguardando_assinatura",
            "escrituradora": "B3",
            "criadoEm": "2026-11-18T21:10:00Z",
            "atualizadoEm": "2026-11-18T21:12:40Z",
            "prazoAssinatura": "2026-12-03T21:10:00Z",
            "entrega": null
        }
    ]
}
Modificado em 2026-11-19 05:54:58
Página anterior
Informa a liquidação de títulos
Built with