Histórico da Página

...

pi-validate-user-info-v1

Requisito

Nenhum.

Descrição

Realiza validações do usuário para acesso:

Se é aprovador;
Se possui algum documento configurado para aprovação;
Se o existe estabelecimento configurado para aprovação (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a validação do aprovador:

pathParams: Informar na seguinte ordem: validateUserInfo e código do aprovador.

Bloco de código

title	Exemplo

{
    "pathParams": [
    "validateUserInfo",
    "super"
  ],
}

oOutput

JsonObject

OUTPUT

Campo indicando se o usuário está válido:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "passed": true       
      }
    ]
  }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de validação.

Retorno

Indica se o usuário está válido e caso não esteja, os erros de validação.

...

pi-get-detail-pending-v1

Requisito

Nenhum.

Descrição

Realiza a busca dos detalhes de uma pendência de aprovação.

Obs.: Os campos são retornados conforme layout configurado para cada usuário e documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para detalhamento da pendência:

pathParams: Informar na ordem: detailPending e o número da transação.

Bloco de código

title	Exemplo

{
    "pathParams": [
       "detailPending",
       "90667"
    ],
}

oOutput

JsonObject

OUTPUT

Informações de layouts e dados da pendência solicitada:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "layout": [
          {
            "id": "doc-nr-requisicao",
            "componentType": 1,
            "label": "Requisição",
            "description": "Número da  Requisição de Estoque",
            "visible": true,
            "size": 50
          },
          {
            "id": "doc-dt-requisicao",
            "componentType": 1,
            "label": "Data Requisição",
            "description": "Data da  Requisição de Estoque",
            "visible": true,
            "size": 50
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor do Documento",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 100
          }
         ],
         "fieldValues": [
          {
            "id": "doc-nr-requisicao",
            "value": "123457111"
          },
          {
            "id": "doc-dt-requisicao",
            "value": "14\/04\/2021"
          },
          {
            "id": "pend-valor-doc",
            "value": "R$ 1,25"
          }
         ]
      }
    ]
  }
}

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-layout (layout): contém as informações dos campos do layout
tt-fields (fieldValues): contém as informações de campos e valores da pendência

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a busca de detalhes da pendência.

Retorno

Informações dos detalhes da pendência ou erros ocorridos durante a busca.

...

pi-reapprove-v1

Requisito

Nenhum.

Descrição

Realiza a re-aprovação de pendência(s).

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para re-aprovação de pendência(s):

pathParams: Informar: reapprove

payload:

transactions: Transações de pendências que devem ser aprovadas (pode ser uma ou várias):
- transactionNumber: Número da transação
- approveText: Comentário da aprovação

Bloco de código

title	Exemplo

{
    "pathParams": [
       "reapprove"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
       ],
       "approveText": "Re-aprovada!"
    },
}

oOutput

JsonObject

OUTPUT

Informações da re-aprovação:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "sucessProcess": true
  }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a re-aprovação das pendências.

Retorno

Informação de sucesso ou erros ocorridos no processo de re-aprovação.

pi-process-pending-v1
Requisito	Nenhum.
Descrição	Realiza a aprovação, reprovação ou re-aprovação de pendências.
	Parâmetros	Tipo	Input/Output	Descrição
	iAction	INTEGER	INPUT	Ação 1 - Aprovação 2 - Reprovação 3 - Reaprovação
	ttTransactions	TEMP-TABLE	INPUT	Lista de transações a serem processadas
	cText	CHARACTER	INPUT	Comentário de aprovação/reprovação
	iRejectionCode	INTEIRO	INPUT	Código de rejeição
	sucessProcess	LOGICAL	OUTPUT	Indica o processamento com sucesso (de pelo menos uma pendência)
	RowErrors	TEMP-TABLE	OUTPUT	Informações sobre os erros ocorridos durante o processo de aprovação/reprovação.
Retorno	Informação de sucesso ou erros ocorridos no processamento das pendências.

Definição de temp-tables:

...

tt-config-visual					Entrada/Saída
Temp-table com dados de configurações visuais de aprovadores					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cod-usuar		CHARACTER	Código do aprovador	Não	Não se aplica
idi-ordenacao	ordination	INTEGER	Ordenação padrão: (1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)	Não	Não se aplica
log-mostra-todas-empresas	allCompanies	LOGICAL	Indica apresentação de pendências de todas as empresas	Não	Não se aplica
log-aprova-sem-motiv	approveWithoutReason	LOGICAL	Indica aprovação sem informar motivo	Não	Não se aplica
cdn-tempo-desf	undoTime	INTEGER	Tempo de desfazer	Não	Não se aplica
idi-acao-swip-dire	rightSwipeAction	INTEGER	Ação do swipe de deslizar (DireitoDireita) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)		Não se aplica
idi-acao-swip-esq	leftSwipeAction	INTEGER	Ação do swipe de deslizar (EsquerdoEsquerda) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)	Não	Não se aplica
idi-visualiz-inicial	initialView	INTEGER	Visualização inicial (1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)	Não	Não se aplica
num-registro-paginac	pageRecordsNumber	INTEGER	Número de registros por página	Não	Não se aplica

...

ttParamPendingApproval				Entrada/Saída
Temp-table com parâmetros para busca de pendências				Saída
Atributo	Tipo	Descrição	Obrigatório	Evolução
company	CHARACTER	Empresa, se deixar em branco serão consideradas todas as empresas	Não	Não se aplica
establishment	CHARACTER	Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos	Não	Não se aplica
initialGenerationDate	DATE	Data de geração inicial	Não	Não se aplica
finalGenerationDate	DATE	Data de geração final	Não	Não se aplica
mainPendencies	LOGICAL	Indica se devem ser apresentadas as pendências principais	Sim	Não se aplica
alternativePendencies	LOGICAL	Indica se devem ser apresentadas as pendências alternativas	Sim	Não se aplica
masterPendencies	LOGICAL	Indica se devem ser apresentadas as pendências como mestre	Sim	Não se aplica
documents	CHARACTER	Documentos a serem considerados (separados por vírgula)	Sim	Não se aplica
pendingPendencies	LOGICAL	Indica se devem ser apresentadas pendências "pendentes"	Sim	Não se aplica
approvedPendencies	LOGICAL	Indica se devem ser apresentadas pendências "aprovadas"	Sim	Não se aplica
rejectedPendencies	LOGICAL	Indica se devem ser apresentadas pendências "reprovadas"	Sim	Não se aplica
reApprovedPendencies	LOGICAL	Indica se devem ser apresentadas pendências "reaprovadas"	Sim	Não se aplica
sortType	CHARACTER	Ordenação: Opções possíveis (se não informado será utilizado: -generationDate): -generationDate: Data de geração, decrescente generationDate: Data de geração, crescente -price: Valor, decrescente price: Valor, crescente company: Empresa establishment: EstabelicementoEstabelecimento documentType: Documento	Não	Não se aplica
pageSize	INTEGER	Tamanho da página (número de registros retornados). Se não informado será considerado: 20.	Não	Não se aplica
nextPageRowid	ROWID	Rowid do registro da próxima página	Não	Não se aplica

...

ttHistoricPending					Entrada/Saída
Temp-table com informações dos históricos de aprovação					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nivel		INTEGER	Nível de parovaçãoaprovação	Sim	Não se aplica
desc-nivel	approveType	CHARACTER	Descrição do nível de aprovação	Sim	Não se aplica
cod-aprovador	approverCode	CHARACTER	Código do aprovador	Sim	Não se aplica
nome-aprovador	approverDescription	CHARACTER	Nome do aprovador	Sim	Não se aplica
data-aprovacao	approveDate	DATE	Data da aprovação	Sim	Não se aplica
hora-aprovacao	approveHour	CHARACTER	Hora da aprovação	Sim	Não se aplica
narrativa	text	CHARACTER	Narrativa	Sim	Não se aplica
situacao	status	INTEGER	Situação 1 - Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada	Sim	Não se aplica

ttTransactions					Entrada/Saída
Temp-table com números de transações de pendências					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	transactionNumber	INTEGER	Número da transação	Sim	Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 9

Nova versão 10

Chave