API ADVBOXVisão Geral
Explore todos os endpoints disponíveis organizados por recurso
Esta página reúne todos os 20 endpoints da API ADVBOX organizados por área. Use como ponto de partida para encontrar o recurso que precisa e acessar a documentação detalhada de cada operação.
⚙️ Antes de começar: A maioria dos endpoints que criam ou atualizam registros exige IDs específicos da sua conta — como o ID do usuário responsável, da fase processual ou da categoria financeira. Esses IDs são obtidos através do endpoint Settings, listado ao final desta página. Consulte-o primeiro.
🤖 Gerando código de integração? Cada endpoint tem um botão Copiar para IA no topo da página. Cole o conteúdo no assistente de sua preferência para gerar o código automaticamente. Para integrações que envolvem múltiplos endpoints, use a Documentação Completa com todos os 20 endpoints de uma vez.
📁 Contatos (Customers)
Gerencie clientes, fornecedores e contatos do escritório. Crie novos leads, busque por CPF/CNPJ/email, e consulte aniversariantes para campanhas de relacionamento.
IDs necessários (obter em /settings):
users_id- ID do usuário responsável pelo contatocustomers_origins_id- ID da origem do lead (Indicação, Facebook, Google, etc.)
GET /customers
Listar todos os clientes com filtros avançados (nome, email, CPF, etc.)
POST /customers
Criar novo contato no sistema
GET /customers/{id}
Buscar dados completos de um contato específico por ID
GET /customers/birthdays
Consultar aniversariantes do mês atual ou específico
⚖️ Processos (Lawsuits)
Gerencie processos judiciais completos: criação, atualização, consulta de movimentações, histórico processual e publicações. Filtre por cliente, fase processual, tipo de ação, responsável, datas e muito mais.
IDs necessários (obter em /settings):
users_id- ID do usuário responsável pelo processocustomers_id- ID do cliente vinculado ao processo (obter em/customers)stages_id- ID da fase processual (ex: Planejamento, Produção, Andamento)type_lawsuits_id- ID do tipo de processo (ex: Trabalhista, Cível, Criminal)
GET /lawsuits
Listar processos com 22+ filtros (cliente, fase, tipo, datas, etc.)
POST /lawsuits
Criar novo processo judicial no sistema
GET /lawsuits/{id}
Buscar dados completos de um processo específico
PUT /lawsuits/{id}
Atualizar dados de um processo existente
GET /history/{lawsuit_id}
Consultar histórico completo de um processo
GET /movements/{lawsuit_id}
Listar todas as movimentações de um processo
POST /movements
Adicionar nova movimentação manual a um processo
GET /last_movements
Consultar o último andamento de cada processo (agrupado por processo)
📋 Tarefas (Posts)
Gerencie posts, anotações e atividades relacionadas aos processos e clientes. Crie lembretes, registre interações importantes e acompanhe o histórico de comunicação.
IDs necessários (obter em /settings):
tasks_id- ID do tipo de tarefa (ex: 1º Contato com Lead, Acompanhar Citação, Protocolar Petição)
📰 Publicações (Publications)
Consulte publicações oficiais dos Diários da Justiça vinculadas aos processos judiciais. Acompanhe intimações, sentenças e demais publicações capturadas automaticamente pelo sistema.
💰 Transações (Transactions)
Gerencie transações financeiras do escritório: honorários recebidos, despesas processuais, custas judiciais e outras movimentações. Crie novas transações (receitas/despesas), atualize valores e datas, e consulte com filtros avançados.
IDs necessários (obter em /settings):
users_id- ID do usuário responsáveldebit_account- ID da conta bancária (campofinancial.banks[])categories_id- ID da categoria financeira (campofinancial.categories[])cost_centers_id- ID do centro de custo (campofinancial.cost_centers[])
GET /transactions
Listar transações financeiras com filtros por data, tipo e status
GET /transactions/{id}
Buscar dados completos de uma transação específica por ID
POST /transactions
Criar nova transação (receita ou despesa)
PUT /transactions/{id}
Atualizar transação existente (valor, vencimento, status de pagamento)
⚙️ Configurações (Settings)
🔑 ENDPOINT ESSENCIAL - Consulte PRIMEIRO antes de usar outros endpoints!
Este endpoint retorna todos os IDs e dados cadastrais da sua conta necessários para criar/atualizar registros em outros endpoints.
📋 O que este endpoint retorna:
| Campo | Descrição | Usado em |
|---|---|---|
users | Lista de usuários do escritório | /customers, /lawsuits, /posts, /transactions |
origins | Origens de leads (ex: Facebook, Indicação) | /customers (campo customers_origins_id) |
tasks | Tipos de tarefas cadastradas | /posts (campo tasks_id) |
stages | Fases processuais (ex: Planejamento, Andamento) | /lawsuits (campo stages_id) |
type_lawsuits | Tipos de processo (ex: Trabalhista, Cível) | /lawsuits (campo type_lawsuits_id) |
💡 Como usar:
- Faça uma requisição GET
/settings - Guarde os IDs retornados (users, origins, tasks, stages, type_lawsuits)
- Use esses IDs ao criar/atualizar contatos, processos e tarefas
Exemplo: Para criar um contato, você precisa informar users_id (responsável) e customers_origins_id (origem). Ambos vêm do /settings.
📊 Resumo dos Recursos
| Recurso | Endpoints | Principais Operações |
|---|---|---|
| Customers | 4 | Listar, Criar, Buscar, Aniversários |
| Lawsuits | 8 | CRUD completo + Histórico/Movimentações |
| Posts | 2 | Listar e Criar tarefas |
| Publications | 1 | Consultar publicações |
| Transactions | 4 | Listar, Buscar, Criar e Atualizar transações |
| Settings | 1 | Consultar configurações |
Total: 20 endpoints documentados