# Atualizar grupo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/action-groups/atualizar-grupo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json patch /actionGroup/{id} # Buscar grupo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/action-groups/buscar-grupo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json get /actionGroup/{id} # Criar grupo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/action-groups/criar-grupo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json post /actionGroup/ # Excluir grupos de ação Source: https://juridiqsoftware.mintlify.app/api-reference/action-groups/excluir-grupos-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json delete /actionGroup/ # Listar grupos de ação Source: https://juridiqsoftware.mintlify.app/api-reference/action-groups/listar-grupos-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json get /actionGroup/ # Atualizar audiência Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/atualizar-audiência https://api.juridiq.com.br/api-docs/client/openapi.json patch /audience/{id} Atualiza uma audiência do escritório autenticado; campo ausente no body fica como está. `date` vai em AAAA-MM-DD e `initialHour`/`finalHour` em HH:mm. `type` é a modalidade: online, presencial, hibrida (minúsculas, sem acento). `audienceParticipants` com itens substitui a lista de participantes (mande também os que ficam; outro usuário: 400); lista vazia é ignorada. `personIds` substitui a lista de pessoas; `[]` remove todas. `description` vazia é ignorada. Audiência ou pessoa (`personIds`) de outro escritório: 404. Aceita JWT ou o header `x-juridiq-api-key`. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham "Ver e editar", e só entra participante que compartilha "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Buscar audiência Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/buscar-audiência https://api.juridiq.com.br/api-docs/client/openapi.json get /audience/{id} Audiência confidencial só para dono, participantes e Gestor/Suporte (403). Audiência sem processo nem pessoa da agenda de colega que não compartilha os detalhes responde 404. # Criar audiência Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/criar-audiência https://api.juridiq.com.br/api-docs/client/openapi.json post /audience/ Cria uma audiência no escritório autenticado. `date` vai em AAAA-MM-DD e `initialHour`/`finalHour` em HH:mm. `type` é a modalidade: online, presencial, hibrida (minúsculas, sem acento); `audienceLink` e `location` são gravados como vierem, em qualquer modalidade. `audienceParticipants` são IDs de usuários do escritório (outro usuário: 400) e `personIds`, de pessoas do escritório (outra pessoa: 404). Aceita JWT ou o header `x-juridiq-api-key`. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham "Ver e editar", e só entra participante que compartilha "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Excluir audiência Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/excluir-audiência https://api.juridiq.com.br/api-docs/client/openapi.json delete /audience/{id} Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Excluir audiências em lote Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/excluir-audiências-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json delete /audience/ Recusa o lote inteiro (403) se alguma audiência não puder ser apagada. Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os participantes compartilham "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Listar audiências Source: https://juridiqsoftware.mintlify.app/api-reference/audiences/listar-audiências https://api.juridiq.com.br/api-docs/client/openapi.json get /audience/ Lista as audiências do escritório autenticado. Com `page` (começa em 1) e `limit`, pagina; sem `limit`, devolve todas. Por padrão, audiência privada só vem para quem a criou ou participa dela. `date` (AAAA-MM-DD, ou ISO com horário: vale o dia escrito, sem converter fuso) vale como `start` e `end` quando eles não vêm; `start` e `end` são inclusivos. `type` filtra pela modalidade (online, presencial, hibrida (minúsculas, sem acento)). `lawSuit` é o ID do processo e `responsibles`, IDs de usuários separados por vírgula. Ordem padrão: `date` decrescente; `orderByField` fora de date, createdAt e updatedAt: 400. Aceita JWT ou o header `x-juridiq-api-key`. Sem filtro de processo ou pessoa, vale o compartilhamento de agenda de quem consulta (a chave de API consulta como o dono dela): audiência de colega que não compartilha não vem; a de quem compartilha só livre/ocupado vem com título "Ocupado" e `busy: true`, com o conteúdo vazio (sem pessoas, processo, link, descrição e modalidade) (com `title`, ela não vem: o título casado revelaria o conteúdo). Gestor e Suporte não passam pelo compartilhamento. # Listar logs de auditoria Source: https://juridiqsoftware.mintlify.app/api-reference/audit-log/listar-logs-de-auditoria https://api.juridiq.com.br/api-docs/client/openapi.json get /audit-log/ Lista o registro de auditoria do escritório: criações (CREATE), alterações (UPDATE), exclusões (DELETE) e revelações de dado sensível (REVEAL) dos tipos de `entityType`, com autor, data e campos. Ação feita por automação ou por chave de API traz `origin`. **Permissão:** o dono da chave precisa ser Gestor ou ter "Configurações - Usuários › Visualizar"; sem isso, 403. A lista inclui registros de itens privados. **Ordem e paginação:** mais recentes primeiro (`createdAt` decrescente, empate por `id`). `page` começa em 1 e `limit` vai até 100; use `totalPages` para saber quando parar. **Retenção:** 90 dias. Registros de pessoas (`person`) e de publicações (`publication`) não expiram. **Tarefas excluídas:** `entityType=task&action=DELETE` com `startDate` e `endDate`. Toda exclusão de tarefa grava um registro, inclusive a que vem da exclusão da coluna, do quadro ou da pasta; `entityId` é o id da tarefa e `changes` traz os campos auditados dela em `before`. A gravação é assíncrona e sem garantia de entrega: feche a janela com folga (`endDate` pelo menos 5 minutos no passado), comece a próxima no `endDate` anterior e descarte repetidos pelo `id` do registro. Antes de apagar a sua cópia, confirme com `GET /task/{id}`: só 404 significa excluída (403 é tarefa privada que o dono da chave não vê). # Recuperar item excluído a partir de log de auditoria Source: https://juridiqsoftware.mintlify.app/api-reference/audit-log/recuperar-item-excluído-a-partir-de-log-de-auditoria https://api.juridiq.com.br/api-docs/client/openapi.json post /audit-log/{id}/restore Recria um item excluído a partir do registro DELETE dele. Vale para task, consulting, consultingColumn e funnel. O registro DELETE fica 90 dias; depois disso, a resposta é 404. O item volta com o mesmo `id` e só com estes campos de `changes.before` (campo nulo conta como ausente): - task: title, description, status, priority, initialDate, finalDate, initialHour, finalHour, taskKanbanColumnId, lawSuitId, isPrivate, points, needValidation, isValidated e ownerId. Sem title, usa entityLabel. Ausentes: status Pendente, priority Normal, initialDate a data atual em UTC, points 0, isPrivate, needValidation e isValidated false; os demais ficam vazios. Sem ownerId, a tarefa volta sem dono; - consulting: subject, personId, lawSuitId, consultingColumnId, ownerId, isPrivate, currentIndex, tagIds e taskIds. Sem subject, usa entityLabel. Ausentes: isPrivate false; lawSuitId, consultingColumnId, currentIndex, tagIds e taskIds ficam vazios; sem ownerId, o dono passa a ser quem recupera; sem personId, 400. A conclusão segue a coluna: fora da coluna de concluídos fica vazia; na de concluídos, mantém completedAt (e completedById, se o usuário ainda existe) ou, sem conclusão no registro, conclui agora em nome de quem recupera. As tarefas de taskIds saem do atendimento em que estiverem e passam para este; - consultingColumn: name, color, timeLimitDays, showBadgeProgress, index e kind. Sem name, usa entityLabel ou "Coluna recuperada". Ausentes: timeLimitDays 30, showBadgeProgress true, kind IN_PROGRESS; color e index ficam vazios. Volta sem funil; - funnel: name, index e isDefault. Sem name, usa entityLabel. Ausentes: isDefault false; index fica vazio. Volta com as colunas padrão. Relações e vínculos fora dessa lista não voltam (ex.: responsáveis, comentários, anexos, subtarefas, campos personalizados, registros do atendimento e histórico). A recuperação grava um registro CREATE. **Permissão:** o dono da chave precisa ser Gestor ou ter "Configurações - Usuários › Criar e Editar"; sem isso, 403. **Erros:** 404 quando o registro não existe neste escritório. 400 quando: o registro não é DELETE; o tipo não é recuperável; o registro não guarda dados; falta a pessoa do atendimento; falta o título da tarefa, o assunto do atendimento ou o nome do funil e também o entityLabel; um vínculo guardado não existe mais (coluna, processo, pessoa, dono, etiqueta ou tarefa); ou já existe funil padrão. 409 quando já existe item com o mesmo `id` (já recuperado ou ainda existe) ou funil com o mesmo nome. # Atualizar coluna de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-columns/atualizar-coluna-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json patch /consulting-columns/{id} # Buscar coluna de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-columns/buscar-coluna-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json get /consulting-columns/{id} # Criar coluna de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-columns/criar-coluna-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json post /consulting-columns/ # Excluir coluna de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-columns/excluir-coluna-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json delete /consulting-columns/{id} # Listar colunas de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-columns/listar-colunas-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json get /consulting-columns/ # Arquivar campo personalizado de atendimentos e casos Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-custom-fields/arquivar-campo-personalizado-de-atendimentos-e-casos https://api.juridiq.com.br/api-docs/client/openapi.json delete /consulting-custom-fields/{id} Arquiva definição sem apagar valores já registrados em atendimentos e casos. # Atualizar campo personalizado de atendimentos e casos Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-custom-fields/atualizar-campo-personalizado-de-atendimentos-e-casos https://api.juridiq.com.br/api-docs/client/openapi.json patch /consulting-custom-fields/{id} Atualiza nome ou opções sem alterar tipo nem remover opções já configuradas. # Criar campo personalizado de atendimentos e casos Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-custom-fields/criar-campo-personalizado-de-atendimentos-e-casos https://api.juridiq.com.br/api-docs/client/openapi.json post /consulting-custom-fields/ Cria definição de campo para atendimentos e casos, limitada ao escritório autenticado. # Listar campos personalizados de atendimentos e casos Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-custom-fields/listar-campos-personalizados-de-atendimentos-e-casos https://api.juridiq.com.br/api-docs/client/openapi.json get /consulting-custom-fields/ Lista definições ativas do escritório para preenchimento em atendimentos e casos. # Atualizar funil de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-funnels/atualizar-funil-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json patch /funnels/{id} # Buscar funil de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-funnels/buscar-funil-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json get /funnels/{id} # Criar funil de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-funnels/criar-funil-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json post /funnels/ # Excluir funil de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-funnels/excluir-funil-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json delete /funnels/{id} Não permite excluir o funil padrão nem funis com atendimentos # Listar funis de atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting-funnels/listar-funis-de-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json get /funnels/ # Atualizar atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/atualizar-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json patch /consulting/{id} # Atualizar registro do atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/atualizar-registro-do-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json patch /consulting/register/{id} # Buscar atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/buscar-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json get /consulting/{id} # Criar atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/criar-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json post /consulting/ # Criar registro no histórico do atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/criar-registro-no-histórico-do-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json post /consulting/register # Excluir atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/excluir-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json delete /consulting/ # Excluir registro do atendimento Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/excluir-registro-do-atendimento https://api.juridiq.com.br/api-docs/client/openapi.json delete /consulting/register # Listar atendimentos Source: https://juridiqsoftware.mintlify.app/api-reference/consulting/listar-atendimentos https://api.juridiq.com.br/api-docs/client/openapi.json get /consulting/ # Buscar resumo de créditos Source: https://juridiqsoftware.mintlify.app/api-reference/credits/buscar-resumo-de-créditos https://api.juridiq.com.br/api-docs/client/openapi.json get /credits/summary Retorna o resumo de créditos # Atualizar grau de risco Source: https://juridiqsoftware.mintlify.app/api-reference/degree-of-risk/atualizar-grau-de-risco https://api.juridiq.com.br/api-docs/client/openapi.json patch /degree-of-risk/{id} # Buscar grau de risco Source: https://juridiqsoftware.mintlify.app/api-reference/degree-of-risk/buscar-grau-de-risco https://api.juridiq.com.br/api-docs/client/openapi.json get /degree-of-risk/{id} # Criar grau de risco Source: https://juridiqsoftware.mintlify.app/api-reference/degree-of-risk/criar-grau-de-risco https://api.juridiq.com.br/api-docs/client/openapi.json post /degree-of-risk/ # Excluir graus de risco Source: https://juridiqsoftware.mintlify.app/api-reference/degree-of-risk/excluir-graus-de-risco https://api.juridiq.com.br/api-docs/client/openapi.json delete /degree-of-risk/ # Listar graus de risco Source: https://juridiqsoftware.mintlify.app/api-reference/degree-of-risk/listar-graus-de-risco https://api.juridiq.com.br/api-docs/client/openapi.json get /degree-of-risk/ # Campos de um modelo de peça jurídica Source: https://juridiqsoftware.mintlify.app/api-reference/documents/campos-de-um-modelo-de-peça-jurídica https://api.juridiq.com.br/api-docs/client/openapi.json get /docs/templates/{id} Devolve os campos `{{MÓDULO.coluna}}` do modelo, um por marcador, na ordem em que aparecem. Na criação da peça: - PERSON da pessoa 1 (`PERSON.name` ou `PERSON.name.1`) sai do cliente de `personId`, com os dados de GET /person/{id}; - LAW_SUIT sai do processo de `lawSuitId`, com os dados de GET /lawSuit/{id} (ex.: valor da causa em R$); - GENERAL.date e GENERAL.time saem de agora, no horário de Brasília; - o resto (PERSONALIZED, pessoa 2 em diante, GENERAL.cityState) só por `values`. Marcador partido entre trechos de formatação diferente e campo antigo do editor não aparecem na lista; o editor os mostra como campo ao abrir a peça. **Permissão:** qualquer usuário do escritório da chave. **Erros:** 404 quando o modelo não existe neste escritório. 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado. # Criar peça jurídica a partir de um modelo Source: https://juridiqsoftware.mintlify.app/api-reference/documents/criar-peça-jurídica-a-partir-de-um-modelo https://api.juridiq.com.br/api-docs/client/openapi.json post /docs/from-template Cria a peça em Meus Documentos com o modelo preenchido e devolve o `id`. A peça abre no editor como as criadas pelo Juridiq: leva o papel timbrado quando o escritório o aplica automaticamente e dispara as automações de peça criada. De onde sai cada valor (campos em GET /docs/templates/{id}): - `values` vence todos: a chave é o marcador sem chaves (`PERSONALIZED.valor`, `PERSON.name.2`) e `""` apaga o marcador. Chave que o modelo não tem é ignorada; - `{{PERSON.}}` e `{{PERSON..1}}`: o cliente de `personId`, com os dados de GET /person/{id}. Só `personId` preenche PERSON e põe a peça na pasta do cliente; `lawSuitId` sozinho não escolhe cliente; - `{{LAW_SUIT.}}`: o processo de `lawSuitId`, com os dados de GET /lawSuit/{id} (ex.: valor da causa em R$); - `{{GENERAL.date}}` e `{{GENERAL.time}}`: agora, no horário de Brasília. O que fica sem valor (inclusive campo vazio no cadastro) continua como marcador no texto e volta em `unresolved`, para completar no editor ou criar de novo com `values`. Marcador partido entre trechos de formatação diferente e campo antigo do editor não são trocados nem entram em `unresolved`. Com `personId` e `lawSuitId` juntos, o cliente tem de ser parte do processo. **Permissão:** qualquer usuário do escritório da chave; cliente e processo privados seguem a privacidade dele. **Erros:** 400 com campo fora do contrato ou quando o cliente não é parte do processo. 403 quando o cliente ou o processo é privado e o dono da chave não tem acesso; também 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado. 404 quando o modelo, o cliente ou o processo não existe neste escritório. 413 quando o corpo passa de 1 MB. # Listar modelos de peça jurídica Source: https://juridiqsoftware.mintlify.app/api-reference/documents/listar-modelos-de-peça-jurídica https://api.juridiq.com.br/api-docs/client/openapi.json get /docs/templates Lista os modelos de peça jurídica do escritório (o módulo de Peças Jurídicas), sem o conteúdo. Use o `id` em GET /docs/templates/{id} para ver os campos e em POST /docs/from-template para criar a peça. **Ordem e paginação:** por nome e, no empate, por `id`. `page` começa em 1 e `limit` vai até 100; use `totalPages` para saber quando parar. **Permissão:** qualquer usuário do escritório da chave. **Erros:** 403 quando a chave é do Claude e o plano do escritório não inclui o MCP, ou quando o acesso do escritório está bloqueado. # Atualizar evento Source: https://juridiqsoftware.mintlify.app/api-reference/events/atualizar-evento https://api.juridiq.com.br/api-docs/client/openapi.json patch /event/{id} Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham "Ver e editar", e só entra responsável que compartilha "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Buscar evento Source: https://juridiqsoftware.mintlify.app/api-reference/events/buscar-evento https://api.juridiq.com.br/api-docs/client/openapi.json get /event/{id} Evento sem processo nem pessoa da agenda de colega que não compartilha os detalhes responde 404 (a chave de API consulta como o dono dela). Gestor e Suporte veem tudo. # Criar evento Source: https://juridiqsoftware.mintlify.app/api-reference/events/criar-evento https://api.juridiq.com.br/api-docs/client/openapi.json post /event/ Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham "Ver e editar", e só entra responsável que compartilha "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Excluir eventos Source: https://juridiqsoftware.mintlify.app/api-reference/events/excluir-eventos https://api.juridiq.com.br/api-docs/client/openapi.json delete /event/ Pelo painel, a escrita segue o compartilhamento de agenda: responsável/participante, dono e Gestor/Suporte podem; os demais só quando todos os responsáveis compartilham "Ver e editar" (403 com o nome). Com chave de API a regra não vale. # Listar eventos Source: https://juridiqsoftware.mintlify.app/api-reference/events/listar-eventos https://api.juridiq.com.br/api-docs/client/openapi.json get /event/ Eventos, tarefas e audiências do período. Sem filtro de processo ou pessoa, vale o compartilhamento de agenda de quem consulta (a chave de API consulta como o dono dela): compromisso de colega que não compartilha não vem; o de quem compartilha só livre/ocupado vem como "Ocupado" (`busy: true`): o conteúdo vem vazio (sem pessoas, processo, link, descrição e modalidade) e o evento trazido do Google vem na cor padrão. Gestor e Suporte veem tudo. # Anexar arquivo a um cliente/pessoa com o conteúdo em JSON (base64) Source: https://juridiqsoftware.mintlify.app/api-reference/files/anexar-arquivo-a-um-clientepessoa-com-o-conteúdo-em-json-base64 https://api.juridiq.com.br/api-docs/client/openapi.json post /file/people/{id}/json # Anexar arquivo a um cliente/pessoa (multipart/form-data, campo file) Source: https://juridiqsoftware.mintlify.app/api-reference/files/anexar-arquivo-a-um-clientepessoa-multipartform-data-campo-file https://api.juridiq.com.br/api-docs/client/openapi.json post /file/people/{id} # Anexar arquivo a um processo com o conteúdo em JSON (base64) Source: https://juridiqsoftware.mintlify.app/api-reference/files/anexar-arquivo-a-um-processo-com-o-conteúdo-em-json-base64 https://api.juridiq.com.br/api-docs/client/openapi.json post /file/law-suits/{id}/json # Anexar arquivo a um processo (multipart/form-data, campo file) Source: https://juridiqsoftware.mintlify.app/api-reference/files/anexar-arquivo-a-um-processo-multipartform-data-campo-file https://api.juridiq.com.br/api-docs/client/openapi.json post /file/law-suits/{id} # Anexar arquivo a uma tarefa (multipart/form-data, campo file) Source: https://juridiqsoftware.mintlify.app/api-reference/files/anexar-arquivo-a-uma-tarefa-multipartform-data-campo-file https://api.juridiq.com.br/api-docs/client/openapi.json post /file/tasks/{id} # Listar arquivos de um cliente/pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/files/listar-arquivos-de-um-clientepessoa https://api.juridiq.com.br/api-docs/client/openapi.json get /file/people/{id} # Listar arquivos de um processo Source: https://juridiqsoftware.mintlify.app/api-reference/files/listar-arquivos-de-um-processo https://api.juridiq.com.br/api-docs/client/openapi.json get /file/law-suits/{id} # Listar arquivos de uma tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/files/listar-arquivos-de-uma-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json get /file/tasks/{id} # Aging de receber e pagar Source: https://juridiqsoftware.mintlify.app/api-reference/financial/aging-de-receber-e-pagar https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/aging # Apagar centro de custo Source: https://juridiqsoftware.mintlify.app/api-reference/financial/apagar-centro-de-custo https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/cost-centers/{id} # Apagar conta bancária vazia Source: https://juridiqsoftware.mintlify.app/api-reference/financial/apagar-conta-bancária-vazia https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/bank-accounts/{id} # Apagar linha do DRE Source: https://juridiqsoftware.mintlify.app/api-reference/financial/apagar-linha-do-dre https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/dre-layout/lines/{id} # Aplicar o modelo de DRE nas categorias Source: https://juridiqsoftware.mintlify.app/api-reference/financial/aplicar-o-modelo-de-dre-nas-categorias https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/dre-template/apply # Atualizar categoria financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-categoria-financeira https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/categories/{id} Substitui nome, cor, ícone e tipo de uma categoria do escritório da credencial; os quatro campos são obrigatórios. Trocar nome ou tipo para um nome que já existe no escritório em tipo que se sobrepõe (both colide com qualquer tipo) responde 409; categoria de outro escritório responde 404. Mudar o tipo não altera os lançamentos já feitos. # Atualizar centro de custo Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-centro-de-custo https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/cost-centers/{id} # Atualizar conta bancária Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-conta-bancária https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/bank-accounts/{id} # Atualizar conta financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-conta-financeira https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/bills/{id} # Atualizar pagamento parcial de uma transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-pagamento-parcial-de-uma-transação https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/transactions/{id}/payments/{paymentId} Altera valor, data, forma ou observação de um pagamento do lançamento. A soma dos pagamentos não pode passar do valor do lançamento (400); o lançamento volta a pago ou pendente pela nova soma. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Atualizar parceiro financeiro Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-parceiro-financeiro https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/partners/{id} # Atualizar status de pagamento do lançamento Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-status-de-pagamento-do-lançamento https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/launchs/{id} Marca o lançamento como pago (`isPaid: true`, na `paymentDate` enviada ou, sem ela, agora) ou como pendente. `partialValue` grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais, e é ignorado quando o lançamento já tem pagamentos registrados; num lançamento sem pagamentos registrados, omitir `partialValue` zera a baixa parcial. Para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Num lançamento recorrente, `updateType` `future` ou `all` ignora `partialValue` e grava a `paymentDate` enviada só nas parcelas já pagas do escopo; com `isPaid: true` grava em todas, e com `isPaid: false` apaga a data de todas. Quando o pedido marca como paga a parcela do `id` que estava pendente, grava a data de agora. Fora disso, a data de pagamento de cada parcela não muda. Parcela paga sem data conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Atualizar transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/atualizar-transação https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/transactions/{id} Altera o lançamento e, com `updateType` `future` ou `all`, as demais parcelas de um lançamento recorrente; `date` e `interestValue` mudam só na parcela do `id`. Num lançamento recorrente com `future` ou `all`, enviar qualquer campo além da baixa (`isPaid`, `paymentDate`, `partialValue`), do rateio (`allocations`, que não vale para série), de `isRetroactive` e dos que valem só para a parcela do `id` (`date`, `interestValue`) exige abertos os meses de competência de todas as parcelas do escopo; senão, 409. `date` (vencimento) e `paymentDate` em YYYY-MM-DD (com hora, o dia e o mês contam em UTC); vazias contam como não enviadas. Marcar como pago (`isPaid: true`) usa a `paymentDate` enviada ou, sem ela, a data de agora. `partialValue` grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais, e é ignorado quando o lançamento já tem pagamentos registrados; num lançamento sem pagamentos registrados, omitir `partialValue` zera a baixa parcial. Para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Num lançamento recorrente, `updateType` `future` ou `all` ignora `partialValue` e grava a `paymentDate` enviada só nas parcelas já pagas do escopo; com `isPaid: true` grava em todas, e com `isPaid: false` apaga a data de todas. Quando o pedido marca como paga a parcela do `id` que estava pendente, grava a data de agora. Fora disso, a data de pagamento de cada parcela não muda. Parcela paga sem data conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Cancelar contrato de honorários Source: https://juridiqsoftware.mintlify.app/api-reference/financial/cancelar-contrato-de-honorários https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/fee-agreements/{id}/cancel # Confirmar conciliação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/confirmar-conciliação https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/bank-accounts/{id}/statements/{lineId}/confirm # Confirmar dedução de impostos Source: https://juridiqsoftware.mintlify.app/api-reference/financial/confirmar-dedução-de-impostos https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/invoices/{invoiceId}/tax-deduction # Criar categoria financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-categoria-financeira https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/categories Cria uma categoria financeira no escritório da credencial; o escritório vem do token ou da chave de API, nunca do corpo. type both deixa a categoria disponível em receitas e despesas. Nome igual a outro do mesmo escritório responde 409 quando os tipos se sobrepõem: incoming e outcoming podem repetir nome entre si, mas both colide com qualquer tipo. # Criar centro de custo Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-centro-de-custo https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/cost-centers # Criar conta bancária Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-conta-bancária https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/bank-accounts # Criar conta financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-conta-financeira https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/bills # Criar contrato de honorários Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-contrato-de-honorários https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/fee-agreements # Criar linha do DRE Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-linha-do-dre https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/dre-layout/lines # Criar parceiro financeiro Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-parceiro-financeiro https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/partners # Criar transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/criar-transação https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/transactions Cria o lançamento e, com `repetitionType`, as parcelas ou repetições. `date` é o vencimento e `paymentDate` a data do pagamento, as duas em YYYY-MM-DD (com hora, o dia e o mês contam em UTC). Lançamento criado pago (`isPaid: true`) fica com a `paymentDate` enviada ou, sem ela, a data de agora; com parcelas ou repetição, a 1ª parcela paga recebe sempre a data de agora e a `paymentDate` é ignorada. Lançamento pago conta no mês da data de pagamento. `partialValue`, só na 1ª parcela, grava uma baixa parcial sem data, que conta pelo vencimento e, com `periodByDate=paymentDate`, fica fora do período e dos totais; para registrar um pagamento com data, use `POST /financial/transactions/{id}/payments`. Com `categorySplits`, o valor é dividido entre categorias (ex.: honorários + repasse ao cliente): cria um lançamento por parte, ligados pelo mesmo `splitGroupId`, e responde com a primeira parte e o `splitGroupId` (as demais saem em `GET /financial/transactions`). `excludeFromDre: true` mantém a categoria nos relatórios, mas tira o valor do DRE. Conta, categoria, pessoa ou processo inexistente responde 404. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # CSV do contador Source: https://juridiqsoftware.mintlify.app/api-reference/financial/csv-do-contador https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/reports/accountant-export # Demonstrativo do fluxo de caixa (DFC) Source: https://juridiqsoftware.mintlify.app/api-reference/financial/demonstrativo-do-fluxo-de-caixa-dfc https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/reports/cash-flow/statement DFC pelo método direto, mês a mês, no período from–to (até 36 meses). Regime de caixa: o pago conta na data da baixa e a baixa parcial na data de cada pagamento, a mesma regra do saldo das contas. Traz o saldo inicial, os grupos (`sections`: operacional, investimento, financiamento, ajustes e, com `billId`, transferências entre contas), cada um com entradas (`inflows`) e saídas (`outflows`, valores negativos) por categoria, a variação do caixa e o saldo final de cada mês (`periods`, `openingBalances`, `closingBalances`). Movimentação patrimonial entra pela espécie: investimento, financiamento e sócios, ajuste. Inclui repasse a terceiros e o que está fora do DRE. Com `forecast=true`, cada linha traz também o previsto (`forecast`) e o bloco `forecast` traz o saldo projetado. O previsto vai de hoje até o fim do período, pelo vencimento: lançamento em aberto já vencido não entra. # Desfazer conciliação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/desfazer-conciliação https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/bank-accounts/{id}/statements/{lineId}/unreconcile # Dividir lançamento existente por categoria Source: https://juridiqsoftware.mintlify.app/api-reference/financial/dividir-lançamento-existente-por-categoria https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/transactions/{id}/split Divide entre categorias um lançamento que já existe (ex.: alvará lançado inteiro como honorários vira honorários + repasse ao cliente). O lançamento original vira a primeira parte e mantém conciliação com o extrato, anexos e nota fiscal; as demais partes são criadas com a mesma data, competência, conta, pessoa, processo e situação de pagamento, todas com o mesmo `splitGroupId`. As partes precisam somar o valor do lançamento. Só vale em lançamento único (sem parcelas nem repetição), sem pagamento parcial, rateio, comissão de parceiro ou contrato de honorários, e que ainda não esteja dividido; fora disso responde 422. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # DRE do mês Source: https://juridiqsoftware.mintlify.app/api-reference/financial/dre-do-mês https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/reports/dre Resultado do mês pela competência, nas linhas do DRE do escritório. Exige year e month. Dinheiro de cliente (repasses, custas, depósitos), movimentação patrimonial e transferências ficam fora do DRE e aparecem só no fluxo de caixa (GET /financial/reports/cash-flow). # Editar linha do DRE Source: https://juridiqsoftware.mintlify.app/api-reference/financial/editar-linha-do-dre https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/dre-layout/lines/{id} # Escolher a linha do DRE de uma categoria Source: https://juridiqsoftware.mintlify.app/api-reference/financial/escolher-a-linha-do-dre-de-uma-categoria https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/dre-layout/categories/{categoryId} # Excluir categoria financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/excluir-categoria-financeira https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/categories/{id} Exclui uma categoria do escritório da credencial sem lançamentos nem subcategorias. Categoria com lançamentos, pagamentos registrados ou subcategorias responde 409. Categoria de outro escritório responde 404. # Excluir conta financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/excluir-conta-financeira https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/bills/{id} # Excluir pagamento parcial de uma transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/excluir-pagamento-parcial-de-uma-transação https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/transactions/{id}/payments/{paymentId} Exclui um pagamento do lançamento; o lançamento volta a pago ou pendente pela soma que resta. Exige permissão de excluir do financeiro com JWT; aceita o header `x-juridiq-api-key`. # Excluir parceiro financeiro Source: https://juridiqsoftware.mintlify.app/api-reference/financial/excluir-parceiro-financeiro https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/partners/{id} # Excluir transações Source: https://juridiqsoftware.mintlify.app/api-reference/financial/excluir-transações https://api.juridiq.com.br/api-docs/client/openapi.json delete /financial/transactions # Extrato da carteira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/extrato-da-carteira https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/bills/{id}/statement # Faturar horas Source: https://juridiqsoftware.mintlify.app/api-reference/financial/faturar-horas https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/fee-agreements/{id}/bill-timesheets # Fechar mês de competência Source: https://juridiqsoftware.mintlify.app/api-reference/financial/fechar-mês-de-competência https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/periods/{year}/{month}/close # Fluxo de caixa Source: https://juridiqsoftware.mintlify.app/api-reference/financial/fluxo-de-caixa https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/reports/cash-flow Caixa realizado (pela data de pagamento) e previsto (vencimentos em aberto) por carteira, no período from–to. Inclui tudo o que passa pelo banco, inclusive dinheiro de cliente e movimentação patrimonial. # Importar lançamentos Source: https://juridiqsoftware.mintlify.app/api-reference/financial/importar-lançamentos https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/transactions/import Grava as linhas escolhidas na prévia. Cada linha pode ter categoria, pessoa (`personId`), processo (`lawSuitId`), parceiro (`partnerId`, só o vínculo, sem comissão) e `excludeFromDre`. Com `parts`, a linha vira um lançamento por parte, cada uma com sua categoria e seus vínculos, ligados pelo mesmo `splitGroupId`; as partes somam o valor da linha. Com `reconcileWith` (o `match.transactionId` da prévia), a linha concilia o lançamento existente e dá baixa nele na data do extrato, em vez de criar outro. Um lançamento já dividido por categoria concilia inteiro com uma linha que tem a soma das partes, com o id do grupo ou de uma parte. Linhas já importadas são puladas, a não ser com `importAgain: true`; linhas em mês fechado são sempre puladas. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Importar OFX Source: https://juridiqsoftware.mintlify.app/api-reference/financial/importar-ofx https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/bank-accounts/{id}/statements # Lançamentos de uma linha do fluxo de caixa Source: https://juridiqsoftware.mintlify.app/api-reference/financial/lançamentos-de-uma-linha-do-fluxo-de-caixa https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/reports/cash-flow/statement/entries Os lançamentos que formam uma linha ou uma célula do demonstrativo do fluxo de caixa: envie o mesmo período, `section` e `lineKey` da linha. Até 500, do mais antigo ao mais recente; `total` diz quantos são e `realizedTotal`/`forecastTotal` somam todos, mesmo quando a lista vem cortada. O saldo inicial de conta aberta no período vem com `transactionId` nulo, porque não é um lançamento. # Linhas do DRE e onde cada categoria entra Source: https://juridiqsoftware.mintlify.app/api-reference/financial/linhas-do-dre-e-onde-cada-categoria-entra https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/dre-layout # Listar categorias financeiras Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-categorias-financeiras https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/categories Lista as categorias financeiras do escritório da credencial, da mais recente para a mais antiga. Sem limit, devolve todas. O filtro type=incoming ou outcoming inclui as categorias compartilhadas (both). # Listar centros de custo Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-centros-de-custo https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/cost-centers # Listar contas bancárias Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-contas-bancárias https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/bank-accounts # Listar contas financeiras Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-contas-financeiras https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/bills # Listar contratos de honorários Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-contratos-de-honorários https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/fee-agreements # Listar extrato da conta Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-extrato-da-conta https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/bank-accounts/{id}/statements # Listar fechamentos de competência Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-fechamentos-de-competência https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/periods # Listar pagamentos parciais de uma transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-pagamentos-parciais-de-uma-transação https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/{id}/payments Lista os pagamentos registrados do lançamento, do mais recente ao mais antigo, com o total pago e o restante. Lançamento com baixa parcial antiga, sem pagamentos registrados: `paidValue` e `remainingValue` contam a baixa parcial antiga, que só aparece em `data` depois do primeiro pagamento registrado. Aceita JWT ou o header `x-juridiq-api-key`. # Listar parceiros financeiros Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-parceiros-financeiros https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/partners # Listar parcelas de transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-parcelas-de-transação https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/{id}/installments # Listar pessoas vinculadas ao parceiro financeiro Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-pessoas-vinculadas-ao-parceiro-financeiro https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/partners/{id}/people # Listar transações Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-transações https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions Lista os lançamentos do escritório com paginação, totais e dados do gráfico. O período (`month`/`year`, `periodType` ou `start`/`end`) vale para a data de `periodByDate`: `date` = vencimento, `paymentDate` = data de pagamento. Sem `periodByDate` nem `dateFilterType`, lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento; o `paymentDate` de lançamento pago sem data registrada vem com o vencimento. Fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado: o lançamento aparece no período do pagamento e os totais somam só os pagamentos com data no período (com `status=pending`, `isPaid=false` ou `isDefaulters`, tudo pelo vencimento); o `partialValue` de cada lançamento é o total já pago. Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe só os lançamentos que criou e as demais parcelas deles, com totais zerados. Aceita JWT ou o header `x-juridiq-api-key`. # Listar transações agrupadas por categoria Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-transações-agrupadas-por-categoria https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/by-tags Agrupa por categoria os lançamentos do escritório, com os filtros e a regra de período de `GET /financial/transactions`: sem `periodByDate` nem `dateFilterType`, lançamento pago entra pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento; fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com `status=pending`, `isPaid=false` ou `isDefaulters`, pelo vencimento). Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe só os lançamentos que criou e as demais parcelas deles, com valores zerados. Aceita JWT ou o header `x-juridiq-api-key`. # Listar transações futuras Source: https://juridiqsoftware.mintlify.app/api-reference/financial/listar-transações-futuras https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/future Lista os lançamentos não pagos com vencimento de amanhã até 30 dias depois (fuso America/Sao_Paulo), do vencimento mais distante ao mais próximo, sem paginação. Contas privadas só aparecem para Gestor, Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe só os lançamentos que criou e as demais parcelas deles. `externalId` é o ID da cobrança no Asaas (null em lançamento manual) e `gateway` traz os dados dela. Aceita JWT ou o header `x-juridiq-api-key`. # Modelo de DRE para escritório de advocacia Source: https://juridiqsoftware.mintlify.app/api-reference/financial/modelo-de-dre-para-escritório-de-advocacia https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/dre-template # Obter categoria financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-categoria-financeira https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/categories/{id} Devolve uma categoria financeira do escritório da credencial. Categoria de outro escritório responde 404. # Obter conta financeira Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-conta-financeira https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/bills/{id} # Obter parceiro financeiro Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-parceiro-financeiro https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/partners/{id} # Obter saldo mensal Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-saldo-mensal https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/balance Totais de receitas e despesas do escritório e do mês corrente (fuso America/Sao_Paulo). No mês, lançamento pago conta pela data de pagamento (sem data registrada, pelo vencimento) e pendente pelo vencimento, somando só a baixa parcial; a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado. Contas privadas só aparecem para Suporte ou responsáveis da conta; perfil sem permissão de ver o saldo recebe zeros. Aceita JWT ou o header `x-juridiq-api-key`. # Obter transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-transação https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/{id} # Obter transação externa Source: https://juridiqsoftware.mintlify.app/api-reference/financial/obter-transação-externa https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/external/{externalId} # Prévia da importação de lançamentos (OFX ou CSV) Source: https://juridiqsoftware.mintlify.app/api-reference/financial/prévia-da-importação-de-lançamentos-ofx-ou-csv https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/transactions/import/preview Lê o extrato e devolve o que vai virar lançamento, sem gravar nada. No OFX, traz banco, período e saldo (`statement`) e, em cada linha, o tipo da operação, o documento e quem pagou ou recebeu. Cada linha vem com `status` (nova, já importada ou em mês fechado), `match` (lançamento já existente com o mesmo valor, que pode ser conciliado em vez de criar um novo, inclusive quando um único crédito paga mais de um lançamento) e `suggestion` (categoria e pessoa sugeridas pelo histórico do escritório e pelo nome no extrato). Perfil sem permissão de ver o saldo só recebe `match` de lançamentos que criou. CSV sem `mapping` recebe a sugestão de colunas pelo cabeçalho. Depois, envie as linhas escolhidas para `POST /financial/transactions/import`. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Reabrir mês de competência Source: https://juridiqsoftware.mintlify.app/api-reference/financial/reabrir-mês-de-competência https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/periods/{year}/{month}/reopen # Reconhecer honorário de êxito Source: https://juridiqsoftware.mintlify.app/api-reference/financial/reconhecer-honorário-de-êxito https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/fee-agreements/{id}/recognize-success # Redistribuir parcelas de transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/redistribuir-parcelas-de-transação https://api.juridiq.com.br/api-docs/client/openapi.json patch /financial/transactions/{id}/redistribute # Registrar pagamento parcial de uma transação Source: https://juridiqsoftware.mintlify.app/api-reference/financial/registrar-pagamento-parcial-de-uma-transação https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/transactions/{id}/payments Registra um pagamento (valor, data e forma) do lançamento. A soma dos pagamentos não pode passar do valor do lançamento (400). Se o lançamento tem baixa parcial antiga, sem pagamentos registrados, ela vira antes um pagamento com forma `OTHER`, na data de vencimento ou na do novo pagamento, a que for anterior. Quando a soma alcança o valor, o lançamento fica pago na data do pagamento mais recente. Nos períodos por data efetiva e por data de pagamento, cada pagamento de lançamento pendente conta no mês da própria data. Exige permissão de editar o financeiro com JWT; aceita o header `x-juridiq-api-key`. # Relatório mensal de transações por conta Source: https://juridiqsoftware.mintlify.app/api-reference/financial/relatório-mensal-de-transações-por-conta https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/transactions/by-tags/monthly-report Receitas, despesas e saldo por mês, de `start` a `end` (`YYYY-MM` ou data, até 24 meses), agrupados por conta. Cada lançamento entra no mês da data de `periodByDate`; sem `periodByDate` nem `dateFilterType`, lançamento pago entra no mês da data de pagamento (sem data registrada, no do vencimento) e pendente no do vencimento; pendente soma só a baixa parcial. Fora de `periodByDate=date`, a baixa parcial de lançamento pendente conta pela data de cada pagamento registrado (com `status=pending`, `isPaid=false` ou `isDefaulters`, pelo vencimento). Contas privadas só aparecem para Suporte ou responsáveis da conta. Exige permissão de ver o saldo financeiro (403). Aceita JWT ou o header `x-juridiq-api-key`. # Reordenar linhas do DRE Source: https://juridiqsoftware.mintlify.app/api-reference/financial/reordenar-linhas-do-dre https://api.juridiq.com.br/api-docs/client/openapi.json put /financial/dre-layout/order # Restaurar as linhas padrão do DRE Source: https://juridiqsoftware.mintlify.app/api-reference/financial/restaurar-as-linhas-padrão-do-dre https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/dre-layout/restore # Sugerir impostos da nota Source: https://juridiqsoftware.mintlify.app/api-reference/financial/sugerir-impostos-da-nota https://api.juridiq.com.br/api-docs/client/openapi.json get /financial/invoices/{invoiceId}/tax-suggestion # Listar integrações do escritório Source: https://juridiqsoftware.mintlify.app/api-reference/integrations/listar-integrações-do-escritório https://api.juridiq.com.br/api-docs/client/openapi.json get /integration/ Retorna o status das integrações vinculadas ao escritório. # Introdução Source: https://juridiqsoftware.mintlify.app/api-reference/intro Referência completa dos endpoints da API do Juridiq. # API Reference A API do Juridiq é organizada em endpoints REST e utiliza JSON para requisições e respostas. Nesta seção você encontrará todos os endpoints disponíveis da plataforma, incluindo exemplos de requisição, parâmetros, respostas e possíveis erros. > [!NOTE] > > Todos os endpoints autenticados exigem o header `x-juridiq-api-key`. ## Base URL ```bash theme={null} https://api.juridiq.com.br ``` ## Como utilizar a referência **1. Escolha um endpoint** Navegue pelas categorias disponíveis na barra lateral. **2. Analise os parâmetros** Veja quais campos são obrigatórios e opcionais. **3. Teste a requisição** Utilize os exemplos disponíveis em diferentes linguagens. **4. Interprete a resposta** Consulte exemplos de retorno e possíveis erros. ## Alguns recursos disponíveis > [card] Usuários > > Gerenciamento de usuários e autenticação. > [card] Contatos > > Cadastro e gerenciamento de contatos. > [card] Conversas > > Operações relacionadas a mensagens e atendimentos. > [card] Webhooks > > Configuração e gerenciamento de eventos. > [card] Automação > > Fluxos automatizados e integrações. > [card] IA Jurídica > > Recursos inteligentes da plataforma. ## Autenticação Exemplo de envio da API Key: ```http theme={null} x-juridiq-api-key: SUA_API_KEY ``` > [!WARNING] > > Nunca exponha sua API Key no frontend ou em aplicações públicas. # Arquivar campo personalizado de processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suit-custom-fields/arquivar-campo-personalizado-de-processos https://api.juridiq.com.br/api-docs/client/openapi.json delete /law-suit-custom-fields/{id} Arquiva o campo: ele deixa de ser oferecido em novos processos, e os valores já gravados são preservados. Responde 204 sem corpo. # Atualizar campo personalizado de processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suit-custom-fields/atualizar-campo-personalizado-de-processos https://api.juridiq.com.br/api-docs/client/openapi.json patch /law-suit-custom-fields/{id} Altera o nome e/ou as opções de um campo personalizado de processos. O tipo não muda depois de criado. Informe ao menos um dos dois campos. # Criar campo personalizado de processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suit-custom-fields/criar-campo-personalizado-de-processos https://api.juridiq.com.br/api-docs/client/openapi.json post /law-suit-custom-fields/ Cria uma definição de campo personalizado de processos. Os tipos `select` e `multiSelect` exigem `options`; os demais recusam `options`. O limite é de 100 campos ativos por escritório. # Listar campos personalizados de processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suit-custom-fields/listar-campos-personalizados-de-processos https://api.juridiq.com.br/api-docs/client/openapi.json get /law-suit-custom-fields/ Lista as definições de campos personalizados de processos do escritório, incluindo as arquivadas. O `id` devolvido aqui é o `fieldId` usado em `customFields` ao criar ou atualizar um processo. # Adicionar andamento manual Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/adicionar-andamento-manual https://api.juridiq.com.br/api-docs/client/openapi.json post /lawSuit/movements Adiciona um andamento escrito manualmente ao processo. O andamento entra no topo da lista com `tipo: ANDAMENTO` e `origin: manual`, e nasce privado — só aparece para o cliente final no Jurichat se `sharedWithJurichat` for `true`. # Ativar monitoramento de processo Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/ativar-monitoramento-de-processo https://api.juridiq.com.br/api-docs/client/openapi.json post /lawSuit/v2/monitoring/{id} Ativa o monitoramento de andamentos no tribunal. Envie `{ "instances": [1] }` para cadastrar só o 1º grau. Sem o campo, cadastra os três. Processos em segredo de justiça exigem credentialId. Processo administrativo INSS também é aceito: ativa o monitoramento INSS (1 crédito) e ignora `instances`. # Ativar monitoramento de uma instância Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/ativar-monitoramento-de-uma-instância https://api.juridiq.com.br/api-docs/client/openapi.json post /lawSuit/v2/monitoring/{id}/instance/{instanceNumber} Ativa o monitoramento apenas do grau informado (1, 2 ou 3). Não altera as demais instâncias. # Atualizar processo Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/atualizar-processo https://api.juridiq.com.br/api-docs/client/openapi.json patch /lawSuit/{id} # Buscar processo Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/buscar-processo https://api.juridiq.com.br/api-docs/client/openapi.json get /lawSuit/{id} # Criar processo Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/criar-processo https://api.juridiq.com.br/api-docs/client/openapi.json post /lawSuit/ Cria um processo do escritório. Com consultingColumnId, também cria o atendimento no CRM nessa coluna, ligado ao processo e à primeira parte Cliente; o atendimento nasce privado se o processo ou o cliente for privado e vira o atendimento atual do cliente só quando ele não tem um. Com consultingId, liga o atendimento existente ao processo (e o move para consultingColumnId, se vier). O id do atendimento vem em consultingId na resposta. # Desativar monitoramento em lote Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/desativar-monitoramento-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json delete /lawSuit/v2/monitoring/batch Remove o monitoramento de andamentos para uma lista de processos. # Excluir processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/excluir-processos https://api.juridiq.com.br/api-docs/client/openapi.json delete /lawSuit/ # Listar falhas de monitoramento Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/listar-falhas-de-monitoramento https://api.juridiq.com.br/api-docs/client/openapi.json get /lawSuit/v2/monitoring/issues Lista falhas na captura de andamentos do monitoramento. # Listar fila de monitoramento Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/listar-fila-de-monitoramento https://api.juridiq.com.br/api-docs/client/openapi.json get /lawSuit/v2/monitoring/queue Lista processos na fila de validação do monitoramento. # Listar movimentações Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/listar-movimentações https://api.juridiq.com.br/api-docs/client/openapi.json get /lawSuit/movements/{lawSuitId} # Listar processos Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/listar-processos https://api.juridiq.com.br/api-docs/client/openapi.json get /lawSuit/ # Remover monitoramento de uma instância Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/remover-monitoramento-de-uma-instância https://api.juridiq.com.br/api-docs/client/openapi.json delete /lawSuit/v2/monitoring/{id}/instance/{instanceNumber} Remove o monitoramento apenas do grau informado (1, 2 ou 3). As demais instâncias permanecem ativas. # Remover monitoramento do processo Source: https://juridiqsoftware.mintlify.app/api-reference/law-suits/remover-monitoramento-do-processo https://api.juridiq.com.br/api-docs/client/openapi.json delete /lawSuit/v2/monitoring/{id} Remove o monitoramento de todas as instâncias do processo. Para remover um grau específico, use DELETE /lawSuit/v2/monitoring/{id}/instance/{instanceNumber}. Processo administrativo INSS também é aceito: remove o monitoramento INSS e devolve o crédito. # Métricas de parceiros financeiros Source: https://juridiqsoftware.mintlify.app/api-reference/metrics/métricas-de-parceiros-financeiros https://api.juridiq.com.br/api-docs/client/openapi.json get /metrics/partners # Andamentos novos não lidos Source: https://juridiqsoftware.mintlify.app/api-reference/movements/andamentos-novos-não-lidos https://api.juridiq.com.br/api-docs/client/openapi.json get /movements/count Quantos andamentos novos do escritório ainda não foram lidos. Aceita JWT ou o header `x-juridiq-api-key`; o usuário da chave precisa ver processos (403 sem a permissão). # Listar andamentos processuais Source: https://juridiqsoftware.mintlify.app/api-reference/movements/listar-andamentos-processuais https://api.juridiq.com.br/api-docs/client/openapi.json get /movements/ Sem lawSuitId: os andamentos novos do escritório, pela ordem de entrada (todos veem; só quem trata marca como lido). Com lawSuitId: todos os andamentos do processo, pela data do andamento. Filtros e totais como os de publicações. Aceita JWT ou o header `x-juridiq-api-key`; o usuário da chave precisa ver processos (403 sem a permissão). # Descartar notificações Source: https://juridiqsoftware.mintlify.app/api-reference/notifications/descartar-notificações https://api.juridiq.com.br/api-docs/client/openapi.json delete /notifications/ Apaga notificações do usuário dono da chave, sem volta. Exige ids, groupKey ou groups (400 sem nenhum deles). # Listar notificações Source: https://juridiqsoftware.mintlify.app/api-reference/notifications/listar-notificações https://api.juridiq.com.br/api-docs/client/openapi.json get /notifications/list Lista as notificações do usuário dono da chave (cada usuário tem as suas). grouped=true traz uma por item pai; groupKey traz as de um item. Andamentos não vêm aqui: use `GET /movements`. Substitui `GET /alert/` e `GET /alert/tabs` (o contador por tipo está em unreadByLink). # Marcar notificações como lidas Source: https://juridiqsoftware.mintlify.app/api-reference/notifications/marcar-notificações-como-lidas https://api.juridiq.com.br/api-docs/client/openapi.json patch /notifications/read Marca como lidas as notificações do usuário dono da chave. Sem filtro no body, marca todas. # Arquivar campo personalizado de pessoas Source: https://juridiqsoftware.mintlify.app/api-reference/person-custom-fields/arquivar-campo-personalizado-de-pessoas https://api.juridiq.com.br/api-docs/client/openapi.json delete /person-custom-fields/{id} Arquiva o campo: ele deixa de ser oferecido em novas pessoas, e os valores já gravados são preservados. Responde 204 sem corpo. # Atualizar campo personalizado de pessoas Source: https://juridiqsoftware.mintlify.app/api-reference/person-custom-fields/atualizar-campo-personalizado-de-pessoas https://api.juridiq.com.br/api-docs/client/openapi.json patch /person-custom-fields/{id} Altera o nome e/ou as opções de um campo personalizado de pessoas. O tipo não muda depois de criado. Informe ao menos um dos dois campos. # Criar campo personalizado de pessoas Source: https://juridiqsoftware.mintlify.app/api-reference/person-custom-fields/criar-campo-personalizado-de-pessoas https://api.juridiq.com.br/api-docs/client/openapi.json post /person-custom-fields/ Cria uma definição de campo personalizado de pessoas. Os tipos `select` e `multiSelect` exigem `options`; os demais recusam `options`. O limite é de 100 campos ativos por escritório. # Listar campos personalizados de pessoas Source: https://juridiqsoftware.mintlify.app/api-reference/person-custom-fields/listar-campos-personalizados-de-pessoas https://api.juridiq.com.br/api-docs/client/openapi.json get /person-custom-fields/ Lista as definições de campos personalizados de pessoas do escritório, incluindo as arquivadas. O `id` devolvido aqui é o `fieldId` usado em `customFields` ao criar ou atualizar uma pessoa. # Criar tipo de pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/person-origins/criar-tipo-de-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json post /person-origin/ # Excluir tipo de pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/person-origins/excluir-tipo-de-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json delete /person-origin/{id} # Listar tipos de pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/person-origins/listar-tipos-de-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json get /person-origin/ # Renomear tipo de pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/person-origins/renomear-tipo-de-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json patch /person-origin/{id} # Atualizar pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/persons/atualizar-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json patch /person/{id} # Atualizar pessoas em lote Source: https://juridiqsoftware.mintlify.app/api-reference/persons/atualizar-pessoas-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json patch /person/batch-update # Buscar pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/persons/buscar-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json get /person/{id} # Buscar pessoa por telefone Source: https://juridiqsoftware.mintlify.app/api-reference/persons/buscar-pessoa-por-telefone https://api.juridiq.com.br/api-docs/client/openapi.json get /person/search # Criar pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/persons/criar-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json post /person/ # Excluir pessoa Source: https://juridiqsoftware.mintlify.app/api-reference/persons/excluir-pessoa https://api.juridiq.com.br/api-docs/client/openapi.json delete /person/{id} # Excluir pessoas em lote Source: https://juridiqsoftware.mintlify.app/api-reference/persons/excluir-pessoas-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json delete /person/ # Listar pessoas Source: https://juridiqsoftware.mintlify.app/api-reference/persons/listar-pessoas https://api.juridiq.com.br/api-docs/client/openapi.json get /person/ # Buscar publicação Source: https://juridiqsoftware.mintlify.app/api-reference/publications/buscar-publicação https://api.juridiq.com.br/api-docs/client/openapi.json get /publication/{id} Devolve o detalhe de uma movimentação de publicação do escritório autenticado. O parâmetro `id` é o ID da movimentação (`publication_movements`), o mesmo da listagem — não o ID da publicação. Em `lawSuit.persons`, os clientes do escritório vêm primeiro. `prevUnreadId`, `nextUnreadId`, `unreadPosition` e `unreadTotal` navegam pelas não lidas do usuário autenticado (o dono da chave de API) nas publicações monitoradas em que ele é responsável, sem as arquivadas, ordenadas pela data efetiva (a menor entre disponibilização e publicação, ou a data de captura quando não há nenhuma das duas) da mais recente para a mais antiga — a ordem padrão de GET /publication. Vêm null quando a movimentação está fora dessa navegação (já lida, sem título, de publicação arquivada ou de monitoramento em que o usuário não é responsável). Aceita JWT ou o header `x-juridiq-api-key`. # Descartar publicações Source: https://juridiqsoftware.mintlify.app/api-reference/publications/descartar-publicações https://api.juridiq.com.br/api-docs/client/openapi.json delete /publication/discard # Listar publicações Source: https://juridiqsoftware.mintlify.app/api-reference/publications/listar-publicações https://api.juridiq.com.br/api-docs/client/openapi.json get /publication/ Lista as movimentações de publicação do escritório autenticado, com paginação e totais. Aceita JWT ou o header `x-juridiq-api-key`. Filtros opcionais: texto/CNJ, tribunal ou diário, termo monitorado, tipos de ação, lida ou não, período de publicação e período de leitura (`readStart`/`readEnd` no fuso America/Sao_Paulo). # Marcar publicações como lidas Source: https://juridiqsoftware.mintlify.app/api-reference/publications/marcar-publicações-como-lidas https://api.juridiq.com.br/api-docs/client/openapi.json patch /publication/read-movements-many Marca como lidas as movimentações de publicação do escritório autenticado. `ids` são IDs de movimentação (os da listagem), não de publicação. Tudo ou nada: se algum id não existe no escritório, responde 404 e nenhuma é marcada; os ids não encontrados vêm no texto de `translateMessage`. Id repetido no corpo também responde 404, sem id listado. O leitor gravado é o usuário autenticado (o dono da chave de API) e a data de leitura é a do momento da chamada, inclusive nas já lidas. Aceita JWT ou o header `x-juridiq-api-key`. # Obter dados para criar processo a partir de uma movimentação de publicação Source: https://juridiqsoftware.mintlify.app/api-reference/publications/obter-dados-para-criar-processo-a-partir-de-uma-movimentação-de-publicação https://api.juridiq.com.br/api-docs/client/openapi.json get /publication/read-movement/{id}/law-suit-prefill Lê as colunas da movimentação (processo, tribunal, órgão, partes quando o content for estruturado) e resolve pessoas já cadastradas no escritório. Serve para pré-preencher a criação de processo sem consultar API externa. O parâmetro `id` é o ID da movimentação (`publication_movements`), o mesmo usado em PATCH /publication/read-movement/:id — não o ID da publicação. Vale para qualquer provider; o content Juridiq DJEN é mais completo que o da Solucionare. Location Solucionare (`estado - uf`) não é interpretada como tribunal/vara. Não cria nem altera registros. # Atualizar assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/atualizar-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json patch /signature/{id} # Atualizar lote de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/atualizar-lote-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json patch /signature/batch/{id} # Baixar PDF assinado Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/baixar-pdf-assinado https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/download/{documentKey} # Buscar assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/buscar-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/{id} # Buscar lote de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/buscar-lote-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/batch/{id} # Cancelar assinatura pendente Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/cancelar-assinatura-pendente https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/cancel/{id} # Cancelar lote de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/cancelar-lote-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/batch/cancel/{id} # Contagem de assinaturas por status Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/contagem-de-assinaturas-por-status https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/count # Criar lote de assinaturas Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/criar-lote-de-assinaturas https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/batch # Enviar documento para assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/enviar-documento-para-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/ # Enviar documento para assinatura com o PDF em JSON (base64) Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/enviar-documento-para-assinatura-com-o-pdf-em-json-base64 https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/json # Excluir assinatura finalizada ou cancelada Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/excluir-assinatura-finalizada-ou-cancelada https://api.juridiq.com.br/api-docs/client/openapi.json delete /signature/{id} # Excluir lote de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/excluir-lote-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json delete /signature/batch/{id} # Histórico de assinatura no PlugSign Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/histórico-de-assinatura-no-plugsign https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/history/{id} # Listar assinaturas individuais Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/listar-assinaturas-individuais https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/ # Listar lotes de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/listar-lotes-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json get /signature/batch # Reenviar lembrete de assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/reenviar-lembrete-de-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/reminder # Vincular pessoas a uma assinatura Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/vincular-pessoas-a-uma-assinatura https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/{id}/people # Vincular signatário a uma pessoa do CRM Source: https://juridiqsoftware.mintlify.app/api-reference/signatures/vincular-signatário-a-uma-pessoa-do-crm https://api.juridiq.com.br/api-docs/client/openapi.json post /signature/{id}/link-signatory # Consultar subconta Asaas Source: https://juridiqsoftware.mintlify.app/api-reference/subaccount/consultar-subconta-asaas https://api.juridiq.com.br/api-docs/client/openapi.json get /subaccount/ Retorna a subconta Asaas vinculada ao escritório. # Criar cliente na subconta Asaas Source: https://juridiqsoftware.mintlify.app/api-reference/subaccount/criar-cliente-na-subconta-asaas https://api.juridiq.com.br/api-docs/client/openapi.json post /subaccount/customer # Criar cobrança (boleto ou PIX) Source: https://juridiqsoftware.mintlify.app/api-reference/subaccount/criar-cobrança-boleto-ou-pix https://api.juridiq.com.br/api-docs/client/openapi.json post /subaccount/billing Conta, categoria, processo e cliente (internal.customer) precisam ser do escritório da credencial; vínculo de outro escritório responde 404 antes de qualquer chamada ao Asaas. Informe kind, gateway (dados da cobrança no Asaas) e internal (dados do lançamento). Gera o lançamento de receita no financeiro, vinculado à pessoa, ao processo, à conta e à categoria informados: um em PAYMENT, um por parcela em INSTALLMENT e o primeiro em SUBSCRIPTION. Vencimento em mês fechado é recusado antes de chamar o Asaas, exceto em INSTALLMENT. # Criar link de pagamento Source: https://juridiqsoftware.mintlify.app/api-reference/subaccount/criar-link-de-pagamento https://api.juridiq.com.br/api-docs/client/openapi.json post /subaccount/payment-link # Atualizar etiqueta Source: https://juridiqsoftware.mintlify.app/api-reference/tags/atualizar-etiqueta https://api.juridiq.com.br/api-docs/client/openapi.json patch /tag/{id} # Buscar etiqueta Source: https://juridiqsoftware.mintlify.app/api-reference/tags/buscar-etiqueta https://api.juridiq.com.br/api-docs/client/openapi.json get /tag/{id} # Criar etiqueta Source: https://juridiqsoftware.mintlify.app/api-reference/tags/criar-etiqueta https://api.juridiq.com.br/api-docs/client/openapi.json post /tag/ # Excluir etiquetas Source: https://juridiqsoftware.mintlify.app/api-reference/tags/excluir-etiquetas https://api.juridiq.com.br/api-docs/client/openapi.json delete /tag/ # Listar etiquetas Source: https://juridiqsoftware.mintlify.app/api-reference/tags/listar-etiquetas https://api.juridiq.com.br/api-docs/client/openapi.json get /tag/ # Criar coluna do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/criar-coluna-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json post /task-board/create-column Cria uma coluna em um quadro (board). `boardId` é o ID do quadro. Colunas formam uma cadeia via `nextColumnId`. Use isDoneColumn para coluna de conclusão. # Criar estrutura de um template de forma atômica Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/criar-estrutura-de-um-template-de-forma-atômica https://api.juridiq.com.br/api-docs/client/openapi.json post /task-board/templates/apply Cria pasta e quadros a partir de um template. Templates simples exigem folderId ou newFolderName. Templates avançados criam a pasta do catálogo, com o nome de newFolderName se vier, e recusam folderId. boards cria só os quadros escolhidos, com nome editado opcional. O criador entra sempre nos responsáveis. # Criar pasta do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/criar-pasta-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json post /task-board/create-folder Cria uma pasta (folder) de quadros de tarefas. A pasta agrupa quadros. Depois use POST /task-board/create-board com `folderBoardId` igual ao `id` devolvido aqui. # Criar quadro kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/criar-quadro-kanban https://api.juridiq.com.br/api-docs/client/openapi.json post /task-board/create-board Cria um quadro (board) dentro de uma pasta. O body usa `folderBoardId` (ID da pasta). O quadro nasce com as colunas Pendente, Em progresso e Concluída. Responsáveis do quadro precisam já ser responsáveis da pasta. # Editar coluna do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/editar-coluna-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-board/update-column/{id} Edita nome, cor, ordem (`nextColumnId`), arquivamento ou status de uma coluna do quadro. Obtenha o ID em GET /task-board/show-folder-board-column. # Editar pasta do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/editar-pasta-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-board/update-folder/{id} Edita nome, cor, responsáveis ou arquiva uma pasta (folder) de quadros. Não remove responsável que ainda for responsável de algum quadro desta pasta. # Editar quadro kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/editar-quadro-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-board/update-board/{id} Edita nome, cor, responsáveis, pasta (`folderId`) ou arquiva um quadro (board). Obtenha o ID em GET /task-board/list-folders ou GET /task-board/show-folder-board-column. # Excluir coluna do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/excluir-coluna-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json delete /task-board/delete-column/{id} Exclui uma coluna do quadro. Sem saveItems, apaga a coluna e as tarefas nela. Com saveItems=true e saveColumnId, move as tarefas para a coluna destino. # Excluir pasta do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/excluir-pasta-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json delete /task-board/delete-folder/{id} Exclui uma pasta (folder). Sem saveItems, apaga a pasta e os quadros (cascade nas tarefas). Com saveItems=true e saveFolderId, move os quadros para a pasta destino. # Excluir quadro kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/excluir-quadro-kanban https://api.juridiq.com.br/api-docs/client/openapi.json delete /task-board/delete-board/{id} Exclui um quadro (board). Sem saveItems, apaga o quadro e as tarefas. Com saveItems=true e saveBoardId, move as colunas para o quadro destino. # Exibir pastas, quadros e colunas arquivadas Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/exibir-pastas-quadros-e-colunas-arquivadas https://api.juridiq.com.br/api-docs/client/openapi.json get /task-board/show-archived-folder-board-column Árvore arquivada pasta → quadro → coluna do kanban. Use para achar IDs de itens arquivados antes de desarquivar via PATCH. # Exibir pastas, quadros e colunas ativas Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/exibir-pastas-quadros-e-colunas-ativas https://api.juridiq.com.br/api-docs/client/openapi.json get /task-board/show-folder-board-column Árvore ativa pasta → quadro → coluna do kanban. Use para descobrir IDs de pasta e quadro antes de editar. Não lista tarefas; para cards use POST /task-board/list-column-with-tasks-by-board ou GET /task. # Listar colunas com tarefas por quadro Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/listar-colunas-com-tarefas-por-quadro https://api.juridiq.com.br/api-docs/client/openapi.json post /task-board/list-column-with-tasks-by-board Retorna as colunas de um quadro kanban com as tarefas paginadas e filtros. Use para ver o conteúdo do quadro depois de criar ou editar pasta/quadro/coluna. Com filters.overdue true, só as tarefas atrasadas (prazo fatal vencido e fora da coluna de concluídas); com taskType subtask, as subtarefas das tarefas atrasadas, qualquer que seja o prazo da subtarefa. # Listar pastas e quadros do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/listar-pastas-e-quadros-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json get /task-board/list-folders Lista pastas (folders) do kanban de tarefas do escritório, com os quadros (boards) de cada pasta. Use o `id` da pasta em POST /task-board/create-board (`folderBoardId`) e o `id` do quadro em PATCH /task-board/update-board/:id. Inclui pastas arquivadas. # Listar templates curados de pastas e quadros Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/listar-templates-curados-de-pastas-e-quadros https://api.juridiq.com.br/api-docs/client/openapi.json get /task-board/templates Catálogo de templates de pasta e quadro. Use o `id` de cada template em POST /task-board/templates/apply. # Reordenar pastas do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/reordenar-pastas-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-board/reorder-folders Define a ordem das pastas (folders) ativas. `folderIds` deve listar as pastas na ordem desejada, sem duplicatas. # Reordenar quadros do kanban Source: https://juridiqsoftware.mintlify.app/api-reference/task-board/reordenar-quadros-do-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-board/reorder-boards Define a ordem dos quadros (boards) ativos de uma pasta. `boardIds` na ordem desejada, todos da mesma pasta. # Atualizar comentário de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/task-comments/atualizar-comentário-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json patch /comment/{id} # Criar comentário em tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/task-comments/criar-comentário-em-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json post /comment/ # Excluir comentário de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/task-comments/excluir-comentário-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json delete /comment/{id} # Listar comentários de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/task-comments/listar-comentários-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json get /comment/ # Arquivar campo personalizado de tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/task-custom-fields/arquivar-campo-personalizado-de-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json delete /task-custom-fields/{id} # Atualizar campo personalizado de tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/task-custom-fields/atualizar-campo-personalizado-de-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json patch /task-custom-fields/{id} # Criar campo personalizado de tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/task-custom-fields/criar-campo-personalizado-de-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json post /task-custom-fields/ # Listar campos personalizados de tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/task-custom-fields/listar-campos-personalizados-de-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json get /task-custom-fields/ # Arquivar ou desarquivar tarefas em lote Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/arquivar-ou-desarquivar-tarefas-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json patch /task/batch-update # Atualizar modelo de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/atualizar-modelo-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json patch /task/task-templates/{id} # Atualizar posição de tarefa no kanban Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/atualizar-posição-de-tarefa-no-kanban https://api.juridiq.com.br/api-docs/client/openapi.json patch /task/kanban/{id} # Atualizar subtarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/atualizar-subtarefa https://api.juridiq.com.br/api-docs/client/openapi.json patch /task/subtasks/{id} # Atualizar tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/atualizar-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json patch /task/{id} # Automações paradas esperando esta tarefa que podem ser liberadas nela Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/automações-paradas-esperando-esta-tarefa-que-podem-ser-liberadas-nela https://api.juridiq.com.br/api-docs/client/openapi.json get /task/{id}/workflow-releases # Buscar tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/buscar-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json get /task/{id} # Continuar a automação sem concluir a tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/continuar-a-automação-sem-concluir-a-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json post /task/{id}/workflow-releases/{instanceId} # Criar modelo de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/criar-modelo-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json post /task/task-templates # Criar subtarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/criar-subtarefa https://api.juridiq.com.br/api-docs/client/openapi.json post /task/subtasks # Criar tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/criar-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json post /task/ # Excluir modelo de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/excluir-modelo-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json delete /task/task-templates/{id} # Excluir subtarefas Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/excluir-subtarefas https://api.juridiq.com.br/api-docs/client/openapi.json delete /task/subtasks # Excluir tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/excluir-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json delete /task/ # Listar colunas do kanban de tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/listar-colunas-do-kanban-de-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json get /tasks-columns/ Retorna colunas do kanban atual (`task_kanban_columns`) para obter `columnId` em `POST /task`. Prefira `isSettings=true` para metadados (id, nome, quadro, pasta) sem carregar tarefas. Escritórios antigos sem kanban caem no legado `tasks_columns`. # Listar histórico da tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/listar-histórico-da-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json get /history/{id} Retorna o histórico vinculado ao ID informado. Para tasks, passe o ID da tarefa (`GET /history/{taskId}`). Também funciona para outros módulos que gravam histórico no mesmo endpoint. # Listar modelos de tarefa Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/listar-modelos-de-tarefa https://api.juridiq.com.br/api-docs/client/openapi.json get /task/task-templates # Listar tarefas Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/listar-tarefas https://api.juridiq.com.br/api-docs/client/openapi.json get /task/ # Listar tarefas no kanban Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/listar-tarefas-no-kanban https://api.juridiq.com.br/api-docs/client/openapi.json get /task/kanban # Registrar abertura da tarefa no histórico Source: https://juridiqsoftware.mintlify.app/api-reference/tasks/registrar-abertura-da-tarefa-no-histórico https://api.juridiq.com.br/api-docs/client/openapi.json post /task/{id}/view # Atualizar apontamento Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/atualizar-apontamento https://api.juridiq.com.br/api-docs/client/openapi.json patch /time-sheet/{id} Só o dono do apontamento ou o Gestor altera. status aplica a transição do cronômetro; personId, lawSuitId e consultingId só valem em GENERAL. Vínculos são checados entre si: atendimento de outra pessoa ou de outro processo e pessoa que não é parte do processo dão 400; atendimento privado de outro dono dá 404 para quem não vê atendimentos privados. hourlyRate vale em qualquer módulo e null remove o valor. Na resposta, costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate. # Buscar apontamento Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/buscar-apontamento https://api.juridiq.com.br/api-docs/client/openapi.json get /time-sheet/{id} Busca um apontamento do escritório pelo id. costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate. # Cancelar apontamentos em lote Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/cancelar-apontamentos-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json patch /time-sheet/cancel # Criar apontamento de um item existente Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/criar-apontamento-de-um-item-existente https://api.juridiq.com.br/api-docs/client/openapi.json post /time-sheet/ GENERAL exige título e aceita pessoa, processo, atendimento e hourlyRate (valor da hora em reais). Vínculos são checados entre si: atendimento de outra pessoa ou de outro processo e pessoa que não é parte do processo dão 400; atendimento privado de outro dono dá 404 para quem não vê atendimentos privados. TASK, SUBTASK e AUDIENCE exigem o id do item e sincronizam os apontamentos dele, sem vínculos nem hourlyRate. A resposta lista os apontamentos do item; costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate. # Excluir apontamento Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/excluir-apontamento https://api.juridiq.com.br/api-docs/client/openapi.json delete /time-sheet/{id} # Excluir apontamentos em lote Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/excluir-apontamentos-em-lote https://api.juridiq.com.br/api-docs/client/openapi.json delete /time-sheet/ # Gerar relatório de apontamentos (Excel/PDF) Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/gerar-relatório-de-apontamentos-excelpdf https://api.juridiq.com.br/api-docs/client/openapi.json get /time-sheet/report Gera Excel ou PDF com até 5000 apontamentos, com a regra de visibilidade da listagem e os filtros desta rota. orderByField aceita createdAt, updatedAt, completedAt ou title (padrão createdAt, orderBy desc); outro valor dá 400. personId e lawSuitId incluem os apontamentos que chegam por tarefa, subtarefa, audiência e atendimento. As colunas Valor da hora e Custo saem em reais; sem hourlyRate saem como —. startDate e endDate filtram pela data de criação do apontamento, no dia de São Paulo; início depois do fim dá 400. Com linhas, os Totais (aba no Excel, bloco no PDF) somam o tempo e o custo das linhas do arquivo por responsável, deixando de fora os de status atual CANCELLED, e avisam quantos estão sem valor da hora e se o filtro passou de 5000. # Listar apontamentos Source: https://juridiqsoftware.mintlify.app/api-reference/timesheets/listar-apontamentos https://api.juridiq.com.br/api-docs/client/openapi.json get /time-sheet/ Lista paginada: page começa em 1 e, sem limit, vêm todos os registros numa página só. orderByField aceita createdAt, updatedAt, completedAt ou title (padrão createdAt, orderBy desc); outro valor dá 400. Sem a permissão time_sheets.view, quem não é Gestor vê só os próprios apontamentos. personId e lawSuitId incluem os apontamentos que chegam por tarefa, subtarefa, audiência e atendimento, além do vínculo direto. costValue = timeSpentSeconds / 3600 × hourlyRate, arredondado em centavos, ou null sem hourlyRate. startDate e endDate filtram pela data de criação do apontamento, no dia de São Paulo; início depois do fim dá 400. includeSummary=true com personId ou lawSuitId soma o tempo inteiro e o custo de cada apontamento filtrado, deixando de fora os de status atual CANCELLED; sem esse escopo summary não vem. # Listar transações de crédito Source: https://juridiqsoftware.mintlify.app/api-reference/transactions/listar-transações-de-crédito https://api.juridiq.com.br/api-docs/client/openapi.json get /credits/transactions Lista transações de crédito com filtros e paginação # Atualizar tipo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/type-actions/atualizar-tipo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json patch /typeAction/{id} # Buscar tipo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/type-actions/buscar-tipo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json get /typeAction/{id} # Criar tipo de ação Source: https://juridiqsoftware.mintlify.app/api-reference/type-actions/criar-tipo-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json post /typeAction/ # Excluir tipos de ação Source: https://juridiqsoftware.mintlify.app/api-reference/type-actions/excluir-tipos-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json delete /typeAction/ # Listar tipos de ação Source: https://juridiqsoftware.mintlify.app/api-reference/type-actions/listar-tipos-de-ação https://api.juridiq.com.br/api-docs/client/openapi.json get /typeAction/ # Buscar usuário Source: https://juridiqsoftware.mintlify.app/api-reference/users/buscar-usuário https://api.juridiq.com.br/api-docs/client/openapi.json get /user/{id} # Criar usuário Source: https://juridiqsoftware.mintlify.app/api-reference/users/criar-usuário https://api.juridiq.com.br/api-docs/client/openapi.json post /user/ Cria um usuário no escritório da chave. O e-mail é único entre todos os escritórios (um usuário excluído que ainda pode ser restaurado também ocupa o e-mail). O profileId precisa ser um perfil deste escritório; officeId é opcional e, se enviado, precisa ser o do escritório da chave. document vazio é aceito; preenchido, segue personType: PF ou Pessoa Física exige CPF de 11 dígitos, PJ ou Pessoa Jurídica exige CNPJ de 14 caracteres e, sem personType, vale um dos dois. A descrição do colaborador orienta a IA na escolha do responsável. # Listar usuários Source: https://juridiqsoftware.mintlify.app/api-reference/users/listar-usuários https://api.juridiq.com.br/api-docs/client/openapi.json get /user/ # Me Source: https://juridiqsoftware.mintlify.app/api-reference/users/me https://api.juridiq.com.br/api-docs/client/openapi.json get /user/me # Apagar nota da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/apagar-nota-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json delete /wiki/notes/{id} Manda a nota e as subnotas para a Lixeira da Wiki. Dá para restaurar pelo Juridiq; a exclusão definitiva só é feita lá. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Buscar notas da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/buscar-notas-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json get /wiki/notes/search Busca no título e no texto das notas, sem diferenciar acento, e devolve até 20 resultados com o trecho encontrado (termos entre **). Para ler a nota inteira, use GET /wiki/notes/{id}. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Comentar em nota da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/comentar-em-nota-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json post /wiki/notes/{id}/comments Adiciona um comentário (ou resposta, com `parentId`). Menções no formato @[Nome](userId) avisam a pessoa no sino; quem não pode ler a nota não é avisado e aparece em `notNotified`. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Criar nota na Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/criar-nota-na-wiki https://api.juridiq.com.br/api-docs/client/openapi.json post /wiki/notes/ Cria uma nota no fim da seção (ou da nota pai) com título e conteúdo em Markdown. Subnota herda a seção da nota pai. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Editar nota da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/editar-nota-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json patch /wiki/notes/{id} Altera título, ícone e/ou conteúdo. `markdown` substitui o conteúdo inteiro: o que o Markdown não representa (cores, sublinhado, alinhamento, largura de colunas) se perde. Envie a `version` lida; se alguém salvou antes, a resposta é 409 com a versão atual, e nada é gravado. Nota privada de outra pessoa não pode ser editada. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Ler nota da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/ler-nota-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json get /wiki/notes/{id} Devolve a nota com o conteúdo em Markdown e a `version`, que o PATCH exige. Cores, sublinhado e alinhamento do editor não existem no Markdown e não aparecem aqui. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Listar comentários de nota da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/listar-comentários-de-nota-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json get /wiki/notes/{id}/comments Comentários da nota, com as respostas dentro de cada conversa, do mais antigo ao mais novo. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Listar notas da Wiki Source: https://juridiqsoftware.mintlify.app/api-reference/wiki/listar-notas-da-wiki https://api.juridiq.com.br/api-docs/client/openapi.json get /wiki/notes/ Lista as notas da Wiki do escritório (sem o conteúdo), em ordem da árvore, com o caminho de cada uma. Filtre por `parentId` para descer na árvore ou por `section`. Para ler o conteúdo, use GET /wiki/notes/{id}. **Quem vê o quê:** a chave age como o usuário dono dela e enxerga as notas do Escritório e as próprias notas privadas. Privadas de outras pessoas e notas compartilhadas não aparecem, nem para Gestor. **Disponibilidade:** só para escritórios com a Wiki liberada; fora disso, 404. **Auditoria:** toda ação por chave fica na auditoria do escritório (`entityType` wikiPage ou wikiComment), sem o conteúdo da nota. # Approve a workflow step waiting for approval Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/approve-a-workflow-step-waiting-for-approval https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/instances/{id}/steps/{stepId}/approve # Cancel workflow instance Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/cancel-workflow-instance https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/instances/{id}/cancel # Create workflow Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/create-workflow https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/ Cria uma automação. Via API key fica sempre pausada: o usuário revisa e ativa no módulo de Automações. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog. # Delete workflow Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/delete-workflow https://api.juridiq.com.br/api-docs/client/openapi.json delete /workflow/{id} # Get workflow Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/get-workflow https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/{id} # Get workflow instance detail Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/get-workflow-instance-detail https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/instances/{id} # Item states a workflow can wait on Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/item-states-a-workflow-can-wait-on https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/states Estados de cada módulo usados pelo passo "Se chegar em" (condição WAIT_FOR_STATE): { TASK: { label, states: { coluna: { label, kind } } } }. # Link the item created for a workflow request to its step Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/link-the-item-created-for-a-workflow-request-to-its-step https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/instances/{id}/steps/{stepId}/link # List open "create now" requests (lawsuit/signature) waiting for someone Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/list-open-"create-now"-requests-lawsuitsignature-waiting-for-someone https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/requests # List workflow instances Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/list-workflow-instances https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/instances # List workflows Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/list-workflows https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/ # Possible values of an item state (columns, funnel stages, yes/no) Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/possible-values-of-an-item-state-columns-funnel-stages-yesno https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/states/options # Retry a failed workflow webhook step Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/retry-a-failed-workflow-webhook-step https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/instances/{id}/steps/{stepId}/webhook/retry # Search items (task, CRM, transaction, event, audience) to start a manual workflow Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/search-items-task-crm-transaction-event-audience-to-start-a-manual-workflow https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/start-items # Start workflow manually Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/start-workflow-manually https://api.juridiq.com.br/api-docs/client/openapi.json post /workflow/{id}/start # Suggested responsible per distributed step for a manual start Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/suggested-responsible-per-distributed-step-for-a-manual-start https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/{id}/start-responsibles # Update workflow Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/update-workflow https://api.juridiq.com.br/api-docs/client/openapi.json patch /workflow/{id} Edita uma automação (campos parciais). Via API key a automação é pausada a cada edição: o usuário revisa e reativa na tela. Formato completo, gatilhos, ações e variáveis {{...}} em GET /workflow/catalog. # What the current user has to do in workflows (create requested items, approve steps) Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/what-the-current-user-has-to-do-in-workflows-create-requested-items-approve-steps https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/pending # Workflow catalog Source: https://juridiqsoftware.mintlify.app/api-reference/workflows/workflow-catalog https://api.juridiq.com.br/api-docs/client/openapi.json get /workflow/catalog Tudo o que uma automação aceita: estrutura do content, gatilhos (com as variáveis {{gatilho.*}} de cada um), ações e campos de config, condições, regras de encaixe dos passos, guia de variáveis e um esqueleto de exemplo. Leia antes de criar ou editar. # Autenticação Source: https://juridiqsoftware.mintlify.app/autentication Como autenticar requisições na API do Juridiq. # Autenticação A API do Juridiq utiliza autenticação baseada em API Key. Para acessar endpoints protegidos, envie sua chave utilizando o header `x-juridiq-api-key` em todas as requisições. > Cada API Key possui permissões vinculadas à conta e ao ambiente responsável pela integração. ## Header de autenticação ```http theme={null} x-juridiq-api-key: SUA_API_KEY ``` *** ## Exemplo de requisição ### cURL ```bash theme={null} curl --request GET \ --url https://api.juridiq.com.br \ --header 'x-juridiq-api-key: SUA_API_KEY' ``` ### JavaScript ```javascript theme={null} const response = await fetch("https://api.juridiq.com.br", { method: "GET", headers: { "x-juridiq-api-key": "SUA_API_KEY" } }) const data = await response.json() ``` ### Node.js ```javascript theme={null} import axios from "axios" const response = await axios.get( "https://api.juridiq.com.br", { headers: { "x-juridiq-api-key": "SUA_API_KEY" } } ) console.log(response.data) ``` *** ## Como obter sua API Key ### 1. Acesse o painel Entre na plataforma do Juridiq utilizando sua conta. ### 2. Abra as configurações Navegue até a área de integrações da plataforma. ### 3. Gere sua chave Crie uma nova API Key para utilizar na sua aplicação. ### 4. Armazene com segurança Guarde sua chave em um ambiente seguro e nunca exponha no frontend. *** ## Exemplo de resposta autenticada ```json theme={null} { "data": { "id": "office_123", "name": "Juridiq Advocacia", "email": "contato@juridiq.com.br" } } ``` *** ## Erros de autenticação ### API Key ausente ```json theme={null} { "message": "Acesso não autorizado", "statusCode": 401, "code": "UNAUTHORIZED" } ``` ### API Key inválida ```json theme={null} { "message": "API key inválida", "statusCode": 401, "code": "INVALID_API_KEY" } ``` *** ## Boas práticas ### Use variáveis de ambiente Nunca salve sua API Key diretamente no código-fonte da aplicação. ### Não exponha no frontend Requisições autenticadas devem ser realizadas apenas pelo backend. ### Rotacione suas chaves Atualize periodicamente suas chaves de acesso. *** > O compartilhamento indevido da sua API Key pode comprometer a segurança da sua integração. # Introdução Source: https://juridiqsoftware.mintlify.app/index Documentação oficial da API do Juridiq. # API do Juridiq Bem-vindo à documentação oficial da API do Juridiq. A API do Juridiq permite integrar funcionalidades da plataforma em aplicações web, mobile e sistemas jurídicos de forma simples, segura e escalável. Com ela, você pode gerenciar processos, clientes, usuários, automações. > [!NOTE] > > Todas as requisições e respostas da API utilizam JSON e seguem os padrões HTTP convencionais. ## O que você encontrará nesta documentação > [card] [Quickstart](/index) > > Configure sua aplicação e faça sua primeira requisição. > [card] [Autenticação](/autentication) > > Aprenda como funcionam tokens de acesso e autenticação. > [card] [API Reference](/api-reference/intro) > > Explore todos os endpoints disponíveis da API. > [card] [API Reference](/status) > > Veja os Códigos de status disponíveis. ## Recursos disponíveis > [card] Processos > > Gestão completa de processos jurídicos. > [card] Documentos > > Gestão de prazos, eventos e audiências. > [card] Clientes > > Gerenciamento de clientes e partes envolvidas. > [card] Automação > > Automatize fluxos e tarefas recorrentes do escritório. ## Casos de uso comuns A API do Juridiq foi projetada para permitir integrações flexíveis com sistemas jurídicos, ERPs, CRMs, portais de clientes e aplicações personalizadas. # Status Codes Source: https://juridiqsoftware.mintlify.app/status Códigos de status utilizados pela API. A API do Juridiq utiliza códigos HTTP convencionais para indicar o resultado das requisições. **200** `Success` Requisição realizada com sucesso. **201** `Created` Recurso criado com sucesso. **400** `Bad Request` A requisição enviada é inválida. **401** `Unauthorized` Token inválido ou não enviado. **403** `Forbidden` Você não possui permissão para acessar este recurso. **404** `Not Found` O recurso solicitado não foi encontrado. **429** `Too Many Requests` Limite de requisições excedido. **500** `Internal Server Error` Ocorreu um erro interno em nossos servidores.