Histórico da Página
...
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:
| |||||
oOutput | JsonObject | OUTPUT | Informações da re-aprovação:
| |||||
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-query-attachments-v2 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Retorna a lista de anexos disponíveis para determinado documento. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para retornar a lista de anexos: pathParams: Informar: attachments e o número da transação
| |||||
oOutput | JsonObject | OUTPUT | listagem dos anexos do documento:
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 na busca dos anexos do documento. | |||||
Retorno | Informação de sucesso ou erros ocorridos no processo de criação da listagem dos anexos. |
pi-get-attach-content-v2 | ||||
Requisito | Nenhum. | |||
Descrição | Retorna |
objeto com o conteúdo do anexo de um determinado documento. | |||
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para retornar |
o conteúdo do anexo: pathParams: Informar: |
|
| ||
oOutput | JsonObject | OUTPUT |
Objeto com o conteúdo do anexo solicitado:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Retorno
Informação de sucesso ou erros ocorridos no processo de criação da listagem dos anexos.
Requisito
Nenhum.
Descrição
Realiza a aprovação, reprovação ou re-aprovação de pendências.
Parâmetros
Tipo
Descrição
Ação
1 - Aprovação
2 - Reprovação
3 - Reaprovação
Retorno
Informação de sucesso ou erros ocorridos no processamento das pendências.
Definição de temp-tables:
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 na busca do conteúdo do anexo de determinado documento. | |
Retorno | Informação de sucesso ou erros ocorridos no processo de consulta ao conteúdo do anexo. |
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:
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 |
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
Entrada/Saída | |||||
Temp-table com dados |
de configurações visuais de aprovadores | Saída | ||||
Atributo |
Tipo
Descrição
Obrigatório
Evolução
cod-usuar
CHARACTER
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 |
nome-usuar
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 de deslizar (Direita) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | |
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação de deslizar (Esquerda) (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 | 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:
(1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)
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 de deslizar (Direita)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)Não se aplica |
Ação de deslizar (Esquerda)
(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 |
ttCompany
Entrada/Saída
Temp-table com dados de empresas
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
seqGroup
INTEGER
cod-id-campo | id | CHARACTER | Identificador do campo | Sim | Não se aplica |
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 |
ttEstablishments
Entrada/Saída
Temp-table com dados de estabelecimentos
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
log-visivel | visible | LOGICAL | Visibilidade do campo | Sim | Não se aplica |
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 | ||||||||||
descchave-tip-doc | documentDescriptiondocumentKey | CHARACTER | Descrição Chave do documento | NãoSim | Não se aplica | ||||||||||
layoutdt-padraogeracao | defaultLayoutgenerateDate | LOGICAL | Layout padrão | DATE | Data de geração | SimNão | Não se aplicasigla | ||||||||
cod-usuar | shortNameapproverCHARACTER | CHARACTER | Sigla Código do | documentoaprovador | NãoSim | Não se aplica |
ind- |
Temp-table com campos de layout
Saída
Atributo
Tipo
Descrição
Obrigatório
Evolução
situacao |
Entrada/Saída
status | INTEGER | Situação da pendência 1 - Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada |
Sim | Não se aplica |
cod-usuar
CHARACTER
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 |
tt-mla-doc-pend-aprov
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 |
CHARACTER
Sim
DATE | Data de geração final | Não | Não se aplica |
mainPendencies |
Situação da pendência
1 - Pendente
2 - Aprovada
3 - Reprovada
4 - Reaprovada
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 |
Tipo
1 - Principal
2 - Alternativa
3 - MestreCHARACTER | 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" |
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 |
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):
| |||||
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 | |
establishmentpageSize | CHARACTER | INTEGER | Tamanho da página (número de registros retornados). Se não informado será considerado: 20.Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos | Não | Não se aplica |
initialGenerationDatenextPageRowid | DATE | ROWID | Rowid do registro da próxima página Data de geração inicial | Não | Não se aplicafinalGenerationDate |
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 aprovaçã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 |
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: Estabelecimento
- documentType: Documento
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 |
Rowid do registro da próxima página
situacao | status | INTEGER | Situação 1 - Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada | Sim |
Não se aplica |
ttRejectionCodettTransactions | Entrada/Saída | ||||
Temp-table com informações números de códigos transações de rejeiçãopendências | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | EvoluçãoiCodRejeita |
nr-trans | codetransactionNumber | INTEGER Código de rejeição | Número da transaçã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 |
tt-anexo | Entrada/Saída | ||||
Temp-table com |
a lista de anexos. Possui as informações de identificação do arquivo, sem o seu conteúdo. | 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 |
id |
internalId |
CHARACTER |
Id interno do anexo | Sim | Não se aplica |
nome |
name |
CHARACTER |
Nome do |
anexo | Sim | Não se aplica |
descricao |
description |
CHARACTER |
Descrição do |
anexo |
Não | Não se aplica |
dt-hra- |
criacao |
creationDatetime |
DATETIME | Data |
e hora de criação do anexo | Não |
Não se aplica |
Situação
1 - Pendente
2 - Aprovada
3 - Reprovada
4 - Reaprovada
grupo | group | CHARACTER | Grupo de ordenação ao qual o anexo pertence | Não |
Não se aplica |
tt-anexo-conteudo | Entrada/Saída | ||||
Temp-table com |
as informações do conteúdo do anexo. | 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 |
id | internalId | CHARACTER | Id interno do anexo | Sim | Não se aplica |
nome | name | CHARACTER | Nome do anexo | Não | Não se aplica |
tipo-conteudo | contentType | CHARACTER | Tipo do conteúdo usado para a abertura do arquivo | Não | Não se aplica |
conteudo | content | CLOB | Conteúdo do arquivo em Base64 | Sim | Não se aplica |