Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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

02.

...

2.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.

...

2.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.

...

2.2.1 Body da requisição - Processos
Bloco de código
languagejs
themeRDark
titleBody Processos
collapsetrue
{
    "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
            }
        ]
    }
}

...

* Obs: Campo só será necessário se na Solicitação a chave "campoRetorno" estiver preenchido, caso contrário não deve ser enviado

02.

...

2.2.2 Body da requisição - Atos Processuais
Bloco de código
languagejs
themeRDark
titleBody Atos Processuais
collapsetrue
{
    "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.

...

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
languagejs
themeRDark
titleResponse - 200
collapsetrue
{
	"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
languagejs
themeRDark
titleResponse - 401
collapsetrue
{
	"mensagem": "Falha na autenticação!"
}
02.

...

2.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
languagejs
themeRDark
titleResponse - 400
collapsetrue
{
	"mensagem": "Body não encontrado!"
}
02.

...

2.3.4Erro na atualização da solicitação - 404

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

...