Passar para o conteúdo principal

API de despesas do Themis

Documentação da API de despesas do Themis para consulta e gerenciamento de lançamentos financeiros

A API de Despesas do Themis permite consultar, cadastrar e atualizar despesas registradas no sistema, facilitando a integração das informações financeiras com aplicações externas.

Por meio dela, é possível acessar lançamentos vinculados a processos, clientes, advogados, contas e subcontas, mantendo os dados financeiros sincronizados entre diferentes sistemas.

Os métodos disponíveis possibilitam a consulta de despesas específicas, a listagem de despesas por processo e o cadastro ou edição de lançamentos financeiros.

Dessa forma, a API contribui para a automação de rotinas administrativas, geração de relatórios e integração de informações financeiras ao ecossistema do Themis.

⚠️ Importante: O módulo de despesas está disponível exclusivamente para clientes do plano Departamento Jurídico.


Retornando despesas do sistema

Path: /api/despesas/json

Método: GET

Lista todas as despesas do sistema.

Exemplo:

[
{
"id": 120,
"custaJudicial": "1",
"debitoCredito": "C",
"historico": "Honorário quitado",
"numeroDocumento": "1234",
"valor": 1050,
"valorAtualizado": "R$ 1051,50",
"data": "15/06/2015",
"cliente": {
"id": 8,
"nome": "JOSÉ DA SILVA"
},
"advogado": {
"id": 6369,
"nome": "EDNA CONCEIÇÃO"
},
"conta": {
"id": 1,
"nome": "Receita"
},
"subconta": {
"id": 1,
"nome": "Honorários advocatícios"
},
"desdobramento": {
"id": 1121
},
"processo": {
"id": 1000
}
},
{
..
}
]


Retornando despesa por ID de despesa

Path: /api/despesas/{idDespesa}/json

Método: GET

Informações de uma única despesa de acordo com seu id.

Exemplo:

[
{
"id": 120,
"custaJudicial": "1",
"debitoCredito": "C",
"historico": "Honorário quitado",
"numeroDocumento": "1234",
"valor": 1050,
"valorAtualizado": "R$ 1051,50",
"data": "15/06/2015",
"cliente": {
"id": 8,
"nome": "JOSÉ DA SILVA"
},
"advogado": {
"id": 6369,
"nome": "EDNA CONCEIÇÃO"
},
"conta": {
"id": 1,
"nome": "Receita"
},
"subconta": {
"id": 1,
"nome": "Honorários advocatícios"
},
"desdobramento": {
"id": 1121
},
"processo": {
"id": 1000
}
}
]


Retornando despesa por ID de processo

Path: /api/despesas/processos/{idProcesso}/json

Método: GET

Lista todas as despesas de um único processo.

Exemplo:

[
{
"id": 120,
"custaJudicial": "1",
"debitoCredito": "C",
"historico": "Honorário quitado",
"numeroDocumento": "1234",
"valor": 1050,
"valorAtualizado": "R$ 1051,50",
"data": "15/06/2015",
"cliente": {
"id": 8,
"nome": "JOSÉ DA SILVA"
},
"advogado": {
"id": 6369,
"nome": "EDNA CONCEIÇÃO"
},
"conta": {
"id": 1,
"nome": "Receita"
},
"subconta": {
"id": 1,
"nome": "Honorários advocatícios"
},
"desdobramento": {
"id": 1121
},
"processo": {
"id": 1000
}
}
]


Retornando despesa por ID de processo

Path: /api/despesa/novo/json

Path: /api/despesa/edita/json

Método: POST

Inserir/editar uma despesa, caso não exista um id no JSON, ocorrerá a inserção. Para edição, basta apenas um id válido. Para editar, pasta usar o mesmo corpo, incrementando com o elemento {"id": 000 }.

Exemplo:

{

"debitoCredito": "C",
"historico": "despesa pag guia",
"numeroDocumento": "010011",
"valor": 120.6,
"valorAtualizado": 1051.5,
"data": "24/08/2017",
"processo": {
"id": 438
}
"cliente": {
"id": 200364,
"nome": "ALESSANDRO TESTE EMPRESA"
},
"advogado": {
"id": 32,
"nome": "Bruno Keller"
},
"conta": {
"id": 13,
"nome": "3. Despesas Judiciais"
},
"subconta": {
"id": 24,
"nome": "3.1 Taxas"
},
"desdobramento": {
"id": 15788
},
"dominio": {
"id": 1,
"nome": "Publico - Sistema"
}
}


Retornando despesa por período [api v2 - 4.11.1.0+]

Path: /api/v2/despesas/json

Método: GET

Formato das datas: ddMMyyyy

Formato do idCliente: número inteiro

Parâmetros: dataInicial, dataFinal, idCliente

Exemplos de chamadas:

/api/v2/despesas/json?dataInicial=01102019
/api/v2/despesas/json?dataInicial=01102019&dataFinal=01122019
/api/v2/despesas/json?dataInicial=01012019&dataFinal=01122019&idCliente=5
/api/v2/despesas/json?dataFinal=01012018
/api/v2/despesas/json?idCliente=3
/api/v2/despesas/json?dataFinal=01012018&idCliente=4

Busca todas as despesas, independente do processo a partir de um período de datas e por um cliente em quaisquer combinações.

Exemplo:

[
{
"id": 220,
"debitoCredito": "C",
"historico": "teste 1",
"numeroDocumento": "876775",
"valor": 1000,
"valorAtualizado": "R$ 0,00",
"data": "01/01/2018",
"cliente": {
"id": 200332,
"nome": "BANCO BBM S.A."
},
"advogado": {
"id": 200336,
"nome": "Luan Reis"
},
"conta": {
"id": 9,
"nome": "1. Receitas"
},
"subconta": {
"id": 8,
"nome": "1.2 Honorários Advocatícios"
},
"desdobramento": {
"id": 15739
},
"processo": {
"id": 413
},
"dominio": {
"id": 1,
"nome": "Publico - Sistema"
}
},
{
"id": 221,
"custaJudicial": "1",
"debitoCredito": "D",
"historico": "teste 2",
"numeroDocumento": "87686",
"valor": -1000,
"valorAtualizado": "R$ 0,00",
"data": "01/01/2018",
"data Atualizacao": "18/01/2018",
"cliente": {
"id": 200332,
"nome": "BANCO BBM S.A."
},
"advogado": {
"id": 200336,
"nome": "Luan Reis"
},
"conta": {
"id": 9,
"nome": "1. Receitas"
},
"subconta": {
"id": 7,
"nome": "1.1 Honorários Internacionais"
},
"desdobramento": {
"id": 15739
},
"processo": {
"id": 413
},
"dominio": {
"id": 1,
"nome": "Publico - Sistema"
}
}
]


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

Estes artigos podem interessar a você:

Respondeu à sua pergunta?