Histórico da Página
...
Os serviços demonstrados nesta documentação serão consumidos pelo Sistema Jurídico.
...
02.1 Método de Busca Solicitações Aguardando Processamento
GET - /api/ocorrencia/pending/{codigoT}
Retorna uma lista com os dados das Solicitações que estão aguardando processamento~processamento.
02.1.1 Parâmetros da requisição
- codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração).
02.1.2 Response da requisição
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "response": [ { "id": "93109f2f1a4b5ffe-b075448d-ed114d11-abd9bbdf-b88584fbcf74", "entidade": "1", "campoRetorno": "VALOR_TOTAL1", "solicitante":{ "solicitante": { "nome": "Usuário TesteAdministrador", "email": "teste@totvswellington.machado@totvs.com.br" }, "dataLog": { "inclusao":"2022-12-06 21:51:55.298104 "inclusao": "2023-01-05 22:05:01.193688", "processamento":"2022-12-06 22:29:06.494160 "", "conclusao": "" }, "contrato": { "codigo": "000322000323", "cliente": "OCORREWYKPFS", "loja": "01" }, "ocorrencia": { "codigo": "000003000001", "descricao": "ValorNovos daprocessos causano de processosperiodo" }, "dataReferencia": { "inicial":"20220101", "finalinicial": "2022020120200201", }, "filtros":[ "final": "20200301" { "campo":"VALOR_CAUSA"}, "tipofiltros":"2", [ "valor":"5000" { }, { "campo": "PROCESSODATA_ENTRADA", "tipo":"2 "tipo": "1", "valor": "0000000009" } ]}, "casos":[ { "cliente":"JLP001", "lojacampo": "01STATUS_PROCESSO", "caso":"000044" }"tipo": "2", { "clientevalor": "JUR2191", "loja":"19", } "caso":"000003" }], ] "casos": }[ ] } |
Descrição das propriedades da solicitação:
{
"cliente": "WYKPFS",
"loja": "01",
"caso": "000003"
}
]
}
]
} |
Descrição das propriedades da solicitação:
- response: Array com os dados das Solicitações;
- response[n].id: Identificação da Solicitação (Formato UUIDv4);
- response[n].entidade: Entidade jurídica da Solicitação (vide dicionário);
- response[n].campoRetorno: Tag para o cálculo de valor para faturamento (vide dicionário);
- response[n].solicitante: Agrupamento de dados do Solicitante;
- response[n].solicitante.nome: Nome do Solicitante;
- response[n].solicitante.email: E-mail do Solicitante;
- response[n].dataLog: Agrupamento de Log da Solicitação;
- response[n].dataLog.inclusao: Data/Hora da inclusão da Solicitação;
- response[n].dataLog.processamento: Data/Hora da resposta de processamento da Solicitação;
- response[n].dataLog.conclusao: Data/Hora da conclusão da Solicitação;
- response[n].contrato: Agrupamento dos dados do Contrato;
- response[n].contrato.codigo: Código do Contrato;
- response[n].contrato.cliente: Código do Cliente do Contrato;
- response[n].contrato.loja: Loja do Cliente do Contrato;
- response[n].ocorrencia: Agrupamento da Ocorrência;
- response[n].ocorrencia.codigo: Código da Ocorrência;
- response[n].ocorrencia.descricao: Descrição da Ocorrência;
- response[n].dataReferencia: Agrupamento da Data de Referência;
- response[n].dataReferencia.inicial: Data inicial para filtro dos registrosresponse: Array com os dados das Solicitações;
- response[n].id: Identificação da Solicitação (Formato UUIDv4)dataReferencia.final: Data final para filtro dos registros;
- response[n].entidade: Entidade jurídica da Solicitação (vide dicionário)filtros: Array de filtros adicionais;
- response[n].filtros[i].campoRetorno: Tag para o cálculo de valor para faturamento campo: Campo a ser filtrado (vide dicionário);
- response[n].solicitante: Agrupamento de dados do Solicitante;response[n].solicitante.nome: Nome do Solicitantefiltros[i].tipo: Tipo do Filtro (vide dicionário);
- response[n].solicitante.email: E-mail do Solicitantefiltros[i].valor: Valor a ser filtrado;
- response[n].dataLogcasos: Agrupamento de Log da SolicitaçãoArray de Casos do Contrato;
- response[n].dataLog.inclusao: Data/Hora da inclusão da Solicitaçãocasos[i].cliente: Código do Cliente do Caso;
- response[n].dataLog.processamento: Data/Hora da resposta de processamento da Solicitação;
response[n].dataLog.conclusao: Data/Hora da conclusão da Solicitaçãocasos[i].loja: Loja do Cliente do Caso; - response[n].contrato: Agrupamento dos dados do Contrato;
- response[n].contrato.codigo: Código do Contrato;
- response[n].contrato.cliente: Código do Cliente do Contrato;
- response[n].contrato.loja: Loja do Cliente do Contrato;
- response[n].ocorrencia: Agrupamento da Ocorrência;
- response[n].ocorrencia.codigo: Código da Ocorrência;
- response[n].ocorrencia.descricao: Descrição da Ocorrência;
- response[n].dataReferencia: Agrupamento da Data de Referência;
- response[n].dataReferencia.inicial: Data inicial para filtro dos registros;
- response[n].dataReferencia.final: Data final para filtro dos registros;
- response[n].filtros: Array de filtros adicionais;
- response[n].filtros[i].campo: Campo a ser filtrado (vide dicionário);
- response[n].filtros[i].tipo: Tipo do Filtro (vide dicionário);
- response[n].filtros[i].valor: Valor a ser filtrado;
- response[n].casos: Array de Casos do Contrato;
- response[n].casos[i].cliente: Código do Cliente do Caso;
- response[n].casos[i].loja: Loja do Cliente do Caso;
- response[n].casos[i].caso: Código do Caso;
02.1.2.2 Erro Autenticação - 401
- casos[i].caso: Código do Caso;
02.1.2.2 Erro Autenticação - 401
Retornará este erro quando o header de Authorization não for válido.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"mensagem": "Falha na autenticação!"
} |
...
02.2 Método de Movimentação da Solicitação para "Em Processamento"
PUT - /api/ocorrencia/pending/{codigoT}/{codigoSolicitacao}/progress
Movimenta a solicitação que está em "aguardando processamento" para "em processamento".
Ao realizar a chamada deste endpoint o sistema irá atualizar o status da solicitação, evitando que a Solicitação apareça em uma próxima consulta da Busca de Solicitações Aguardando Processamento
02.2.1 Parâmetros da requisição
- codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração);
- codigoSolicitacao: ID da Solicitação a ser atualizada;
02.2.2 Body da requisição
Não há body para esta requisição no momento
02.2.3 Response da requisição
Abaixo seguem as possíveis respostas do serviço:
02.2.3.1 Sucesso - 200
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
} |
02.2.3.2 Erro Autenticação - 401
Retornará este erro quando o header de Authorization não for válido.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"mensagem": "Falha na autenticação!"
} |
02.2.3.3 Erro na atualização da solicitação - 404
Retornará este erro quando ocorrer erro na atualização dos dados da SolicitaçãoRetornará este erro quando o header de Authorization não for válido.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "mensagem": "FalhaArquivo não nafoi autenticaçãoencontrado!" } |
...
02.
...
3 Método de Atualização da Solicitação com dados Jurídicos
PUT - /api/ocorrencia/
...
progress/{codigoT}/{codigoSolicitacao}
Retorna uma lista com os dados das Solicitações que estão aguardando processamento.
...
Atualiza a Solicitação com os dados internos do Sistema Jurídico.
Obs: A solicitação precisa ter sido movimentada pelo método 'Movimentação da Solicitação para "Em Processamento"'.
02.3.1 Parâmetros da requisição
- codigoT: Código da Configuração do Cliente Encodado em Base64. (vide configuração);
- codigoSolicitacao: ID da Solicitação a ser atualizada;
02.
...
3.2 Body da requisição
O Body deve conter os registros que serão contabilizados para a geração da Fatura, respeitando a Entidade informada na Solicitação.
02.
...
3.2.1 Body da requisição - Processos
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "resposta": { "processos": [ { "id": "84098e43-da2a-4816-b249-ef67f3e61476", "cliente": "JLP001", "loja": "01", "caso": "000044", "processo": { "autor": "TOTVS SA", "reu": "João da Silva", "processo": "0014332-49.2011.4.01.4000" }, <CAMPO_RETORNO>: 100000 } ] } } |
...
- resposta: Agrupador da resposta;
- resposta.processos: Array com os dados dos Processos a serem processados;
- resposta.processos[n].id: Código do Processo;
- resposta.processos[n].cliente: Código do Cliente;
- resposta.processos[n].loja: Loja do Cliente;
- resposta.processos[n].caso: Caso em que o Processo está vinculado;
- resposta.processos[n].processo: Agrupamento do Processo;
- resposta.processos[n].processo.autor: Autor do Processo;
- resposta.processos[n].processo.reu: Réu do Processo;
- resposta.processos[n].processo.processo: Numero do Processo;
- resposta* resposta.processos[n].<CAMPO_RETORNO>: Valor do campo de retorno (vide dicionário);
* Obs: Campo só será necessário se na Solicitação a chave "campoRetorno" estiver preenchido, caso contrário não deve ser enviado.
02.
...
3.2.2 Body da requisição - Atos Processuais
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "resposta": { "atosProcessuais": [ { "id": "84098e43-da2a-4816-b249-ef67f3e61476", "cliente": "JLP001", "loja": "01", "caso": "000044", "processo": { "autor": "TOTVS SA", "reu": "João da Silva", "processo": "0014332-49.2011.4.01.4000" }, "ato": { "descricao": "Petição inicial", "data": "20230223" } } ] } } |
...
- resposta: Agrupador da resposta;
- resposta.atosProcessuais: Array com os dados dos Atos Processuais a serem processados;
- resposta.atosProcessuais[n].id: Código do Ato Processual;
- resposta.atosProcessuais[n].cliente: Código do Cliente;
- resposta.atosProcessuais[n].loja: Loja do Cliente;
- resposta.atosProcessuais[n].caso: Caso em que o Ato Processual está vinculado;
- resposta.atosProcessuais[n].processo: Agrupamento do Processo;
- resposta.atosProcessuais[n].processo.autor: Autor do Processo;
- resposta.atosProcessuais[n].processo.reu: Réu do Processo;
- resposta.atosProcessuais[n].processo.processo: Numero do Processo;
- resposta.atosProcessuais[n].ato: Agrupamento do Ato processual;
- resposta.atosProcessuais[n].ato.descricao: Descrição do Ato Processual;
- resposta.atosProcessuais[n].ato.data: Data do Ato Processual;
02.
...
3.3 Response da requisição
Abaixo seguem as possíveis respostas do serviço:
02.
...
3.3.1 Sucesso - 200
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!" } |
02.
...
3.3.2 Erro Autenticação - 401
Retornará este erro quando o header de Authorization não for válido.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "mensagem": "Falha na autenticação!" } |
02.
...
3.3.3Erro no Body da Requisição- 400
Retornará este erro quando o Body passado para a requisição contiver erros de Encode ou não respeitar a estrutura esperada.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "mensagem": "Body não encontrado!" } |
02.
...
3.3.4Erro na atualização da solicitação - 404
Retornará este erro quando ocorrer erro na atualização dos dados da Solicitação.
...