API de andamentos do Themis | Themis

A API de andamentos do Themis permite consultar, inserir e editar andamentos por meio de integrações. Um andamento é um compromisso ou uma movimentação registrada em um processo, caso, contrato ou empresa. Com a API de andamentos, sistemas externos mantêm a agenda e o histórico do Themis atualizados, sem lançamento manual.

Antes de começar

O usuário usado para autenticar a requisição deve ser do tipo API. Com outro tipo de usuário, a chamada pode retornar HTTP 403. Veja como autenticar requisições na API do Themis.
O vínculo de andamentos a casos, contratos e empresas está disponível a partir da versão 4.17.6.0 do Themis. Em versões anteriores, a API aceita apenas andamentos de processo.
Os IDs enviados são sempre os identificadores internos dos registros no Themis. O número da pasta exibido na tela não é aceito como ID.

Retornando informações de andamento

Método: GET
Path: /api/andamentos/{idAndamento}/json

Retorna um andamento a partir do id informado no path.

JSON de retorno (exemplo):

{
  "id": 3797,
  "processoNumero": "Titulo do andamento",
  "idDesdobramento": 1,
  "horaFormatada": "00:00",
  "dataFormatada": "05/01/2017",
  "descricao": "Descrição do processo",
  "tipo": 1,
  "pendente": true,
  "prazoAndamentoEmNumero": 0,
  "tipoNome": "Audiência",
  "intervaloLembrarCompromisso": "4 Semanas",
  "advogado": 13,
  "advogadoNome": "Pessoa Advogado Interessado TESTE",
  "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
  "dataInclusao": "04/01/2017",
  "enviaEmail": "1"
}

Inserir/Editar andamento

Método: POST
Inserir andamento: /api/andamentos/novo/json
Editar andamento: /api/andamentos/edita/json

Insere ou edita um andamento. Se o JSON não tiver um id, ocorre a inserção. Para editar, envie um id válido, o vínculo do andamento e os campos que deseja alterar.

Vínculo do andamento

Todo andamento deve estar vinculado a um único registro por vez. Informe apenas um dos campos abaixo:

Vínculo	Campo no JSON
Processo	`"desdobramento": { "id": 1120 }`
Caso	`"caso": { "id": 350 }`
Contrato	`"contrato": { "id": 87 }`
Empresa	`"empresa": { "id": 42 }`

Não é permitido informar mais de um vínculo nem enviar o andamento sem vínculo.
Na edição, o id do vínculo também é obrigatório.
Os campos entidade e idEntidade não são reconhecidos por esse endpoint. O vínculo deve ser informado pelos objetos da tabela.
Propriedade Intelectual não é aceita como vínculo pela API.

‼️Importante: A partir da versão 4.17.6.0, a edição de andamento exige o id do vínculo. Integrações que editavam andamentos enviando apenas o id e os campos alterados precisam incluir o vínculo no JSON.

Campos do JSON de envio

Campo	Obrigatório	Descrição
`advogado.id`	Sim, na inserção	ID interno da pessoa responsável pelo andamento. A pessoa deve estar ativa no Themis.
`tipo.id`	Sim, na inserção	ID de um tipo de andamento cadastrado no Themis.
`data`	Sim, na inserção	Data do andamento, no formato `dd/MM/aaaa`. Exemplo: `"data": "25/03/2026"`.
`hora`	Não	Horário do andamento, no formato `HH:mm`.
`descricao`	Sim, na inserção	Descrição do andamento.
`Vínculo`	Sim	Um dos objetos `desdobramento`, `caso`, `contrato` ou `empresa`.
`publicacao.id`	Não	ID da publicação que deu origem ao andamento. Aceito apenas em andamentos de processo.
`id`	Somente na edição	ID do andamento que será editado.

Para obter o id do tipo de andamento, consulte a API de tipos de andamentos do Themis.

⚠️ Importante: O Themis só reconhece a data no formato dia/mês/ano com barras. Se a data for enviada em outro formato, como 2026-03-25, o Themis não reconhece o valor e responde que o campo data está faltando.

Tratamento de publicação

O tratamento de publicação é opcional e vale somente para andamentos de processo. Ao inserir um andamento de processo, você pode informar a publicação que deu origem ao andamento: "publicacao": { "id": 5501 }. A publicação informada é marcada como tratada.

⚠️ Alerta: A publicação precisa estar associada ao processo, de forma manual ou automática, antes do envio. Se a publicação não estiver associada, o andamento não é criado.

Exemplos de envio

JSON para inserir um andamento de processo com publicação:

{
  "advogado": { "id": 15 },
  "tipo": { "id": 21 },
  "data": "01/07/2015",
  "hora": "10:30",
  "descricao": "Audiência do processo 1234.",
  "desdobramento": { "id": 1120 },
  "publicacao": { "id": 5501 }
}

JSON para inserir um andamento de caso:

{
  "advogado": { "id": 15 },
  "tipo": { "id": 21 },
  "data": "01/07/2015",
  "descricao": "Reunião com o cliente.",
  "caso": { "id": 350 }
}

JSON para editar um andamento:

{
  "id": 1065699,
  "descricao": "Audiência remarcada para 10:30.",
  "desdobramento": { "id": 1120 }
}

Exemplo de retorno

{
  "id": 19606,
  "processoNumero": "Cível - Empresa - título - 132.33.00",
  "idDesdobramento": 15633,
  "horaFormatada": "00:00",
  "dataFormatada": "30/11/2019",
  "descricao": "descrição do andamento",
  "tipo": 2,
  "pendente": false,
  "statusRealizacao": "Pendente",
  "prazoAndamentoEmNumero": 31,
  "tipoNome": "Prazo",
  "intervaloLembrarCompromisso": "4 Semanas",
  "advogado": 12,
  "advogadoNome": "João da Silva",
  "advogadoFoto": "f11b489f2c33b0787c742e3c2eae5df0",
  "dataInclusao": "06/02/2019",
  "enviaEmail": "1"
}

Mensagens de erro

Situação	Código	Mensagem
Nenhum vínculo, mais de um vínculo ou `desdobramento` enviado sem o `id`	400	Um andamento precisa estar vinculado a um Processo, Caso, Empresa ou Contrato por vez.
`caso`, `contrato` ou `empresa` enviado sem o `id`	400	Não é possivel editar um andamento de Caso sem informar o ID do Caso.
Publicação não associada	500	Publicação precisa estar associada para poder ser tratada
Campo obrigatório ausente	500	Falta(m) o(s) seguinte(s) campo(s) obrigatório(s): ...
Andamento automático	403	Não é possível editar andamento do tipo Automático
Andamento já realizado	403	Andamento realizado não pode ser editado
Usuário não é do tipo API	403	Usuário deve ser do tipo API

Retorna andamentos a partir da data de filtragem

Método: GET
Path: /api/processos/{idProcesso}/andamentos/{dd-mm-yyyy}/json

Retorna todos os andamentos de um processo a partir da data informada no path.

JSON de retorno (exemplo):

[
  {
    "id": 3797,
    "processoNumero": "Titulo do andamento",
    "idDesdobramento": 1,
    "horaFormatada": "00:00",
    "dataFormatada": "05/01/2017",
    "descricao": "Descrição do andamento",
    "tipo": 1,
    "pendente": true,
    "prazoAndamentoEmNumero": 0,
    "tipoNome": "Audiência",
    "intervaloLembrarCompromisso": "4 Semanas",
    "advogado": 13,
    "advogadoNome": "Pessoa Advogado Interessado - TESTE",
    "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
    "dataInclusao": "04/01/2017",
    "enviaEmail": "1"
  }
]

Retornando andamentos de casos, contratos e empresas

Método: GET

A consulta de andamentos por registro também existe para casos, contratos e empresas. Cada vínculo tem uma rota que retorna todos os andamentos e outra que retorna os andamentos a partir de uma data.

Path	O que retorna
`/api/casos/{idCaso}/andamentos/json`	Todos os andamentos do caso
`/api/casos/{idCaso}/andamentos/{dd-mm-yyyy}/json`	Andamentos do caso a partir da data
`/api/contratos/{idContrato}/andamentos/json`	Todos os andamentos do contrato
`/api/contratos/{idContrato}/andamentos/{dd-mm-yyyy}/json`	Andamentos do contrato a partir da data
`/api/empresas/{idEmpresa}/andamentos/json`	Todos os andamentos da empresa
`/api/empresas/{idEmpresa}/andamentos/{dd-mm-yyyy}/json`	Andamentos da empresa a partir da data
`/api/processos/{idProcesso}/andamentos/json`	Todos os andamentos do processo, sem filtro de data

Usei {dd-mm-yyyy} no path porque é a notação que o artigo já usa na rota de processo; o feedback escreve {dd-mm-aaaa}, e o formato é o mesmo. Falta confirmar a versão mínima dessas rotas, que o feedback não informa.

Retornando andamento por período

Método: GET
Path: /api/andamentos/periodo/json

Busca os andamentos de todos os processos em um período, com filtro opcional por tipo de andamento.

Parâmetro	Tipo	Obrigatório	Descrição
`dataInicial`	texto	Sim	Data inicial do período, no formato `ddMMyyyy`.
`dataFinal`	texto	Sim	Data final do período, no formato `ddMMyyyy`.
`idTipoAndamento`	inteiro	Não	ID do tipo de andamento. Aceita vários valores separados por vírgula.

Exemplos de requisição:

/api/andamentos/periodo/json?dataInicial=01012018&dataFinal=05042019&idTipoAndamento=-4,66
/api/andamentos/periodo/json?dataInicial=01012018&dataFinal=05042019

JSON de retorno (exemplo):

[
  {
    "id": 20379,
    "processoNumero": "059 - Cível - Thiago Costa - Carlos Von Stein x Rock & Soul Ltda - 2008.001.20000-0",
    "idDesdobramento": 15748,
    "horaFormatada": "00:00",
    "dataFormatada": "12/12/2017",
    "descricao": "Decorrido prazo de ESTELINA BARROSO DE OLIVEIRA em 11/12/2017 23:59:59.",
    "tipo": -4,
    "pendente": false,
    "prazoAndamentoEmNumero": 0,
    "tipoNome": "Andamento automático",
    "intervaloLembrarCompromisso": "1 Semana",
    "advogado": 10,
    "advogadoNome": "Jorge Mel Cassiano",
    "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
    "dataInclusao": "10/12/2017",
    "enviaEmail": "1"
  },
  {
    "id": 20394,
    "processoNumero": "059 - Cível - Thiago Costa - Carlos Von Stein x Rock & Soul Ltda - 2008.001.20000-0",
    "idDesdobramento": 15748,
    "horaFormatada": "00:00",
    "dataFormatada": "12/12/2017",
    "descricao": "Decorrido prazo de ESTELINA BARROSO DE OLIVEIRA em 11/12/2017 23:59:59.",
    "tipo": -4,
    "pendente": false,
    "prazoAndamentoEmNumero": 0,
    "tipoNome": "Andamento automático",
    "intervaloLembrarCompromisso": "1 Semana",
    "advogado": 10,
    "advogadoNome": "Jorge Mel Cassiano",
    "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
    "dataInclusao": "04/12/2017",
    "enviaEmail": "1"
  }
]

Retornando andamento por período de data de inclusão

Método: GET
Path: /api/andamentos/periodo/dataInclusao/json

Busca os andamentos pelo período da data de inclusão, com filtro opcional por tipo de andamento. A rota devolve uma lista.

Parâmetro	Tipo	Obrigatório	Descrição
`dataInicial`	texto	Sim	Data inicial do período, no formato `ddMMyyyy`.
`dataFinal`	texto	Sim	Data final do período, no formato `ddMMyyyy`.
`idTipoAndamento`	inteiro	Não	ID do tipo de andamento. Aceita vários valores separados por vírgula.

Exemplos de requisição:

/api/andamentos/periodo/dataInclusao/json?dataInicial=01012018&dataFinal=05042019&idTipoAndamento=66
/api/andamentos/periodo/dataInclusao/json?dataInicial=01012018&dataFinal=05042019

JSON de retorno (exemplo):

[
  {
    "id": 20379,
    "processoNumero": "059 - Cível - Thiago Costa - Carlos Von Stein x Rock & Soul Ltda - 2008.001.20000-0",
    "idDesdobramento": 15748,
    "horaFormatada": "00:00",
    "dataFormatada": "12/12/2017",
    "descricao": "Decorrido prazo de ESTELINA BARROSO DE OLIVEIRA em 11/12/2017 23:59:59.",
    "tipo": -4,
    "pendente": false,
    "prazoAndamentoEmNumero": 0,
    "tipoNome": "Andamento automático",
    "intervaloLembrarCompromisso": "1 Semana",
    "advogado": 10,
    "advogadoNome": "Jorge Mel Cassiano",
    "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
    "dataInclusao": "10/12/2017",
    "enviaEmail": "1"
  },
  {
    "id": 20394,
    "processoNumero": "059 - Cível - Thiago Costa - Carlos Von Stein x Rock & Soul Ltda - 2008.001.20000-0",
    "idDesdobramento": 15748,
    "horaFormatada": "00:00",
    "dataFormatada": "12/12/2017",
    "descricao": "Decorrido prazo de ESTELINA BARROSO DE OLIVEIRA em 11/12/2017 23:59:59.",
    "tipo": -4,
    "pendente": false,
    "prazoAndamentoEmNumero": 0,
    "tipoNome": "Andamento automático",
    "intervaloLembrarCompromisso": "1 Semana",
    "advogado": 10,
    "advogadoNome": "Jorge Mel Cassiano",
    "advogadoFoto": "d41d8cd98f00b204e9800998ecf8427e",
    "dataInclusao": "04/12/2017",
    "enviaEmail": "1"
  }
]

Ficou com alguma dúvida? Entre em contato com nosso time de suporte pelo e-mail [email protected] ou, se preferir, utilize o ícone de chat disponível diretamente no Themis. Estamos à disposição para ajudar.

Estes artigos podem interessar a você: