...
01. VISÃO GERAL
O Este documento busca demonstrar demonstra o Fluxo fluxo completo da Solicitação de Ocorrências, apresentando a dinâmica que os usuários terão com a nova encontrada nesta solução.
02. PRÉ-REQUISITOS
Para seguir que seja possívelutilizar os passos a seguir o sistema precisa estar com a configuração da solicitação criada.
Assim como ter o cadastro de ocorrências vinculado às faixas de valor para faturamento em Contratos no módulo SIGAPFS.
...
a Solicitação de Ocorrências, é necessário que o ambiente contenha as tabelas relacionadas e as rotinas envolvidas.
Nos próximos tópicos será demonstrado como utilizar cada rotina, por ordem de utilização.
03. CRIAÇÃO DA CONFIGURAÇÃO
Emissão de OcorrênciasCom os contratos previamente cadastrados o usuário irá acessar a rotina de Emissão de Ocorrências.
Nesta tela o usuário irá informar as solicitações que deseja criar para o Jurídico e informará o período de referência que deve ser utilizado pelo Sistema Jurídico.
Filtros disponíveis:
- Sócio: Sócio do Contrato
- Moeda: Moeda do Contrato
- Contrato: Código do Contrato
- Grupo de Clientes: Grupo de Cliente do Contrato
- Cliente: Cliente do Contrato
- Escritório: Escritório do Contrato
- Ocorrência Código da Ocorrência
- Tipo de Honorários: Tipo de Honorário do Contrato
Referência: O valor representado nos campos de Data são para orientar o Sistema Jurídico do período que precisa ser considerado na extração dos dados
- Data Inicial: Data inicial de processamento da ocorrência
- Data Final: Data final de processamento da ocorrência
Para mais informações consultar: Emissão de Ocorrências - JURA305.
Após o processamento dos contratos a partir dos filtros informados as solicitações serão gravadas no Cloud para que o Sistema Jurídico possa consultar as ocorrências.
Image Removed | 2 - Monitor das Solicitações | Após a geração das ocorrências e envio das informações para o Cloud, o sistema irá criar os registros correspondentes no Monitor de Solicitações, de modo que permita ao usuário analisar o andamento de cada solicitação.
Criando uma nova configuração | Para cadastrarmos uma nova configuração da solicitação, é necessário acessar o Wizard da configuração. Chave de segurança: - Chave de identificação do cliente
- A chave precisa ser repassada para o Sistema Jurídico para que ele possa integrar com a plataforma
Domínio de e-mail (obrigatório): - Será carregado o domínio de e-mail do usuário conectado
CNPJ: - Cadastro Nacional da Pessoa Jurídica da filial conectada do sistema, ideal que seja o CNPJ da empresa matriz
Para maiores informações, consultar: Configuração da integração - JURA304. | Image Added |
2- Em caso de configuração já cadastrada | Quando a configuração já está cadastrada, as informações são mostradas em modo de conferência, ou seja, não é possível alterar os campos. O usuário poderá finalizar o cadastro, porém, como não houve alteração, o sistema não reenvia a configuração. | Image Added |
3- Em caso de configuração já cadastrada, mas não parametrizada | No caso da configuração já existir e não estar parametrizada, o sistema irá mostrar mensagem que a configuração já foi criada e irá buscar no Cloud o código do cliente para parametrizá-lo no sistema. | Image Added |
04. CADASTRO DE OCORRÊNCIA
Passo | Descrição | Imagem |
---|
1- Cadastro de uma nova ocorrência | Para realizar o cadastro de uma nova Ocorrência, entrar no cadastro de ocorrências. O cadastro de ocorrências contém Cabeçalho e Grid, o cabeçalho possui os dados principais da Ocorrência e o Grid os Filtros a serem enviados na Solicitação. Abaixo a relação de campos da tela: - Código: Identificador da Ocorrência
- Descrição: Descritivo da Ocorrência
- Entidade: Entidade a qual a ocorrência pertence (vide dicionário)
- Campo Ret.: Campo para retorno do Sistema Jurídico
Grid: - Seq: Sequencial dos filtros
- Campo: Campo para filtro dos registros; (vide dicionário)
- Tipo: Tipo de filtro a ser realizado; (vide dicionário)
- Conteúdo: Em caso do "Tipo" for 2- Valor Fixo, o usuário irá informar o valor a ser filtrado
Para maiores informações, consultar: Ocorrências - JURA301. | Image Added |
05. FAIXA DE FATURAMENTO DA OCORRÊNCIA
Passo | Descrição | Imagem |
---|
1- Cadastro do Contrato | Para o faturamento das ocorrências, é preciso vinculá-la a um contrato. Os campos abaixo são importantes para o preenchimento dos dados da solicitação e filtro dos dados. Contrato: - Descrição: Descrição do Contrato
- *Cliente/Loja: Cliente do Contrato
- *Moeda: Moeda que será utilizada na Pré-fatura
- *Sócio: Sócio responsável do Contrato
- *Escritório: Escritório vinculado ao Contrato
- *Tipo de Honorário: Tipo de Honorário vinculado ao Contrato
- Ativo: Se o contrato está ativo ou não (Obrigatório estar ativo)
- Situação: Situação do Contrato, onde 1=Provisório; 2=Definitivo (O Contrato precisa ser definitivo)
Caso: - Os casos vinculados não precisam ser necessariamente do mesmo Cliente do Contrato.
Pagadores: - Os pagadores informados no Contrato serão utilizados comoPagadores na Fatura Adicional.
Para a geração de Solicitações de Ocorrência é necessário que o Contrato esteja Ativo e que a Situação seja Definitivo. OBS: Os campos sinalizados por (*) são utilizados como filtros na geração da Solicitação. | Image Added |
2- Cadastro das Faixas de Faturamento | Após o cadastro do Contrato, o usuário pode vincular o Cadastro de Ocorrência através do botão "Faixa Ocorr." que está no menu "Outras Ações" dentro do Contrato. Neste menu, poderão ser vinculadas quaisquer ocorrências desejadas e a definição das faixas de faturamento para cada uma. As faixas irão refletir diretamente no valor calculado na Fatura Adicional que o sistema irá gerar. No cabeçalho: - Cód. Ocorrên: Código da Ocorrência a ser vinculada
- Tipo Faixa: Tipo de Calculo que será considerado entre as faixas. 1=Estática;2=Progressiva;
- Estática: Utiliza o valor individual da faixa para compor o valor final
- Progressiva: Utiliza o valor das faixas retroativas para compor o valor final
- Tipo Calculo: Tipo de calculo a ser feito. 1=Quantidade;2=Valor
- Quantidade: Será considerada a quantidade de registros retornado pelo Sistema Jurídico.
- Valor: Levará em conta o Valor sinalizado no Campo de Retorno informado na Ocorrência.
Nas faixas: - Seq: Sequencial das Faixas
- Vlr. Inicial: Valor inicial da Faixa
- Vlr. Final: Valor final da Faixa
- Tipo Valor: Tipo de calculo da Faixa; 1=Valor Fixo; 2=Valor Unitário; 3=% a Cobrar
- Valor Fixo: O valor final será o valor da Faixa.
- Valor Unitário: Para cada ocorrência que se encontra nessa faixa será cobrado o valor; ( Valor x Quantidade Ocorrências)
- % a Cobrar: Essa faixa irá utilizar o Campo de Retorno para realizar o calculo final. Indicado quando a Ocorrência retorna campos de Valor, como VALOR_CAUSA e VALOR_ENVOLVIDO.
- Valor: Valor a ser cobrado. Levar em consideração a regra abaixo:
- Quando o Tipo de Valor for % a Cobrar o valor informado será convertido em Percentual. Exemplos:
- Valor = 50.00 → Percentual = 50%
- Valor = 100.00 → Percentual = 100%
- Valor = 0.50 → Percentual = 0.5%
- Levando em consideração esse cálculo, segue o exemplo abaixo:
- Caso uma ocorrência tenha VALOR_CAUSA igual a R$ 1000.00 e o valor for igual a 50.00, o valor final será R$ 500.00.
OBS: Quando o Tipo de Cálculo for Quantidade os Valores Iniciais e Finais devem finalizar sem valores decimais, enquanto o Tipo de Cálculo for Valor os intervalos tem que ser complementados com decimais, conforme exemplo abaixo: Sequencial | Tipo Calculo | Valor inicial | Valor Final |
---|
Faixa_Quant_01 | Quantidade | 0.00 | 1999.00 | Faixa_Quant_02 | Quantidade | 2000.00 | 9999999.00 | Faixa_Valor_01 | Valor | 0.00 | 1999.98 | Faixa_Valor_02 | Valor | 1999.99 | 9999999.99 |
Para maiores informações, consultar: Faixa de faturamento de Ocorrências - JURA302 | Image Added |
06. FLUXO DA SOLUÇÃO
Passo | Descrição | Imagem |
---|
1- Emissão de Ocorrências | Com os contratos previamente cadastrados, acessar a rotina de Emissão de Ocorrências. Nesta tela devem ser informadas as solicitações que deseja criar para o Jurídico e informar o período de referência que deve ser utilizado pelo Sistema Jurídico. Filtros disponíveis: - Sócio: Sócio do Contrato
- Moeda: Moeda do Contrato
- Contrato: Código do Contrato
- Grupo de Clientes: Grupo de Cliente do Contrato
- Cliente: Cliente do Contrato
- Escritório: Escritório do Contrato
- Ocorrência Código da Ocorrência
- Tipo de Honorários: Tipo de Honorário do Contrato
Referência: O valor representado nos campos de Data são para orientar o Sistema Jurídico quanto ao período que deve ser considerado na extração dos dados. - Data Inicial: Data inicial de processamento da ocorrência
- Data Final: Data final de processamento da ocorrência
Para mais informações, consultar: Emissão de Ocorrências - JURA305.
Apóso processamento dos contratos, as solicitações serão gravadas no Cloud para que o Sistema Jurídico possa consultar as ocorrências.
| Image Added |
2- Monitor das Solicitações | Após a geração das ocorrências e envio das informações para o Cloud, o sistema irá criar os registros correspondentes no Acompanhamento de solicitações de ocorrências, de modo que permita ao usuário analisar o andamento de cada solicitação.
Para mais informações, consultar: Solicitações de Ocorrências - JURA306. | Image Added |
3- Interação Sistema Jurídico | A partir do momento que for realizada a solicitação, o usuário não tem mais ação sobre as Solicitações que abriu. A partir deste momento entra a parte do Sistema Jurídico, que irá buscar os dados das Solicitações e irá enviar os dados que extraiu de sua base de dados. Para demonstrar os passos seguintes, iremos usar o registro 000324 que está posicionado no passo anterior.
Para mais informações sobre o conteúdo do JSON, consultar: Serviço de Solicitação de Ocorrência.
| Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | JSON da Solicitação |
---|
collapse | true |
---|
| {
"id":"5dfb0457-747a-ed11-abda-b88584fbcf74",
"entidade":"1",
"campoRetorno":"",
"solicitante":{
"nome":"Administrador",
"email":"[email protected]"
},
"dataLog":{
"inclusao":"2022-12-12 23:26:06.710524",
"processamento":"",
"conclusao":""
},
"contrato":{
"codigo":"000324",
"cliente":"WYKPFS",
"loja":"01"
},
"ocorrencia":{
"codigo":"000006",
"descricao":"Processos encerrados no periodo"
},
"dataReferencia":{
"inicial":"20220701",
"final":"20220801"
},
"filtros":[
{
"campo":"DATA_ENCERRAMENTO",
"tipo":"1",
"valor":""
}
],
"casos":[
{
"cliente":"WYKMIN",
"loja":"00",
"caso":"000002"
},
{
"cliente":"WYKPFS",
"loja":"01",
"caso":"000004"
}
]
} |
|
3.1- Buscando as Solicitações que estão Pendentes | Foi disponibilizada uma API para que o Sistema Jurídico consiga receber os dados das solicitações que estão aguardando o processamento. Abaixo segue um exemplo de requisição para buscar todas as Solicitações pendentes, onde {{juridicoapi}} é o endereço da API e o {{codigoT}} é o código do cliente que foi gerado na Configuração da Integração. Image Added
Para mais informações sobre o conteúdo do JSON, consultar: Serviço de Solicitação de Ocorrência.
| Abaixo temos um exemplo de retorno da requisição. É possível notar que o retorno é uma lista com os dados de cada solicitação que está como Pendente. O retorno está descrito na especificação do Serviço de Solicitação de Ocorrência. Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | Retorno das Solicitações |
---|
collapse | true |
---|
| {
"response":[
{
"id":"5dfb0457-747a-ed11-abda-b88584fbcf74",
"entidade":"1",
"campoRetorno":"",
"solicitante":{
"nome":"Administrador",
"email":"[email protected]"
|
|
Para mais informações consultar: Solicitações de Ocorrências - JURA306
Image Removed | 3 - Interação Sistema Jurídico | A partir do momento que o usuário realizar a solicitação o usuário não tem mais ação sobre as Solicitações que abriu.
Com isso entra a parte do Sistema Jurídico que irá buscar os dados das Solicitações e irá enviar os dados que extraiu.
Para demonstrar os passos seguintes iremos usar o registro 000321 que está posicionado no passo anterior.
Para mais informações sobre o conteúdo do JSON consultar: Serviço de Solicitação de Ocorrência.
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | JSON da Solicitação |
---|
collapse | true |
---|
| {
"id":"5257a34f-317a-ed11-abda-b88584fbcf74",
"entidade":"1",
"campoRetorno":"1",
"solicitante":{
"nome":"Administrador",
"email":"[email protected]"
},
"dataLog":{
"inclusao":"2022-12-12 15:26:15.344873",
"processamento":"",
"conclusao":""
},
"contrato":{
"codigo":"000321",
"cliente":"WYKPFS",
"loja":"01"
},
"ocorrencia":{
"codigo":"000001",
"descricao":"Novos processos no periodo"
},
"dataReferencia":{
"inicial":"20220601",
"final":"20220701"
},
"filtros":[
{
"campo":"DATA_ENTRADA",
"tipo":"1",
"valor":""
},
{
"campo":"STATUS_PROCESSO",
"tipo":"2",
"valor":"1"
}
],
"casos":[
{
"cliente":"WYKPFS",
"loja":"01",
"caso":"000001"
},
{
"cliente":"WYKPFS",
"loja":"01",
"caso":"000002"
}
]
} |
| 3.1 - Buscando as Solicitações que estão Pendente | Temos disponibilizado uma API para que o Sistema Jurídico consiga receber os dados das solicitações que estão aguardando o processamento. Abaixo segue um exemplo de requisição para buscar todas as Solicitações pendentes. Onde {{juridicoapi}} é o endereço da API e o {{codigoT}} é o código do cliente que foi gerado na Configuração da Integração. Image Removed | Abaixo é como fica o retorno da requisição. É possivel notar que o retorno é uma Lista com os dados de cada solicitação que esta como Pendente.
O retorno está descrito na especificação do Serviço de Solicitação de Ocorrência.
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | Retorno das Solicitações |
---|
collapse | true |
---|
|
{
"response": [
{
"id": "18b516da-307a-ed11-abda-b88584fbcf74",
"entidade": "1",
"campoRetorno": "1",
"solicitante": {
"nome": "Administrador",
"email": "[email protected]"
},
"dataLog": {
"inclusao": "2022-12-12 15:23:03.465535",
"processamento": "",
"conclusao": ""
},
"contrato": {
"codigo": "000321",
"cliente": "WYKPFS",
"loja": "01"
},
"ocorrencia": {
"codigo": "000001",
"descricao": "Novos processos no periodo"
},
"dataReferencia": {
"inicial": "20220501",
"final": "20220601"
},
"filtros": [
{
"campo": "DATA_ENTRADA",
"tipo": "1",
"valor": ""
},
{
"campo": "STATUS_PROCESSO",
"tipo": "2",
"valor": "1"
}
],
"casos": [
{
"cliente": "WYKPFS",
"loja": "01",
"caso": "000001"
{"inclusao":"2022-12-12 23:26:06.710524",
|
|
cliente WYKPFS,loja 01000324",
"cliente":"WYKPFS",
|
|
"caso": "000002"loja":"01"
},
"ocorrencia":{
|
|
}
]
"descricao":"Processos encerrados no periodo"
},
|
|
id "19b516da-307a-ed11-abda-b88584fbcf74 "entidade": "1",campoRetorno "VALOR_TOTAL","solicitante":{
"campo":"DATA_ENCERRAMENTO",
|
|
nome Administrador email [email protected]} "dataLog{
inclusao "2022-12-12 15:23:04.277304 processamento conclusao "contrato": "codigo 000321 cliente WYKPFS loja 01 ,"ocorrencia": {
"id":"5cfb0457-747a-ed11-abda-b88584fbcf74",
|
|
codigo 000003 descricao Valordacausadeprocessos"
"dataReferencia "inclusao":"2022-12-12 23:26:06.296559",
" |
|
inicial 20220501 "final 20220601},
filtros ["000323",
"cliente":"WYKPFS",
|
|
{"loja":"01"
},
"ocorrencia":{
" |
|
campo VALOR_CAUSA000003",
"descricao":"Valor da causa de processos"
},
" |
|
tipo "2", valor 5000},
{"campo":"VALOR_CAUSA",
"tipo":"2",
" |
|
campo PROCESSO,tipo 2PROCESSO",
"tipo":"2",
"valor": |
|
000001 },
{
"cliente": "WYKPFS",
"loja": "01", |
3.2- Atualização do Status da Solicitação | Conforme o Sistema Jurídico for lendo a lista de solicitações e iniciando o processamento das informações, ele deverá realizar uma requisição notificando que determinada solicitação está sendo processada, mudando o Status interno da solicitação de "Pendente" para "Em processamento". Para isso disponibilizamos um novo endpoint para realizar essa alteração. Nele é informado o {{codigoT}} do cliente e o {{idSolicitacao}} que é o Id da Solicitação que está como "Pendente". É de extrema importância que o Sistema Jurídico nos notifique que iniciou o processamento das informações pois esse Status é utilizado na requisição anterior ( 3.1- Buscando as Solicitações que estão Pendentes ) e também no próximo passo ( 3.3- Retornando os resultados da Extração ) Image Added | Ao realizar a requisição o sistema irá atualizar o Status da solicitação e retornará a mensagem abaixo: Image Added |
3.3- Retornando os resultados da Extração | Ao terminar a extração dos dados, o Sistema Jurídico irá enviar as informações para que atualizemos a solicitação. Conforme demonstrado abaixo, o Sistema irá mandar uma requisição PUT onde {{juridicoapi}} é a endereço da API, {{codigoT}} é o código do cliente e {{idSolicitacao}} é o Id da Solicitação que foi enviada na solicitação anterior ( response[n].id ). Image Added
Abaixo segue um exemplo de resposta do Jurídico a ser enviado no Body da requisição, conforme especificação do Serviço de Solicitação de Ocorrência Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | JSON da Requisição |
---|
collapse | true |
---|
| {
"resposta":{
"processos":[
|
|
caso "000002"
}"84098e43-da2a-4816-b249-ef67f3e61476",
|
|
]}
]
}3.2 - Retornando os resultados da Extração | Ao terminar a extração dos dados o Sistema Jurídico irá enviar as informações para que atualizemos a solicitação.
Conforme demonstrado abaixo o Sistema irá mandar uma requisição PUT, onde {{juridicoapi}} é a endereço da API, {{codigoT}} é o código do cliente e {{idSolicitacao}} é o Id da Solicitação que foi enviado na solicitação anterior ( response[n].id ).
Image Removed
Abaixo segue um exemplo de resposta do Jurídico a ser enviado no Body da requisição conforme especificação do Serviço de Solicitação de Ocorrência
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | JSON da Requisição |
---|
collapse | true |
---|
|
{
"resposta":{
"processos":["loja":"01",
"caso":"000004"
},
{
"id":"1fe08ced-72ee-4d6c-8a00-4137a116b1cd",
"cliente":"WYKMIN",
"loja":"00",
"caso":"000002"
},
{
"id":" |
|
84098e43da2a4816b249ef67f3e614761248debf9f51",
"cliente":" |
|
WYKPFS01000001",
"VALOR_CAUSA":1000001fe08ced72ee4d6c8a004137a116b1cd229cae5ad543",
"cliente":"WYKPFS",
"loja":"01",
"caso |
|
":"000001",
"VALOR_CAUSA":30000305174e5862b45afb6fe1248debf9f514f959f411eb2",
"cliente":" |
|
WYKPFS01, "VALOR_CAUSA":5000
},
{
"id":"553c4dd7-f0d5-48bd-9d9b-229cae5ad543",
"cliente":"WYKPFS",
"loja":"01",
"caso":"000001",
"VALOR_CAUSA":19000
},
{
"id":"45f7ad0d-323e-48e5-97db-4f959f411eb2",
"cliente":"WYKPFS",
"loja":"01",
"caso":"000002",
"VALOR_CAUSA":7500
}
]
}
}Ao enviar os dados, se os dados estiverem no formato esperado pelo sistema, ele irá atualizar os dados na solicitação e retornar a seguinte mensagem.
Image Removed
04. DOCUMENTOS RELACIONADOS
| Ao enviar os dados, se estes estiverem no formato esperado pelo sistema, as solicitações serão atualizadas e será dada a seguinte mensagem. Image Added |
4- Processando as requisições prontas | Uma vez que o Sistema Jurídico atualizou a Solicitação com os Processos/Atos Processuais, a solicitação ficará pronta para que o Protheus (SIGAPFS) baixe os dados e inicie o processamento gerando as Faturas adicionais. O botão está localizado na tela de Acompanhamento de solicitações de ocorrências, ao lado do Visualizar, chamado "Atualizar solicitações". Ao clicar no botão o sistema irá procurar todas as solicitações que estão prontas no Cloud e para cada uma irá criar uma Fatura adicional. Image Added | Ao final do processamento vemos que a Solicitação gerou uma Fatura Adicional, pois o Status da Solicitação virou "Pendente Faturamento". Image Added |
5- Visualizando os dados da Fatura adicional | Podemos entrar na tela de Fatura adicional e procurar pela Fatura que foi gerada. Para o caso que estamos demonstrando, foi gerada a Fatura Adicional 00000027. Podemos encontrá-la na tela de Acompanhamento de solicitações de ocorrências, conforme imagem abaixo: Image Added
| Entrando na tela de Fatura Adicional, ao consultar a Fatura Adicional vemos que os dados do Contrato se mantiveram tanto nos dados da Fatura Adicional quanto na aba de Pagadores e Casos vinculados. Outro detalhe importante é que nos campos de "Desc. Relat" e "Desc. Carta" temos a memória de cálculo para chegar no valor final. E os valores ficam atribuídos nos campos de "Valor TS" e no campo "Valor de TS" do Grid de casos discriminando o valor por caso. Image Added |
07. FATURAMENTO DE OCORRÊNCIAS
Passo | Descrição | Imagem |
---|
1- Geração de Relatório | Ao gerar a Pré-fatura da Fatura Adicional o usuário pode emitir o relatório de Pré-fatura para validar os dados ou enviar o relatório para outras pessoas. Para isso, utilizamos o relatório que existe atualmente e incluímos os dados da Ocorrência. Neste relatório são apresentadas as seguintes informações: - A Descrição do Cálculo feito para chegar no valor da Fatura Adicional.
- A discriminação do Valor por caso, no exemplo apresentado temos os 2 (dois) casos vinculados ao contrato com seus respectivos valores.
Para implementar as alterações nos relatórios do Cliente, consultar: DT DJURDEP-11246 (PFS/FIN) Ajustes na fatura adicional. | Image Added |
08. DOCUMENTOS RELACIONADOS Âncora |
---|
| DocumentosRelacionados |
---|
| DocumentosRelacionados |
---|
|
09. TABELAS RELACIONADAS Âncora |
---|
| TabelasRelacionadas |
---|
| TabelasRelacionadas |
---|
|