...
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 |
---|
| {
"pathParams": [
"validateUserInfo",
"super"
],
} |
|
oOutput | JsonObject | OUTPUT | Campo indicando se o usuário está válido:
Bloco de código |
---|
| {
"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-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.
Bloco de código |
---|
| {
"pathParams": [
"rejectionOptions"
],
} |
|
oOutput | JsonObject | OUTPUT | Lista de rejeições:
Bloco de código |
---|
| {
"status": 200,
"payload": {
"total": 3,
"hasNext": false,
"items": [
{
"code": 6,
"description": "Rejeição comum",
"reasonIsRequired": true
},
{
"code": 7,
"description": "Pedido suspenso",
"reasonIsRequired": true
},
{
"code": 8,
"description": "Rejeição sem narrativa",
"reasonIsRequired": false
}
]
}
} |
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: - ttRejectionCode : contém as informações dos códigos de rejeiçã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.
Bloco de código |
---|
| {
"pathParams": [
"detailPending",
"90667"
],
} |
|
oOutput | JsonObject | OUTPUT | Informações de layouts e dados da pendência solicitada:
Bloco de código |
---|
| {
"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-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.
Bloco de código |
---|
| {
"pathParams": [
"detailHistoricPending",
"89469"
],
} |
|
oOutput | JsonObject | OUTPUT | Informações de histórico:
Bloco de código |
---|
| {
"status": 200,
"payload": {
"total": 1,
"hasNext": false,
"items": [
{
"approveType": "Faixa",
"approverCode": "super",
"approverDescription": "Super Usuario",
"approveDate": "2021-03-29",
"approveHour": "18:06:13",
"text": "Pendência aprovada!",
"status": 4
}
]
}
} |
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: - ttHistoricPending: contém as informações dos históricos de aprovaçã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-reprove-v1
pi-reapprove-v1
pi-process-pending-v1
Definição de temp-tables:
Requisito | Nenhum. |
Descrição | Realiza a aprovação de pendência(s). |
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para aprovação de pendência(s): pathParams: Informar: approve 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 |
---|
| {
"pathParams": [
"approve"
],
"payload": {
"transactions": [
{
"transactionNumber": 90390
}
],
"approveText": "Aprovada!"
},
} |
|
oOutput | JsonObject | OUTPUT | Informações da aprovação:
Bloco de código |
---|
| {
"status": 200,
"payload": {
"sucessProcess": true
}
} |
|
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a aprovação das pendências. |
Retorno | Informação de sucesso ou erros ocorridos no processo de aprovação. |
pi-reprove-v1 |
Requisito | Nenhum. |
Descrição | Realiza a reprovação de pendência(s). |
Parâmetros | Tipo | Input/Output | Descrição |
oInput | JsonObject | INPUT | Parâmetros para reprovação de pendência(s): pathParams: Informar: reprove payload: - transactions: Transações de pendências que devem ser reprovadas (pode ser uma ou várias):
- transactionNumber: Número da transação
- reproveText: Comentário da reprovação
- rejectCode: Código de rejeição
Bloco de código |
---|
| {
"pathParams": [
"reprove"
],
"payload": {
"transactions": [
{
"transactionNumber": 90390
}
],
"reproveText": "Reprovada por falta de orçamento",
"rejectCode": 8
},
} |
|
oOutput | JsonObject | OUTPUT | Informações da reprovação:
Bloco de código |
---|
| {
"status": 500,
"payload": {
"sucessProcess": false,
"errors": {
"errorMessage": [
{
"code": 2609,
"message": "Código de rejeição não cadastrado",
"detailedMessage": ".\n",
"type": "ERROR"
}
]
}
}
} |
|
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a reprovação das pendências. |
Retorno | Informação de sucesso ou erros ocorridos no processo de reprovação. |
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 |
---|
| {
"pathParams": [
"reapprove"
],
"payload": {
"transactions": [
{
"transactionNumber": 90390
}
],
"approveText": "Re-aprovada!"
},
} |
|
oOutput | JsonObject | OUTPUT | Informações da re-aprovação:
Bloco de código |
---|
| {
"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-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
Bloco de código |
---|
| {
"pathParams": [
"attachments",
"19308"
],
} |
|
oOutput | JsonObject | OUTPUT | listagem dos anexos do documento:
Bloco de código |
---|
| {
"payload": {
"total": 3,
"hasNext": false,
"items": [
{
"internalId": "1",
"transactionNumber": "412297",
"name": "arquivo1.png",
"description": "anexo de teste",
"creationDatetime": "2020-02-01T08:00:00.000",
"group": ""
},
{
"internalId": "2",
"transactionNumber": "412297",
"name": "arquivo2.pdf",
"description": "anexo de teste 2",
"creationDatetime": "2022-02-01T08:00:00.000",
"group": "teste"
},
{
"internalId": "3",
"transactionNumber": "412297",
"name": "arquivo3.doc",
"description": "anexo de teste 3",
"creationDatetime": "2022-05-13T08:00:00.000",
"group": "teste3"
}
]
},
"status": 200
} |
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: - tt-anexo: contém a lista de anexos com as informações de identificação do arquivo, sem o seu conteúdo.
|
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: - attachmentContent
- número da transação
- número do ID do anexo
Bloco de código |
---|
| {
"pathParams": [
"attachmentContent",
"412297",
"2"
],
} |
|
oOutput | JsonObject | OUTPUT | Objeto com o conteúdo do anexo solicitado:
Bloco de código |
---|
| {
"internalId": 1,
"transactionNumber": 412297,
"name": "arquivo1.png",
"contentType": "image/png",
"content": "iVBORw0KGgoAAAANSUhEUgAAAMkAAADJCAYAAAH+wSaTAAAAAXNSR0IArs4c6QAAAARnQU1BAA"
} |
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: - tt-anexo-conteudo: contém as informações de conteúdo do anexo consultado.
|
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 |
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-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 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. |
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 |
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-config-visual | Entrada/Saída |
Temp-table com dados de |
configurações visuais de aprovadoresdocumentos | Saída |
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador |
NãoordenacaoordinationOrdenação padrão:
Mais recentes Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)Nãologmostratodas-empresasallCompaniesLOGICAL | Indica apresentação de pendências de todas as empresas | INTEGER | Código do documento | Sim |
Nãologaprovasem-motivapproveWithoutReasonLOGICAL | Indica aprovação sem informar motivoCHARACTER | Descrição do documento | Não | Não se aplica |
cdntempo-desfundoTimeINTEGER | Tempo de desfazerLOGICAL | Layout padrão | Não | Não se aplica |
idi-acao-swip-dire | rightSwipeAction | INTEGER | sigla | shortName | CHARACTER | Sigla do documento | Não |
Ação do swipe (Direito)
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) |
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 | Não se aplica |
cod-usuar |
| CHARACTER | Código do aprovador | Sim |
Nãovisualiz-inicialinitialViewVisualização inicial
Todas as pendências Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestreNãonumregistropaginacpageRecordsNumberINTEGER | Número de registros por página | CHARACTER | Identificador do campo | Sim |
NãottCompany | 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 empresaidi-compon | componentType | INTEGER | Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador) | Sim | Não se aplica |
cCode | code | CHARACTER | Código da empresa | nom-rotu-campo | label | CHARACTER | Rótulo do campo | Não |
SimcNamenameCHARACTER | CHARACTER | Descrição do campo |
Nome da empresattEstablishments | 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 estabelecimentolog-visivel | visible | LOGICAL | Visibilidade do campo | Sim | Não se aplica |
cdn-tamanho | size | INTEGER | Tamanho do campo | Sim | Não se aplica |
cNamenameCHARACTER | Nome estabelecimentocCodeCompany | codeCompany | CHARACTER | Código da empresa | cod-entid-pai |
| CHARACTER | Identificação da entidade pai | Não |
Sim. |
Índice: visivel-ordem, log-visivel, cdn-ord |
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- | usuartrans | userCode | CHARACTER | Código do aprovador | Sim | Não se aplica | transactionNumber | INTEGER | Número da transação | 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 | 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 |
ttlayoutEntrada/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 | 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 |
idiinterfacInterface ( Lista / 2 - Detalhe)Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada | Sim | Não se aplica |
ep-codigo | company | CHARACTER | Empresa | Sim | Não se aplica |
cod- |
id-campoidIdentificador do campoEstabelecimento | Sim | Não se aplica |
idi-componcomponentType de componente ( Campo / Lista / Separador)nomrotu-campolabelCHARACTER Rótulo campoNão | Não se aplica | des-campo | description | CHARACTER | Descrição do campo | Sim | Não se aplica |
log-visivel | visible | LOGICAL |
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 |
Visibilidade do campocdn-tamanho | size | INTEGER | Tamanho do SimNão se aplica | cdn-ord | INTEGER | Ordem CHARACTER | ID do campo | Sim | Não se aplica |
cod-entid-paivalor-campo | value | CHARACTER |
Identificação da entidade pai | NãoÍndice: visivel-ordem, log-visivel, cdn-ord |
tt-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-transtransactionNumber | INTEGER | Número da transação | Sim | CHARACTER | Empresa, se deixar em branco serão consideradas todas as empresas | Não | Não se aplica |
cod-tip-doc | documentType | INTEGER | Código do documento | Sim | establishment | CHARACTER | Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos | Não | Não se aplica |
chave-docdocumentKey | CHARACTER | Chave do documento | DATE | Data de geração inicial | Não |
Simdt-geracao | generateDatefinalGenerationDate | 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 |
cod-usuarapprover | CHARACTER | Código do aprovador | LOGICAL | Indica se devem ser apresentadas as pendências alternativas | Sim | Não se aplica |
ind-situacaostatus | INTEGER | Situação da pendência
1 - Pendente
2 - Aprovada
3 - Reprovada
4 - ReaprovadaLOGICAL | 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 |
ep-codigocompany | CHARACTER | Empresa | LOGICAL | Indica se devem ser apresentadas pendências "pendentes" | Sim | Não se aplica |
cod-estabelsite | CHARACTER | LOGICAL | Indica se devem ser apresentadas pendências "aprovadas" |
Estabelecimento | Sim | Não se aplica |
rejectedPendencies |
tipo | pendencyType | INTEGER | Tipo
1 - Principal
2 - Alternativa
3 - MestreLOGICAL | 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 |
valor-docprice | DECIMAL | Valor 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: Estabelecimento
- 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ção | Simid-campoid | CHARACTER | ID do campo | INTEGER | Tamanho da página (número de registros retornados). Se não informado será considerado: 20. | Não |
Simvalor-campovalueCHARACTER | Valor do campo | Rowid do registro da próxima página | Não |
Sim | Não se aplica | ttParamPendingApproval
ttRejectionCode | Entrada/Saída |
Temp-table com |
parâmetros para busca de pendênciasinformações de códigos de rejeição | Saída |
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
iCodRejeita |
companyCHARACTER | Empresa, se deixar em branco serão consideradas todas as empresas | INTEGER | Código de rejeição | Sim |
NãoestablishmentEstabelecimento, se deixar em branco serão considerados todos os estabelecimentos | NãoinitialGenerationDate | DATE | Data de geração inicial | obriga-narrativa | reasonIsRequired | LOGICAL | Indica se o código de rejeição obriga narrativa | Sim |
NãofinalGenerationDate
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 alternativasEntrada/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 |
masterPendenciesLOGICAL | Indica se devem ser apresentadas as pendências como mestreCHARACTER | Descrição do nível de aprovação | Sim | Não se aplica |
documentscod-aprovador | approverCode | CHARACTER |
Documentos a serem considerados (separados por vírgula)Código do aprovador | Sim | Não se aplica |
pendingPendencies | LOGICAL | Indica se devem ser apresentadas pendências "pendentes"nome-aprovador | approverDescription | CHARACTER | Nome do aprovador | Sim | Não se aplica |
data-aprovacao |
approvedPendenciesLOGICAL | Indica se devem ser apresentadas pendências "aprovadas"DATE | Data da aprovação | Sim | Não se aplica |
rejectedPendenciesLOGICAL | Indica se devem ser apresentadas pendências "reprovadas"approveHour | CHARACTER | Hora da aprovação | Sim | Não se aplica |
narrativa |
reApprovedPendenciesLOGICAL | Indica se devem ser apresentadas pendências "reaprovadas"CHARACTER | Narrativa | 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: Estabelicemento
- 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 |
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 |
ttRejectionCode | Entrada/Saída |
Temp-table com |
informações de códigos de rejeiçãoa 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 |
iCodRejeitacodeCódigo de rejeiçãoNúmero da transação | Sim | Não se aplica |
cCodRejeitadescriptionCHARACTER | CHARACTER | Id interno do anexo |
Descriçãoobriga-narrativareasonIsRequiredLOGICAL | Indica se o código de rejeição obriga narrativaCHARACTER | Nome do anexo | Sim | Não se aplica |
ttHistoricPendingEntrada/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 |
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 |
nivel | INTEGER | Nível de parovação | Simdesc-nivel | approveType | CHARACTER | Descrição do nível de aprovação | grupo | group | CHARACTER | Grupo de ordenação ao qual o anexo pertence | Não |
Simcod-aprovador | approverCode | CHARACTER | Código do aprovador | Sim | Não se aplica |
nome-aprovador | approverDescription | CHARACTER | Nome do aprovador 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 |
data-aprovacaoapproveDateDATE | Data da aprovaçãoCHARACTER | Id interno do anexo | Sim | Não se aplica |
hora-aprovacaoapproveHourCHARACTER | Hora da aprovação | CHARACTER | Nome do anexo | Não |
SimnarrativatextCHARACTER | Narrativa | CHARACTER | Tipo do conteúdo usado para a abertura do arquivo | Não |
SimsituacaostatusINTEGER | Situação
1 - Pendente
2 - Aprovada
3 - Reprovada
4 - ReaprovadaCLOB | Conteúdo do arquivo em Base64 | Sim | Não se aplica |