CONTEÚDO

01. VISÃO GERAL

Os serviços especificados neste documento serão consumidos , utilizados na integração de  de ocorrências SIGAPFS x Legal Deskdo Jurídico com o SIGAPFS.

02. Definições do

...

serviço 

Os serviços demonstrados neste documentão serão consumidos pelo Sistema Jurídico.

02.1 Método GET - /api/ocorrencia/pending/{codigoT}

...

Esse método é responsável pela solicitação de ocorrências do sistema LegalDesk para calcular o faturamento das ocorrências.

• • codigoT: CódigoT recebido pela configuração do Protheus

02.1 Método POST 

Método responsável pela criação das solicitações para serem lidas pelo LegalDesk

02.1.1 Body JSON da requisição

...

Retorna uma lista com os dados das Solicitações que estão aguardando processamento

02.1.1 Parâmetros da requisição.

• codigoT: Código da Configuração do Cliente. (vide configuração)

02.1.2 Response da requisição.

A requisição irá retornar uma Lista com os dados da Solicitação para que o Sistema Jurídico comece a coletar as informações

{
  "response":[
    {
      "id":"93109f2f-b075-ed11-abd9-b88584fbcf74",
      "entidade":"1",
      "campoRetorno":"VALOR_TOTAL",
      "solicitante":{
        "nome":"AdministradorUsuário Teste",
        "email":"administrador@totvsteste@totvs.com.br"
      },
      "dataLog":{
        "inclusao":"2022-12-06 21:51:55.298104",
        "processamento":"2022-12-06 22:29:06.494160",
        "conclusao":""
      },
      "contrato":{
        "codigo":"000322",
        "cliente":"WYKPFSOCORRE",
        "loja":"01"
      },
      "ocorrencia":{
        "codigo":"000003",
        "descricao":"Valor da causa de processos"
      },
      "dataReferencia":{
        "inicial":"20220101",
        "final":"20220201"
      },
      "filtros":[
        {
          "campo":"VALOR_CAUSA",
          "tipo":"2",
          "valor":"5000"
        },
        {
          "campo":"PROCESSO",
          "tipo":"2",
          "valor":"0000000009"
        }
      ],
      "casos":[
        {
          "cliente":"JLP001",
          "loja":"01",
          "caso":"000044"
        },
        {
          "cliente":"JUR219",
          "loja":"19",
          "caso":"000003"
        }
      ]
    }
  ]
}

Descrição das propriedades da solicitação.

• • response: Array com os dados das Solicitações;
  • response[n].id: identificador universal  da solicitação(uuid).
  • solicitante: nome do solicitante
  • emailSolicitante: e-mail do solicitante
  • dataInclusao: data de inclusão da solicitação
  • dataProcessamento: data a qual solicitação foi processada
  • dataConclusao: data a qual solicitação foi concluída
  • entidade: entidade jurídica a realizar a solicitação (vide dicionário)
  contrato: código docontrato vinculado a solicitação
  • codOcorrencia: Código da ocorrência
  • descOcorrencia: Descrição da ocorrência
  • clienteCaso: array de objeto cliente/caso
    • cliente: cliente do caso relacionado ao contrato
    • loja: loja do cliente 
    • caso: caso do cliente
  • dataReferencia: objeto data de referência
    • dataRefInicial: data inicial de referência 
    • dataRefFinal: data final de referência 
  • filtros: array de objetos (vide dicionário)
    
    • campo: campos a serem filtrados
    • valor: valor do campo 

02.2.2 JSON Resposta 

...

• • : 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 calculo 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 do 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 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.2 Método PUT - /api/ocorrencia/pending/{codigoT}/{codigoSolicitacao}

Retorna uma lista com os dados das Solicitações que estão aguardando processamento

02.1.1 Parâmetros da requisição.

• codigoT: Código da Configuração do Cliente. (vide configuração);
• codigoSolicitacao: ID da Solicitação a ser atualizada;

02.1.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.1.2.1 Body da requisição - Processos

{
  "idresposta": "c74142a6-5146-11ed-bdc3-0242ac120002",
  "solicitante": "<nome_solicitante>",
{
    "emailSolicitanteprocessos": "[email protected]",[
  "dataInclusao": "20221021",
  "dataProcessamento": null, {
  "dataConclusao": null,
  "entidade": "1",
  "contratoid": "000001",
  "clienteCaso": [
    {
      "cliente": "000001",
      "loja": "01",
"84098e43-da2a-4816-b249-ef67f3e61476",
        "caso": "000000"
    }000044",
    {
      "cliente": "000001",<CAMPO_RETORNO>:100000
      "loja": "01",}
      "caso": "000001"]
    }
  ],
  "dataReferencia": {
    "dataRefInicial": "20221001",
    "dataRefFinal": "20221031"
  },
  "filtros": [{ "campo": "STATUS_PROCESSO", "valor": "1" }],
  "resultado": {
    "processos": [
      {
        "cliente": "000001",
        "loja": "01",
        "caso": "000000",
        "processo": "5345345345345345",
        "retorno": ""
      },
      {
        "cliente": "000001",
        "loja": "01",
        "caso": "000001",
        "processo": "123123123123123",
        "retorno": ""
      }
    ],
    "atoprocessual": }
}

Descrição das propriedades da solicitação.

• • resposta: Agrupador da resposta
  • resposta.processos: Array com os dados processos a serem processados
  • resposta.processos[n].id: Código do Processo
  • resposta.processos[n].caso: Caso em que o Processo está vinculado
  • resposta.processos[n].<CAMPO_RETORNO>: Valor do campo de retorno

02.1.2.2 Body da requisição - Atos Processuais

{
  "resposta":{
    "atosProcessuais":[
      {
        "clienteid": "000001",
        "loja": "01"84098e43-da2a-4816-b249-ef67f3e61476",
        "caso": "000001000044",
        "processo": "123123123123123",
        "descricao": "descrição do caso processual",
        "retorno": ""<CAMPO_RETORNO>:100000
      }
    ]
  }
}

Descrição dos Campos:

• • resultado: objeto de resultado (possíveis resultados)
    • processos: array de processos
      • cliente: código do cliente
      • loja: loja do cliente 
      • caso: código do caso
      • processo: id do processo
      • retorno: retorno esperado conforme ocorrência solicitada (vide dicionário)
    • atoprocessual: array de atos processuais

...

03. TABELAS UTILIZADAS

• OI2 - Tipos de Ocorrências
• OI3 - Filtros de Ocorrências

04. Documentos de Referência

• Ocorrências - JURA301
• Dicionário para integração de ocorrências (SIGAPFS) x sistemas jurídicos

...