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 aprovadordas pendências: pathParams: Informar: getPendingApprovalToList queryParams:
| |||||
oOutput | JsonObject | OUTPUT | Informações das pendências:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
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 erros 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 |
Informações de pendências a serem apresentadas ou erros ocorridos durante a busca. |
pi-query-rejection-options-v1 |
...
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca de códigos de rejeição disponíveis | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para busca dos códigos de rejeição: pathParams: Informar: rejectionOptions.
| |||||
oOutput | JsonObject | OUTPUT | Lista de rejeições:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca dos códigos de rejeição. | |||||
Retorno | Informações dos códigos de rejeição ou erros ocorridos durante a busca. |
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.
| |||||
oOutput | JsonObject | OUTPUT | Informações de layouts e dados da pendência solicitada:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
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-get-detail-historic-pending-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca do histórico de aprovação de uma pendência. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para busca do histórico de aprovação: pathParams: Informar na ordem: detailHistoricPending e o número da transação.
| |||||
oOutput | JsonObject | OUTPUT | Informações de histórico:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de histórico. | |||||
Retorno | Informações dos históricos ou erros ocorridos durante a busca. |
pi-approve-v1
pi-reprove-v1
pi-reapprove-v1
pi-process-pending-v1
Definição de temp-tables:
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â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 |
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-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 (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | |
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (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 |
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 se aplica | |
cCode | code | CHARACTER | Código da empresa | Sim | Não se aplica |
cName | name | CHARACTER | 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 |
cCode | code | CHARACTER | Código do estabelecimento | Sim | Não se aplica |
cName | name | CHARACTER | Nome do estabelecimento | Sim | Não se aplica |
cCodeCompany | codeCompany | CHARACTER | Código da empresa | Sim | Não se aplica. |
tt-document |
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:
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
Sim
Não se aplica
ErrorNumber
Sim
Não se aplica
tt-aprovador
Entrada/Saída
Temp-table com dados dos aprovadores
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
cod-usuar
CHARACTER
Não
Não se aplica
nome-usuar
Não
Não se aplica
Entrada/Saída | |||||
Temp-table com dados de |
documentos | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador |
Sim | Não se aplica |
idi- |
interfac |
interface | INTEGER |
Ordenação padrão:
Interface (1 - |
Lista / 2 - |
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 |
layout-padrao | defaultLayout | 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-docto | INTEGER | Código do documento | Sim |
Ação do swipe (Direito)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)Não se aplica |
Ação do swipe (Esquerdo)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)
cod-usuar | CHARACTER | Código do aprovador | Sim | Não se aplica | |
idi- |
interfac | INTEGER |
Visualização inicial
Interface (1 - |
Lista / 2 - |
Detalhe) |
Sim | Não se aplica |
cod- |
id- |
campo |
id |
CHARACTER | Identificador do campo | Sim |
Não se aplica |
ttCompany
Entrada/Saída
Temp-table com dados de empresas
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
seqGroup
INTEGER
idi-compon | componentType | INTEGER | Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador) | Sim | Não se aplica |
nom-rotu-campo | label | CHARACTER | Rótulo do campo | Não |
Não se aplica |
des-campo |
description |
CHARACTER | Descrição do campo |
Sim | Não se aplica |
log-visivel |
visible |
LOGICAL | Visibilidade do campo |
Sim | Não se aplica |
ttEstablishments
Entrada/Saída
Temp-table com dados de estabelecimentos
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
cdn-tamanho | size | INTEGER | Tamanho do campo |
Sim | Não se aplica |
cdn-ord |
INTEGER |
Ordem do |
campo | Sim | Não se aplica | |||
cod-entid-pai | CHARACTER | Identificação da entidade pai | Não | Não se aplica | |
Índice: visivel-ordem, log-visivel, cdn-ord |
tt-mla-doc-pend-aprov |
tt-document | Entrada/Saída | ||||||||||||||
Temp-table com dados de documentospendências | Saída | ||||||||||||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evoluçãocod | ||||||||||
nr- | usuartrans | 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 | documentDescription | CHARACTER | Descrição do documento | Não | Não se aplica | ||||||||||
layout-padrao | defaultLayout | LOGICAL | Layout padrão | Não | Não se aplica | ||||||||||
documentKey | CHARACTER | Chave | sigla | shortName | CHARACTER | Sigla do documento | NãoSim | Não se aplica |
dt- |
Entrada/Saída
Temp-table com campos de layout
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
geracao | generateDate | DATE | Data de geração |
Sim | Não se aplica | ||||
cod-usuar | approver | CHARACTER | Código do aprovador | Sim | Não se aplica |
ind- |
situacao | status | INTEGER | Situação da pendência |
1 - |
Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada | Sim | Não se aplica | |||
ep-codigo | company | CHARACTER | Empresa | Sim | Não se aplica |
cod- |
estabel |
site | CHARACTER |
Estabelecimento | Sim | Não se aplica |
tipo |
pendencyType | INTEGER | Tipo |
1 - |
Principal 2 - |
Alternativa 3 - |
Mestre | Sim | Não se aplica |
valor- |
doc |
price |
DECIMAL |
Valor do |
documento |
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 |
Sim | Não se aplica |
id- |
campo | id |
CHARACTER |
ID do campo | Sim | Não se aplica |
valor-campo | value | CHARACTER |
Valor do campo | Sim |
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
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 |
cod-usuar
CHARACTER
Não se aplica |
finalGenerationDate |
Situação da pendência
1 - Pendente
2 - Aprovada
3 - Reprovada
4 - Reaprovada
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 |
Tipo
1 - Principal
2 - Alternativa
3 - MestreLOGICAL | 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" |
tt-fields
Entrada/Saída
Temp-table com informações de campos e valores das pendências
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
nr-trans
INTEGER
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 |
ttParamPendingApproval
Entrada/Saída
Temp-table com parâmetros para busca de pendências
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
CHARACTER | Ordenação: Opções possíveis (se não informado será utilizado: -generationDate):
| 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 |
ttRejectionCode |
Entrada/Saída | |||||
Temp-table com informações de códigos de rejeição | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
iCodRejeita | code | INTEGER | Código de rejeição |
Sim | Não se aplica | |
cCodRejeita |
description | CHARACTER |
Descrição | Sim | Não se aplica |
obriga-narrativa |
reasonIsRequired | LOGICAL | Indica se |
o código de rejeição obriga narrativa | Sim | 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çã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 |
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
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 |
Rowid do registro da próxima página
Não se aplica |