Histórico da Página

...

Os serviços especificados neste documento serão consumidos na integração de ocorrências Ocorrências do Jurídico com o SIGAPFS.

02. DEFINIÇÕES DO SERVIÇO

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

...

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

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

...

Abaixo seguem as possíveis respostas do serviço:

02.1.2.1 Sucesso - 200

A requisição irá retornar uma Lista 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":"Usuário Teste",
        "email":"[email protected]"
      },
      "dataLog":{
        "inclusao":"2022-12-06 21:51:55.298104",
        "processamento":"2022-12-06 22:29:06.494160",
        "conclusao":""
      },
      "contrato":{
        "codigo":"000322",
        "cliente":"OCORRE",
        "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: 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 cálculo de valor para Faturamento; 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 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 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;

...

Retornará este erro quando o header de Authorization não for validoválido.

{
	"mensagem": "Falha na autenticaçã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);
• 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.

...

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

• 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].<CAMPO_RETORNO>: Valor do campo de retorno; (vide dicionário);

02.1.2.2 Body da requisição - Atos Processuais

...

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

• 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].processo: Código do Processo que o Ato Processual está vinculado;
• resposta.atosProcessuais[n].caso: Caso em que o Ato Processual está vinculado;
• resposta.atosProcessuais[n].descricao: Descrição do Ato Processual; 
• resposta.atosProcessuais[n].<CAMPO_RETORNO>: Valor do campo de retorno; (vide dicionário);

02.1.3 Response da requisição

Abaixo seguem as possíveis respostas do serviço:

02.1.3.1 Sucesso - 200

{
	"mensagem": "A solicitação <id_solicitação> foi atualizada com sucesso!"
}

...

Retornará este erro quando o header de Authorization não for validoválido.

{
	"mensagem": "Falha na autenticação!"
}

...

Retornará este erro quando o Body passado para a requisição contiver erros de Encode ou não respeitar a estrutura esperada.

{
	"mensagem": "Body não encontrado!"
}

...

Retornará este erro quando ocorrer erro na atualização dos dados da Solicitação.

{
	"mensagem": "Erro na atualização do arquivo da solicitação!"
}

...

04. DOCUMENTOS DE REFERÊNCIA

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

...