Histórico da Página

...

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

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

Sigla do documento

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

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

seqGroup

INTEGER

Número da sequência do erro

	INTEGER	Sequência da empresa	Sim	Não se aplica
cCode

ErrorNumber

code

INTEGER

CHARACTER

Código

do erro

da empresa

Sim

Não se aplica

ErrorDescription

cName

name

CHARACTER

Nome da empresa

Descrição do erro

Sim

Não se aplica

ErrorParameters

ttEstablishments

CHARACTER Parâmetros da mensagem de erro SimNão se aplicaErrorTypeCHARACTER Tipo do erro

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

ErrorHelp

cName

name

CHARACTER Texto de ajuda da mensagem de erro

CHARACTER	Nome do estabelecimento	Sim	Não se aplica
cCodeCompany

ErrorSubType

codeCompany

CHARACTER

Subtipo do erro

Código da empresa

Sim

Não se aplica.

tt-

aprovador

document					Entrada/Saída
Temp-table com dados

dos aprovadores

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

Não

Sim	Não se aplica

nome

idi-

usuar

interfac

userName

interface

CHARACTER Nome do aprovador

Não

Não se aplica

e-maileMailCHARACTER E-mail do aprovadorNãoNão se aplicaenvia-emailsendEmailLOGICALIndica se envia e-mailNãoNão se aplicarecebe-emailreceiveEmailLOGICALIndica se recebe e-mailNãoNão se aplicausuar-mestremasterUserLOGICALIndica se o usuário é mestre

INTEGER

Interface (1 - Lista / 2 - Detalhe)

Sim

Não

Não se aplica

mo

cod-tip-

codigo

doc

currency

documentCode

INTEGER

Moeda

Código do

aprovador

documento

Não

Sim	Não se aplica

sigla

desc-tip-

moeda

doc

currencyAbbrev

documentDescription

CHARACTER

Sigla da moeda

Descrição do

usuário

documento

Não

Não se aplica

aprova

layout-

auto

padrao

automacticApproval

defaultLayout

LOGICAL

Indica se o aprovador aprova automaticamente

Layout padrão

Não

Não se aplica

aprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovador

sigla

shortName

CHARACTER

Sigla do documento

Não

Não se aplica

cod-estabelsiteCodeCHARACTER Estabelecimento do aprovador

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

	Não se aplica
cod-

lotacao

usuar

allocationCode

CHARACTER

Lotação

Código do aprovador

Não

Sim	Não se aplica

libera

idi-

verba

interfac

releaseAmountLOGICALIndica se o aprovador libera verbaNão

INTEGER

Interface (1 - Lista / 2 - Detalhe)

Sim

Não

se aplica

log

cod-

usuar

id-

config

campo

configuratorUser

id

LOGICALIndica se o aprovador é configurador visual

CHARACTER

Identificador do campo

Sim

Não

Não se aplica

empresa

idi-compon

companyCode

componentType

CHARACTER Empresa do aprovador

INTEGER

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

Sim

Não

Não se aplica

idiomalanguage

nom-rotu-campo

label

CHARACTER

Idioma

Rótulo do

aprovador

campo

Não

Não se aplica

tt

des-

config-visual

Entrada/Saída

campo	description	CHARACTER	Descrição do campo	Sim	Não se aplica
log-visivel	visible	LOGICAL	Visibilidade do campo	Sim

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

Não se aplica

idi

cdn-

ordenacao

tamanho

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)

size

INTEGER

Tamanho do campo

Sim

Não

Não se aplica

log-mostra-todas-empresasallCompaniesLOGICALIndica apresentação de pendências de todas as empresas

cdn-ord

INTEGER

Ordem do campo

Sim

Não

Não se aplica

log

cod-

aprova

entid-

sem-motiv

pai

approveWithoutReasonLOGICALIndica aprovação sem informar motivo

CHARACTER

Identificação da entidade pai

Não

Não se aplica

cdn-tempo-desfundoTimeINTEGERTempo de desfazerNãoNão se aplicaidi-acao-swip-direrightSwipeActionINTEGER

Ação do swipe (Direito)

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

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

tt-mla-doc-pend-aprov					Entrada/Saída
Temp-table com dados 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

idi

cod-

acao

tip-

swip-esq

doc

leftSwipeAction

documentType

INTEGER

Ação do swipe (Esquerdo)

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

NãoNão se aplicaidi-visualiz-inicialinitialViewINTEGER

Visualização inicial

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

Código do documento	Sim	Não se aplica
chave-doc	documentKey	CHARACTER	Chave do documento	Sim

Não

Não se aplica

num

dt-

registro-paginac

geracao

pageRecordsNumber

generateDate

INTEGER

DATE

Número de registros por páginaSequência da empresa

Data de geração	Sim	Não se aplica
cod-usuar	approver	CHARACTER	Código do aprovador	Sim	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
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	seqGroup	INTEGER		Sim	Não se aplica
cCodecod-estabel	codesite	CHARACTERCHARACTER	Código da empresaEstabelecimento	Sim	Não se aplica	cName	name	CHARACTER
tipo	pendencyType	INTEGER	Tipo 1 - Principal 2 - Alternativa 3 - Mestre Nome da empresa	Sim	Não se aplica
valor-doc	price	DECIMAL	Valor do documento

tt-fields

ttEstablishments

					Entrada/Saída
Temp-table com

dados de estabelecimentos

informações de campos e valores das pendências					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

cCode

nr-trans

code

INTEGER

CHARACTERCódigo do estabelecimento

Número da transação

Sim

Não se aplica

cName

id-campo

name

id

CHARACTER

Nome

ID do

estabelecimento

campo

Sim

Não se aplica

cCodeCompany

valor-campo

codeCompany

value

CHARACTERCódigo da empresa

CHARACTER

Valor do campo

Sim

Não se aplica

.

tt-document

ttParamPendingApproval				Entrada/Saída
Temp-table com

dados

parâmetros para busca de

documentos

pendências				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-interfacinterfaceINTEGERInterface (1 - Lista / 2 - Detalhe)SimNão se aplicacod-tip-docdocumentCodeINTEGER


company	CHARACTER	Empresa, se deixar em branco serão consideradas todas as empresas	Não	Não se aplica
establishment	CHARACTER	Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos	Não	Não se aplica
initialGenerationDate	DATE	Data de geração inicial	Não	Não se aplica
finalGenerationDate	DATE	Data de geração final	Não	Não se aplica
mainPendencies	LOGICAL	Indica se devem ser apresentadas as pendências principais

Código do documento

Sim

Não se aplica

desc-tip-docdocumentDescriptionCHARACTER Descrição do documento

alternativePendencies

LOGICAL

Indica se devem ser apresentadas as pendências alternativas

Sim

Não

Não se aplica

layout-padrao

masterPendencies

defaultLayout

LOGICAL

Layout padrão

Indica se devem ser apresentadas as pendências como mestre

Sim

Não

Não se aplica

sigla

documents

shortNameCHARACTERSigla do documento

CHARACTER

Documentos a serem considerados (separados por vírgula)

Sim

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

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"

cdn-doctoINTEGERCódigo do documento

Sim

Não se aplica

cod-usuar

reApprovedPendencies

CHARACTER

Código do aprovador

LOGICAL

Indica se devem ser apresentadas pendências "reaprovadas"

Sim

Não se aplica

idi-interfac

sortType

INTEGERInterface (1 - Lista / 2 - Detalhe)SimNão se aplicacod-id-campoidCHARACTER Identificador do campo

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

Sim

Não se aplica

idi-componcomponentType

pageSize

INTEGER

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

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

Não

Sim

Não se aplica

nom-rotu-campolabelCHARACTER Rótulo do campoNãoNão se aplica

nextPageRowid

ROWID

Rowid do registro da próxima página

Não

des-campodescriptionCHARACTER Descrição do campoSim

Não se aplica

log-visivelvisibleLOGICALVisibilidade do campoSimNão se aplicacdn-tamanhosizeINTEGERTamanho do campo

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

cdn-ord

description

INTEGER

CHARACTER

Ordem do campo

Descrição

Sim

Não se aplica

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

obriga-narrativa

reasonIsRequired

LOGICAL

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

Sim

Não

Não se aplica

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

ttHistoricPending					Entrada/Saída
Temp-table com

dados

informações dos históricos de

pendências

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

nr-transtransactionNumber

nivel

INTEGER

Número da transação

Nível de aprovação

Sim

Não se aplica

cod

desc-

tip-doc

nivel

documentType

approveType

INTEGER

CHARACTER

Código

Descrição do

documento

nível de aprovação

Sim

Não se aplica

chave

cod-

doc

aprovador

documentKey

approverCode

CHARACTER

Chave

Código do

documento

aprovador

Sim

Não se aplica

dt

nome-

geracao

aprovador

approverDescription

CHARACTER

Nome

generateDateDATEData de geraçãoSimNão se aplica

cod-usuar

approver

CHARACTER

Código

do aprovador

Sim

Não se aplica

ind

data-

situacao

aprovacao

statusINTEGER

Situação da pendência

1 - Pendente

2 - Aprovada

3 - Reprovada

approveDate

DATE

Data da aprovação

4 - Reaprovada

Sim

Não se aplica

ep

hora-

codigo

aprovacao

company

approveHour

CHARACTER

Empresa

Hora da aprovação

Sim

Não se aplica

cod-estabel

narrativa

site

text

CHARACTER

Estabelecimento

Narrativa

Sim

Não se aplica

tipo

situacao

pendencyType

status

INTEGER

Tipo

Situação

1 -

Principal

Pendente

2 -

Alternativa

Aprovada

3 - Reprovada

4 -

Mestre

Reaprovada

Sim

Não se aplica

valor-docpriceDECIMALValor do documento

tt-fields

ttTransactions

Entrada/Saída
Temp-table com

informações de campos e valores das

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

id-campoidCHARACTER ID do campoSimNão se aplicavalor-campovalueCHARACTER Valor do campo

Sim

Não se aplica

ttParamPendingApproval

tt-anexo					Entrada/Saída
Temp-table com

parâmetros para busca de pendências

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

company

nr-trans

CHARACTER Empresa, se deixar em branco serão consideradas todas as empresasNãoNão se aplica

transactionNumber

INTEGER

Número da transação

Sim

establishmentCHARACTER Estabelecimento, se deixar em branco serão considerados todos os estabelecimentosNãoNão se aplicainitialGenerationDateDATEData de geração inicialNãoNão se aplicafinalGenerationDateDATEData de geração finalNão

	Não se aplica
id

mainPendencies

internalId

LOGICALIndica se devem ser apresentadas as pendências principais

CHARACTER

Id interno do anexo

Sim

Não se aplica

alternativePendencies

nome

name

LOGICALIndica se devem ser apresentadas as pendências alternativas

CHARACTER	Nome do anexo	Sim	Não se aplica
descricao

masterPendencies

description

LOGICALIndica se devem ser apresentadas as pendências como mestre

CHARACTER

Descrição do anexo

Não

Sim

Não se aplica

documentsCHARACTER Documentos a serem considerados (separados por vírgula)

dt-hra-criacao

creationDatetime

DATETIME

Data e hora de criação do anexo

Não

Sim

Não se aplica

pendingPendenciesLOGICALIndica se devem ser apresentadas pendências "pendentes"

grupo

group

CHARACTER

Grupo de ordenação ao qual o anexo pertence

Não

Sim

Não se aplica

approvedPendenciesLOGICALIndica se devem ser apresentadas pendências "aprovadas"SimNão se aplicarejectedPendenciesLOGICALIndica se devem ser apresentadas pendências "reprovadas"SimNão se aplicareApprovedPendenciesLOGICALIndica se devem ser apresentadas pendências "reaprovadas"

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

sortType

id

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

internalId	CHARACTER	Id interno do anexo	Sim	Não se aplica
nome	name	CHARACTER	Nome do anexo

documentType: Documento

Não

Não se aplica

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

tipo-conteudo	contentType	CHARACTER	Tipo do conteúdo usado para a abertura do arquivo	Não	Não se aplica
conteudo

nextPageRowid

content

ROWID

CLOB

Rowid do registro da próxima página

Conteúdo do arquivo em Base64

Sim

Não

Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave