Histórico da Página

...

pi-get-defaults-v1

Requisito

Nenhum.

Descrição

Retorna dados principais para carregamento inicial do APP: empresas, estabelecimentos e documentos do aprovador com seus layouts.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do aprovadordos dados iniciais:

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

queryParams → expand: Utilizando este parâmetro com as opções abaixo permite retornar também as informações de:

visualConfigurations: Configurações Visuais
groupCompanies: Grupo de empresas
documents: Documentos
documents.fields: Componentes de cada docmento
establishments: Estabelecimentos

Bloco de código

title	Exemplo

{
    "queryParams": {
    "expand": [     "visualConfigurations,groupsCompanies,documents,documents.fields,establishments"
    ]
  },
    "pathParams": [
       "getDefaults",
       "super"
    ],
}

oOutput

JsonObject

OUTPUT

Informações iniciais para o APP:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "userCode": "super",
        "userName": "Super Usuário",
        "eMail": "",
        "sendEmail": true,
        "receiveEmail": true,
        "masterUser": false,
        "currency": 0,
        "currencyAbbrev": "R$",
        "automaticApproval": true,
        "automaticApprovalApprover": true,
        "siteCode": "1",
        "allocationCode": "10702",
        "releaseAmount": false,
        "configuratorUser": true,
        "companyCode": "10",
        "language": "pt",
        "_expandables": [
          "visualConfigurations",
          "groupsCompanies",
          "documents",
          "documents.fields",
          "establishments"
        ],
        "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ],
        "groupsCompanies": [
          {
            "sequence": 1,
            "name": "Grupo de Empresas 1",
            "companies": [
              {
                "code": "002",
                "name": "TOTVS SA - E-kanban"
              },
              {
                "code": "10",
                "name": "10 TOTVS S.A"
              },
              {
                "code": "11",
                "name": "TOTVS"
              }
           }
         ],
         "documents": [
          {
            "documentCode": 1,
            "documentDescription": "Solicitação de Compra - Item",
            "defaultLayout": false,
            "shortName": "SC",
            "fields": [
              {
                "id": "doc-nr-requisicao",
                "componentType": 1,
                "label": "",
                "description": "Número da Solicitação de Compra",
                "visible": true,
                "size": 100
              },
              {
                "id": "pend-valor-doc",
                "componentType": 1,
                "label": "",
                "description": "Valor da Pendência de Aprovação",
                "visible": true,
                "size": 100
              }
            ]
          },
          {
            "documentCode": 5,
            "documentDescription": "Cotação de Materiais",
            "defaultLayout": false,
            "shortName": "CO",
            "fields": [
              {
                "id": "pend-chave-doc",
                "componentType": 1,
                "label": "Chave",
                "description": "Chave do Documento da Pendência de Aprovação",
                "visible": true,
                "size": 100
              },
              {
                "id": "pend-valor-doc",
                "componentType": 1,
                "label": "Valor",
                "description": "Valor da Pendência de Aprovação",
                "visible": true,
                "size": 100
              }
            ]
          }
        ],
        "establishments": [
          {
            "code": "A1",
            "name": "Estabelecimento TOTVS",
            "codeCompany": "10"
          },
          {
            "code": "10000",
            "name": "Estab 10000",
            "codeCompany": "10"
          }
         ]         
      }
    ]
  }
}

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

tt-aprovador: contém as informações principais do aprovador
tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário.
groupsCompanies:
- sequencia: sequência do grupo de empresa;
- name: Nome do grupo de empresa;
- ttCompany (companies): contém informações de empresas
tt-document (documents): contém informações dos documentos
- tt-layout (fields): contém informações de campos do layout de documento
ttEstablishments (establishments): contém informações dos estabelecimentos

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos dados

Retorno

Dados principais para inicialização do APP ou erros ocorridos durante o processo de busca.

pi-get-document-abrev
Requisito	Nenhum.
Descrição	Retorna a sigla do documento
	Parâmetros	Tipo	Input/Output	Descrição
	piDocumentCode	INTEGER	INPUT	Código do documento
	pcDocumentDescription	CHARACTER	INPUT	Descrição do documento
	pcSigla	CHARACTER	OUTPUT	Sigla do documento
Retorno	Sigla do documento.

pi-validate-user-info-v1

pi-query-app-list-v1

pi-query-pending-approval

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:

Requisito

Nenhum.

Descrição

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

Se é aprovador;
Se possui algum documento configurado para aprovação;
Se 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-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 das pendências:

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çã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ências "reprovadas"
reApprovedPendencies: Indica se devem ser apresentadas pendências "reaprovadas"
order: 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
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 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.

Bloco de código

title	Exemplo

{
    "pathParams": [
    "rejectionOptions"
  ],
}

oOutput

JsonObject

OUTPUT

Lista de rejeições:

Bloco de código

title	Exemplo

{
  "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

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-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

title	Exemplo

{
    "pathParams": [
       "detailHistoricPending",
       "89469"
    ],
}

oOutput

JsonObject

OUTPUT

Informações de histórico:

Bloco de código

title	Exemplo

{
  "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-approve-v1

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

title	Exemplo

{
    "pathParams": [
       "approve"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
       ],
       "approveText": "Aprovada!"
    },
}

oOutput

JsonObject

OUTPUT

Informações da 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 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

title	Exemplo

{
    "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

title	Exemplo

{
  "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

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-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

title	Exemplo

{
    "pathParams": [
    "attachments",
    "19308"
  ],
}

oOutput

JsonObject

OUTPUT

listagem dos anexos do documento:

Bloco de código

title	Exemplo

{
    "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

title	Exemplo

{
    "pathParams": [
    "attachmentContent",
    "412297",
	"2"
  ],
}

oOutput

JsonObject

OUTPUT

Objeto com o conteúdo do anexo solicitado:

Bloco de código

title	Exemplo

{    
    "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.

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	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	Não se aplica
cod-usuar		CHARACTER	Código do aprovador	Sim	Não se aplica
idi-interfac		INTEGER	Interface (1 - Lista / 2 - Detalhe)	Sim	Não se aplica
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
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

RowErrors

					Entrada/Saída
Temp-table com dados

dos erros ocorridos durante o processo

de pendências					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

ErrorSequence

INTEGER

Número da sequência do erro

nr-trans

transactionNumber

INTEGER

Número da transação

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplicaErrorParametersCHARACTER Parâmentros da mensagem de erro


cod-tip-doc	documentType	INTEGER	Código do documento	Sim	Não se aplica
chave-doc

ErrorType

documentKey

CHARACTER

Tipo

Chave do

erro

documento	Sim	Não se aplica
dt-geracao

ErrorHelp

generateDate

CHARACTER

DATE

Texto de ajuda da mensagem de erro

Data de geração	Sim	Não se aplica
cod-usuar

ErrorSubType

approver

CHARACTER

Subtipo

Código do

erro

aprovador

Sim

Não se aplica

tt

ind-

aprovador

situacao

Entrada/Saída

status

INTEGER

Situação da pendência

1 - Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

Sim

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 aprovadorNão

Não se aplica

nome

ep-

usuar

codigo

userName

company

CHARACTER

Nome do aprovador

Empresa

Não

Sim	Não se aplica

e

cod-

mail

estabel

eMail

site

CHARACTER

E-mail do aprovador

Estabelecimento

Sim

Não

Não se aplica

envia-emailsendEmailLOGICALIndica se envia e-mail

tipo

pendencyType

INTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre

Sim

Não

Não se aplica

recebe

valor-

email

doc

price

receiveEmail

DECIMAL

LOGICALIndica se recebe e-mailNãoNão se aplicausuar-mestremasterUserLOGICALIndica se o usuário é mestreNãoNão se aplica

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

mo-codigocurrencyINTEGERMoeda do aprovadorNão

Não se aplica

sigla

id-

moeda

campo

currencyAbbrev

id

CHARACTER

Sigla da moeda

ID do

usuário

campo

Não

Sim	Não se aplica

aprova

valor-

auto

campo

automacticApproval

value

LOGICALIndica se o aprovador aprova automaticamente

CHARACTER

Valor do campo

Sim

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

aprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovadorNãoNão se aplicacod-estabelsiteCodeCHARACTER Estabelecimento do aprovador

Não

Não se aplica

cod-lotacao

establishment

allocationCode

CHARACTER

Lotação do aprovador

Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos

Não

Não se aplica

libera-verba

initialGenerationDate

releaseAmountLOGICALIndica se o aprovador libera verba

DATE

Data de geração inicial

Não

Não se aplica

log-usuar-configconfiguratorUserLOGICALIndice se o aprovador é configurador visual

finalGenerationDate

DATE

Data de geração final

Não

Não se aplica

empresa

mainPendencies

companyCodeCHARACTER Empresa do aprovador

LOGICAL

Indica se devem ser apresentadas as pendências principais

Sim

Não

Não se aplica

idioma

alternativePendencies

languageCHARACTER Idioma do aprovador

LOGICAL

Indica se devem ser apresentadas as pendências alternativas

Sim

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

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

cod-usuar

CHARACTER

Código do aprovadorNão

Não se aplica

idi-ordenacao

pendingPendencies

ordinationINTEGER

Ordenação padrão:

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

LOGICAL

Indica se devem ser apresentadas pendências "pendentes"

Sim

Não

Não se aplica

log-mostra-todas-empresasallCompanies

approvedPendencies

LOGICAL

Indica

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

se devem ser apresentadas pendências "aprovadas"

Sim

Não

Não se aplica

log-aprova-sem-motivapproveWithoutReason

rejectedPendencies

LOGICAL

Indica

aprovação sem informar motivo

se devem ser apresentadas pendências "reprovadas"

Sim

Não

Não se aplica

cdn-tempo-desfundoTimeINTEGERTempo de desfazer

reApprovedPendencies

LOGICAL

Indica se devem ser apresentadas pendências "reaprovadas"

Sim

Não

Não se aplica

idi-acao-swip-direrightSwipeActionINTEGER

Ação do swipe (Direito)

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

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

idi-acao-swip-esqleftSwipeActionINTEGER

Ação do swipe (Esquerdo)

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

Não

Não se aplica

idi-visualiz-inicial

pageSize

INTEGER

Visualização inicial

(1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)

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

Não

Não se aplica

num-registro-paginacpageRecordsNumberINTEGERNúmero de registros por

nextPageRowid

ROWID

Rowid do registro da próxima página

Não

Não se aplica

ttCompany

ttRejectionCode					Entrada/Saída
Temp-table com

dados

informações de códigos de

empresas

rejeição					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

seqGroup

iCodRejeita

code

INTEGER

Sequência da empresa

Código de rejeição

Sim

Não se aplica

cCode

cCodRejeita

code

description

CHARACTER

Código da empresa

Descrição

Sim

Não se aplica

cName

obriga-narrativa

name

reasonIsRequired

CHARACTER

LOGICAL

Indica se o código de rejeição obriga narrativa

Nome da empresa

Sim

Não se aplica

ttEstablishments

ttHistoricPending					Entrada/Saída
Temp-table com

dados

informações dos históricos de

estabelecimentos

aprovação					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

cCode

nivel

codeCHARACTERCódigo do estabelecimento

INTEGER

Nível de aprovação

Sim

Não se aplica

cName

desc-nivel

name

approveType

CHARACTER

Nome

Descrição do

estabelecimento

nível de aprovação

Sim

Não se aplica

cCodeCompany

cod-aprovador

codeCompany

approverCode

CHARACTER

Código

da empresa

do aprovador

Sim

Não se aplica

.

tt

nome-

document

aprovador

Entrada/Saída

approverDescription	CHARACTER	Nome do aprovador	Sim	Não se aplica
data-aprovacao	approveDate	DATE	Data da aprovação

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

hora-

interfac

aprovacao

interface

approveHour

INTEGERInterface (1 - Lista / 2 - Detalhe)

CHARACTER

Hora da aprovação

Sim

Não se aplica

cod-tip-docdocumentCodeINTEGERCódigo do documento

narrativa

text

CHARACTER

Narrativa

Sim

Não se aplica

desc-tip-docdocumentDescriptionCHARACTER Descrição do documento

situacao

status

INTEGER

Situação

1 - Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

Sim

Não

Não se aplica

layout-padraodefaultLayoutLOGICALLayout padrãoNãoNão se aplicasiglashortNameCHARACTERSigla do documento

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

Não se aplica

tt-

layout

anexo					Entrada/Saída
Temp-table com

campos de layout

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

cdn

nr-

docto

trans

transactionNumber

INTEGER

Código do documento

	Número da transação	Sim	Não se aplica
id	internalId	CHARACTER	Id interno do anexo	Sim	Não se aplica
nome

cod-usuar

name

CHARACTER

Código

Nome do

aprovador

anexo	Sim	Não se aplica
descricao

idi-interfac

description

INTEGERInterface (1 - Lista / 2 - Detalhe)

CHARACTER

Descrição do anexo

Não

Sim

Não se aplica

cod

dt-

id

hra-

campo

criacao

id

creationDatetime

CHARACTER Identificador do campo

DATETIME

Data e hora de criação do anexo

Não

Sim

Não se aplica

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

grupo

group

CHARACTER

Grupo de ordenação ao qual o anexo pertence

Não

Sim

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

nom-rotu-campolabelCHARACTER Rótulo do campoNãoNão se aplicades-campodescriptionCHARACTER Descrição do campo

Sim

Não se aplica

log-visivel

id

visible

internalId

LOGICAL

CHARACTER

Visibilidade

Id interno do

campo

anexo

Sim

Não se aplica

cdn-tamanho

nome

size

name

INTEGER

CHARACTER

Tamanho

Nome do

campo

anexo

Sim

Não	Não se aplica

cdn

tipo-

ord

conteudo

contentType

INTEGEROrdem do campo

CHARACTER

Tipo do conteúdo usado para a abertura do arquivo

Não

Sim

Não se aplica

cod-entid-paiCHARACTER Identificação da entidade pai


conteudo	content	CLOB	Conteúdo do arquivo em Base64	Sim

Não

Não se aplica

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

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave