Histórico da Página

...

pi-query-app-list-v1

Requisito

Nenhum.

Descrição

Realiza a busca de pendências a ser apresentada na listagem do APP.

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 a busca do aprovador:

pathParams: Informar: getPendingApprovalToList

queryParams:

company: Empresa, se não informar o parâmetro serão consideradas todas as empresas
establishment: Estabelecimento, se não informar o parâmetro serão considerados todos os estabelecimentos
inicialGenerationDate: Data de geração inicial no formato yyyy-mm-dd (se enviar no formato inválido é desconsiderado)
finalGenerationDate: Data de gera‡geraçãofinal geração final no formato yyyy-mm-dd (se enviar no formato inválido é desconsiderado)
mainPendencies: Indica se devem ser apresentadas as pendências principais
alternativePendencies: Indica se devem ser apresentadas as pendências alternativas
masterPendencies: Indica se devem ser apresentadas as pendências como mestre
documents: Documentos a serem considerados (separados por vírgula)
pendingPendencies: Indica se devem ser apresentadas pendências "pendentes"
approvedPendencies: Indica se devem ser apresentadas pendências "aprovadas"
rejectedPendencies: Indica se devem ser apresentadas pendênciaspendências pendências "reprovadas"
reApprovedPendencies: Indica se devem ser apresentadas pendências "reaprovadas"
order: Ordenação: Opçõess 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
pageSize: Tamanho da página (número de registros retornados)
nextRowid: Rowid do registro da próxima página (que será buscado os registros)

Bloco de código

title	Exemplo

{
   "pathParams": [
      "getPendingApprovalToList"
   ],
   "queryParams": {
      "mainPendencies": [
         ""
      ],
      "pendingPendencies": [
         ""
      ],
      "approvedPendencies": [
         ""
      ],
      "rejectedPendencies": [
         ""
      ],
      "reApprovedPendencies": [
         ""
      ],
      "documents": [
         "3,8"
      ],
      "order": [
         "-price"
      ],
      "pageSize": [
         "30"
      ]
  },
}

oOutput

JsonObject

OUTPUT

Informações das pendências:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 3,
    "hasNext": false,
    "items": [
      {
        "transactionNumber": 88912,
        "documentType": 8,
        "documentKey": "994344",
        "generateDate": "2021-03-03",
        "approver": "super",
        "status": 2,
        "company": "10",
        "site": "1",
        "pendencyType": 1,
        "price": 109989000.00,
        "fields": [
          {
            "id": "pend-cod-tip-doc-desc",
            "value": "Pedido Emergencial - Total"
          },
          {
            "id": "pend-chave-doc",
            "value": "994344"
          },
          {
            "id": "pend-cod-usuar-doc",
            "value": "super"
          },
          {
            "id": "pend-valor-doc",
            "value": "R$ 109.989.000,00"
          }
        ]
      },
      {
        "transactionNumber": 88967,
        "documentType": 3,
        "documentKey": "12345707710 .compras",
        "generateDate": "2021-03-04",
        "approver": "super",
        "status": 1,
        "company": "10",
        "site": "1",
        "pendencyType": 1,
        "price": 12.45,
        "fields": [
          {
            "id": "doc-nr-requisicao",
            "value": "123457077"
          },
          {
            "id": "doc-sequencia",
            "value": "10"
          },
          {
            "id": "doc-it-codigo",
            "value": ".compras"
          },
          {
            "id": "doc-dt-requisicao",
            "value": "04\/03\/2021"
          },
          {
            "id": "doc-nome-abrev",
            "value": "super"
          },
          {
            "id": "pend-valor-doc",
            "value": "R$ 12,45"
          }
        ]
      },
      {
        "transactionNumber": 89469,
        "documentType": 3,
        "documentKey": "12345708510 .compras-copia",
        "generateDate": "2021-03-22",
        "approver": "super",
        "status": 4,
        "company": "10",
        "site": "1",
        "pendencyType": 1,
        "price": 9.09,
        "fields": [
          {
            "id": "doc-nr-requisicao",
            "value": "123457085"
          },
          {
            "id": "doc-sequencia",
            "value": "10"
          },
          {
            "id": "doc-it-codigo",
            "value": ".compras-copia"
          },
          {
            "id": "doc-dt-requisicao",
            "value": "22\/03\/2021"
          },
          {
            "id": "doc-nome-abrev",
            "value": "super"
          },
          {
            "id": "pend-valor-doc",
            "value": "R$ 9,09"
          }
        ]
      }
    ]
  },
  "nextRowid": null
}

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

tt-mla-doc-pend-aprov: contém as informações gerais da pendência
- tt-fields (fields): contém as informações de campos e valores da pendência
nextRowid: Rowid do registro da próxima página (para utilizar na próxima busca de dados)

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca das pendências.

Retorno

Informações de pendências a serem apresentadas ou erro ocorridos durante a busca.

pi-query-pending-approval

...


Requisito	Nenhum.
Descrição	Realiza a busca de pendências a ser apresentada na listagem do APP.
	Parâmetros	Tipo	Input/Output	Descrição
	ttParamPendingApproval	TEMP-TABLE	INPUT	Parâmetros para busca dos registros de pendências
	tt-mla-doc-pend-aprov	TEMP-TABLE	OUTPUT	Listagem com informações das pendências
	lHasNext	LOGICAL	OUTPUT	Indica que existem mais registros a serem mostrados
	rNextRowid	ROWID	OUTPUT	Próximo rowid para busca de novos registros
	RowErrors	TEMP-TABLE	OUTPUT	Informações sobre os erros ocorridos durante o processo de busca das pendências.
Retorno	Sigla do documento.

pi-query-rejection-options-v1

pi-get-detail-pending-v1

pi-get-detail-historic-pending-v1

pi-approve-v1

pi-reprove-v1

pi-reapprove-v1

pi-process-pending-v1

Definição de temp-tables

pi-query-rejection-options-v1

pi-get-detail-pending-v1

pi-get-detail-historic-pending-v1

pi-approve-v1

pi-reprove-v1

pi-reapprove-v1

pi-process-pending-v1

Definição de temp-tables:

Sim

RowErrors				Entrada/Saída
Temp-table com dados dos erros ocorridos durante o processo				Saída
Atributo	Tipo	Descrição	Obrigatório	Evolução
ErrorSequence	INTEGER	Número da sequência do erro	Sim	Não se aplica
ErrorNumber	INTEGER	Código do erro	Sim	Não se aplica
ErrorDescription	CHARACTER	Descrição do erro	Sim	Não se aplica
ErrorParameters	CHARACTER	Parâmentros da mensagem de erro	Sim	Não se aplica
ErrorType	CHARACTER	Tipo do erro	Sim	Não se aplica
ErrorHelp	CHARACTER	Texto de ajuda da mensagem de erro	Sim	Não se aplica
ErrorSubType	CHARACTER	Subtipo do erro
do erro	Sim	Não se aplica
ErrorNumber	INTEGER	Código do erro	Sim	Não se aplica
ErrorDescription	CHARACTER	Descrição do erro	Sim	Não se aplica
ErrorParameters	CHARACTER	Parâmetros da mensagem de erro	Sim	Não se aplica
ErrorType	CHARACTER	Tipo do erro	Sim	Não se aplica
ErrorHelp	CHARACTER	Texto de ajuda da mensagem de erro	Sim	Não se aplica
ErrorSubType	CHARACTER	Subtipo do erro	Sim	Não se aplica

tt-aprovador					Entrada/Saída
Temp-table com dados dos aprovadores					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cod-usuar	userCode	CHARACTER	Código do aprovador	Não	Não se aplica
nome-usuar	userName	CHARACTER	Nome do aprovador	Não	Não se aplica
e-mail	eMail	CHARACTER	E-mail do aprovador	Não	Não se aplica
envia-email	sendEmail	LOGICAL	Indica se envia e-mail	Não	Não se aplica
recebe-email	receiveEmail	LOGICAL	Indica se recebe e-mail	Não	Não se aplica
usuar-mestre	masterUser	LOGICAL	Indica se o usuário é mestre	Não	Não se aplica
mo-codigo	currency	INTEGER	Moeda do aprovador	Não	Não se aplica
sigla-moeda	currencyAbbrev	CHARACTER	Sigla da moeda do usuário	Não	Não se aplica
aprova-auto	automacticApproval	LOGICAL	Indica se o aprovador aprova automaticamente	Não	Não se aplica
aprova-auto-aprov	automacticApprovalApprover	LOGICAL	Indica se o aprovador aprova automaticamente pendências do aprovador	Não	Não se aplica
cod-estabel	siteCode	CHARACTER	Estabelecimento do aprovador	Não	Não se aplica
cod-lotacao	allocationCode	CHARACTER	Lotação do aprovador	Não	Não se aplica
libera-verba	releaseAmount	LOGICAL	Indica se o aprovador libera verba	Não	Não se aplica
log-usuar-config	configuratorUser	LOGICAL	Indica se o aprovador é configurador visual	Não	Não se aplica
empresa	companyCode	CHARACTER	Empresa do aprovador	Não	Não se aplica
idioma	language	CHARACTER	Idioma do aprovador	Não	Não se aplica

tt-

aprovador

config-visual					Entrada/Saída
Temp-table com dados

dos

de configurações visuais de aprovadores					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório

Evolução

cod-usuar

userCode

CHARACTER

	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

Código do aprovador

Não

Não se aplica

nome-usuar

userNameCHARACTER

log-aprova-sem-motiv

approveWithoutReason

LOGICAL

Indica aprovação sem informar motivo

Nome do aprovador

Não

Não se aplica

e

cdn-tempo-

mail

desf

eMail

undoTime

CHARACTER E-mail do aprovador

INTEGER

Tempo de desfazer

Não

Não se aplica

envia-emailsendEmailLOGICALIndica se envia e-mail

idi-acao-swip-dire

rightSwipeAction

INTEGER

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não

Não se aplica

recebe-emailreceiveEmailLOGICALIndica se recebe e-mail

idi-acao-swip-esq

leftSwipeAction

INTEGER

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não

Não se aplica

usuar-mestremasterUserLOGICALIndica se o usuário é mestre

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

mo

num-registro-

codigo

paginac

currency

pageRecordsNumber

INTEGER

Moeda do aprovador

Número de registros por página

Não

Não se aplica

sigla-moedacurrencyAbbrevCHARACTER Sigla da moeda do usuárioNãoNão se aplicaaprova-autoautomacticApprovalLOGICALIndica se o aprovador aprova automaticamenteNãoNão se aplicaaprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovador

ttCompany					Entrada/Saída
Temp-table com dados de empresas					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
seqGroup		INTEGER	Sequência da empresa	Sim

Não

Não se aplica

cod-estabel

cCode

siteCode

code

CHARACTER Estabelecimento do aprovador

CHARACTER

Código da empresa

Sim

Não

Não se aplica

cod-lotacao

cName

allocationCode

name

CHARACTER Lotação do aprovador

CHARACTER

Nome da empresa

Sim

Não

Não se aplica

libera-verbareleaseAmountLOGICALIndica se o aprovador libera verbaNãoNão se aplicalog-usuar-configconfiguratorUserLOGICALIndice se o aprovador é configurador visual

ttEstablishments					Entrada/Saída
Temp-table com dados de estabelecimentos					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cCode	code	CHARACTER	Código do estabelecimento	Sim

Não

Não se aplica

empresa

cName

companyCode

name

CHARACTER

Empresa

Nome do

aprovador

estabelecimento

Não

Sim	Não se aplica

idioma

cCodeCompany

language

codeCompany

CHARACTER Idioma do aprovador

CHARACTER

Código da empresa

Sim

Não

Não se aplica.

tt-

config-visual

document					Entrada/Saída
Temp-table com dados de

configurações visuais de aprovadores

documentos					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cod-usuar	userCode	CHARACTER	Código do aprovador

Não

Sim	Não se aplica
idi-

ordenacao

interfac

ordination

interface

INTEGER

Ordenação padrão:

Interface (1 -

Mais recentes

Lista / 2

- Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)

- Detalhe)	Sim	Não se aplica
cod-tip-doc	documentCode	INTEGER	Código do documento	Sim	Não se aplica
desc-tip-doc	documentDescription	CHARACTER	Descrição do documento	Não	Não se aplica

log-mostra-todas-empresasallCompanies

layout-padrao

defaultLayout

LOGICAL

Indica apresentação de pendências de todas as empresas

Layout padrão

Não

Não se aplica

log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivo

sigla

shortName

CHARACTER

Sigla do documento

Não

Não se

aplicacdn-tempo-desfundoTimeINTEGERTempo de desfazerNãoNão se aplica

aplica

tt-layout					Entrada/Saída
Temp-table com campos de layout					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cdn-docto		INTEGER	Código do documento	Sim

idi-acao-swip-direrightSwipeActionINTEGER

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não se aplica

idi-acao-swip-esqleftSwipeActionINTEGER

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não

cod-usuar		CHARACTER	Código do aprovador	Sim	Não se aplica
idi-

visualiz-inicialinitialView

interfac

INTEGER

Visualização inicial

Interface (1 -

Todas as pendências

Lista / 2 -

Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre

Detalhe)

Não

Sim	Não se aplica

num

cod-

registro

id-

paginac

campo

pageRecordsNumber

id

INTEGERNúmero de registros por página

CHARACTER

Identificador do campo

Sim

Não

Não se aplica

ttCompany

Entrada/Saída

Temp-table com dados de empresas

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

seqGroup

INTEGER

Sequência da empresa

idi-compon

componentType

INTEGER

Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador)

Sim

Não se aplica

cCodecodeCHARACTERCódigo da empresa

nom-rotu-campo

label

CHARACTER

Rótulo do campo

Não

Sim

Não se aplica

cName

des-campo

name

description

CHARACTER

Descrição do campo

Nome da empresa

Sim

Não se aplica

ttEstablishments

Entrada/Saída

Temp-table com dados de estabelecimentos

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cCodecodeCHARACTERCódigo do estabelecimento

log-visivel	visible	LOGICAL	Visibilidade do campo	Sim	Não se aplica
cdn-tamanho	size	INTEGER	Tamanho do campo	Sim	Não se aplica

cName

cdn-ord

name

INTEGER

CHARACTERNome

Ordem do

estabelecimento

campo

Sim

Não se aplica

cCodeCompanycodeCompanyCHARACTERCódigo da empresa

cod-entid-pai

CHARACTER

Identificação da entidade pai

Não

Sim

Não se aplica

.


Índice: visivel-ordem, log-visivel, cdn-ord

usuar

tt-document-mla-doc-pend-aprov

Entrada/Saída

Temp-table com dados de documentospendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evoluçãocod

nr-

trans

transactionNumber

INTEGER

Número da transação

userCode

CHARACTER

Código do aprovador

Sim

Não se aplica

idi-interfac

interface

INTEGER

Interface (1 - Lista / 2 - Detalhe)

Sim

Não se aplica

cod-tip-doc

documentCodedocumentType

INTEGER

Código do documento

Sim

Não se aplica

desc-tipchave-doc

documentDescriptiondocumentKey

CHARACTER

Descrição Chave do documento

NãoSim

Não se aplica

layoutdt-padraogeracao

defaultLayoutgenerateDate

LOGICAL

Layout padrão

Não

Não se aplica

sigla

shortName

CHARACTER

Sigla do documento

Não

Não se aplica

tt-layout

Entrada/Saída

Temp-table com campos de layout

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cdn-doctoINTEGER

DATE	Data de geração

Código do documento

	Sim	Não se aplica
cod-usuar	approver	CHARACTER	Código do aprovador	Sim	Não se aplica

idi

ind-

interfac

situacao

status

INTEGER

Interface (

Situação da pendência

1 -

Lista /

Pendente

2 -

Detalhe)

Aprovada

3 - Reprovada

4 - Reaprovada

Sim

Não se aplica

cod

ep-

id-campo

codigo

id

company

CHARACTER

Identificador do campo

Empresa

Sim

Não se aplica

idi

cod-

compon

estabel

componentType

site

INTEGERTipo de componente (1 - Campo / 2 - Lista / 3 - Separador)

CHARACTER

Estabelecimento

Sim

Não se aplica

nom-rotu-campolabelCHARACTER Rótulo do campo

tipo

pendencyType

INTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre

Sim

Não

Não se aplica

des

valor-

campo

doc

description

price

CHARACTER

DECIMAL

Descrição

Valor do

campo

documento

SimNão se aplicalog-visivelvisibleLOGICALVisibilidade do campoSimNão se aplicacdn-tamanhosizeINTEGER

tt-fields					Entrada/Saída
Temp-table com informações de campos e valores das pendências					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans		INTEGER	Número da transação

Tamanho do campo

Sim

Não se aplica

cdn

id-

ord

campo

id

INTEGER

CHARACTER

Ordem

ID do campo

Sim

Não se aplica

cod-entid-pai

valor-campo

value

CHARACTER

Identificação da entidade pai

Valor do campo

Sim

Não

Não se aplica

Índice: visivel-ordem, log-visivel, cdn-ordtt-mla-doc-pend-aprov

ttParamPendingApproval				Entrada/Saída
Temp-table com

dados

parâmetros para busca de pendências				Saída
Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-transtransactionNumberINTEGERNúmero da transação

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

Sim

Não se aplica

cod-tip-docdocumentTypeINTEGERCódigo do documento

mainPendencies

LOGICAL

Indica se devem ser apresentadas as pendências principais

Sim

Não se aplica

chave-doc

alternativePendencies

documentKeyCHARACTER Chave do documento

LOGICAL

Indica se devem ser apresentadas as pendências alternativas

Sim

Não se aplica

dt-geracao

masterPendencies

generateDateDATE

LOGICAL

Indica se devem ser apresentadas as pendências como mestre

Data de geração

Sim

Não se aplica

cod-usuar

approver

documents

CHARACTER

Código do aprovador

Documentos a serem considerados (separados por vírgula)

Sim

Não se aplica

ind-situacao

pendingPendencies

statusINTEGER

Situação da pendência

1 - Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

LOGICAL

Indica se devem ser apresentadas pendências "pendentes"

Sim

Não se aplica

ep-codigo

approvedPendencies

companyCHARACTER Empresa

LOGICAL

Indica se devem ser apresentadas pendências "aprovadas"

Sim

Não se aplica

cod-estabel

rejectedPendencies

siteCHARACTER

LOGICAL

Indica se devem ser apresentadas pendências "reprovadas"

Estabelecimento

Sim

Não se aplica

tipo

reApprovedPendencies

pendencyTypeINTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre

LOGICAL

Indica se devem ser apresentadas pendências "reaprovadas"

Sim

Não se aplica

valor-doc

sortType

priceDECIMALValor do documento

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: Estabelicemento
documentType: Documento

Não

tt-fields

Entrada/Saída

Temp-table com informações de campos e valores das pendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-trans

INTEGER

Número da transaçãoSim

Não se aplica

id-campo

pageSize

idCHARACTER ID do campo

INTEGER

Tamanho da página (número de registros retornados). Se não informado será considerado: 20.

Não

Sim

Não se aplica

valor-campo

nextPageRowid

value

ROWID

CHARACTER Valor do campo

Rowid do registro da próxima página

Não

Sim

Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave