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

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

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplicaErrorParametersCHARACTER Parâmetros da mensagem de erro SimNão se aplicaErrorTypeCHARACTER Tipo do erro SimNão se aplicaErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplicaErrorSubTypeCHARACTERSubtipo do erroSimNão se aplicatt-aprovador

					Entrada/Saída
Temp-table com dados

dos

de configurações visuais de 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

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

nome-usuar

userNameCHARACTER

log-mostra-todas-empresas

allCompanies

LOGICAL

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

Nome do aprovador

Não

Não se aplica

e-maileMailCHARACTER E-mail do aprovadorNãoNão se aplicaenvia-emailsendEmail

log-aprova-sem-motiv

approveWithoutReason

LOGICAL

Indica

se envia e-mail

aprovação sem informar motivo

Não

Não se aplica

recebe

cdn-tempo-

email

desf

receiveEmail

undoTime

LOGICALIndica se recebe e-mail

INTEGER

Tempo de desfazer

Não

Não se aplica

usuar-mestremasterUserLOGICALIndica se o usuário é mestre

idi-acao-swip-dire

rightSwipeAction

INTEGER

Ação de deslizar (Direita)

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

Não

Não se aplica

mo-codigocurrency

idi-acao-swip-esq

leftSwipeAction

INTEGER

Moeda do aprovadorNãoNão se aplicasigla-moedacurrencyAbbrevCHARACTER Sigla da moeda do usuário

Ação de deslizar (Esquerda)

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

Não

Não se aplica

aprova

idi-visualiz-

auto

inicial

automacticApproval

initialView

LOGICALIndica se o aprovador aprova automaticamenteNãoNão se aplicaaprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovador

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

cod

num-registro-

estabel

paginac

siteCode

pageRecordsNumber

CHARACTER

INTEGER

Número de registros por página

Estabelecimento do aprovador

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

cod-lotacaoallocationCodeCHARACTER Lotação do aprovadorNãoNão se aplicalibera-verbareleaseAmountLOGICALIndica se o aprovador libera verbaNãoNão se aplicalog-usuar-configconfiguratorUserLOGICALIndica se o aprovador é configurador visualNãoNão se aplicaempresacompanyCodeCHARACTER Empresa do aprovadorNão

Não se aplica

idioma

cName

language

name

CHARACTER Idioma do aprovador

CHARACTER

Nome da empresa

Sim

Não

Não se aplica

tt-config-visual

ttEstablishments					Entrada/Saída
Temp-table com dados de

configurações visuais de aprovadores

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

cod-usuar

code

CHARACTER

Código do

aprovador

estabelecimento

Não

Sim	Não se aplica

idi-ordenacao

cName

ordination

name

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)

CHARACTER

Nome do estabelecimento

Sim

Não

Não se aplica

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

cCodeCompany

codeCompany

CHARACTER

Código da empresa

Sim

Não

Não se aplica.

log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivoNãoNão se aplicacdn-tempo-desfundoTimeINTEGERTempo de desfazer

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

	Não se aplica
idi-

acao-swip-direrightSwipeAction(

interfac

interface

INTEGER

Ação do swipe (Direito)

Interface (1 -

Aprovar

Lista / 2 -

Rejeitar / 3 - Nenhum

Detalhe)

Sim

Não se aplica

idi

cod-

acao

tip-

swip-esq

doc

leftSwipeAction

documentCode

INTEGER

Ação do swipe (Esquerdo)

Código do documento	Sim	Não se aplica
desc-tip-doc	documentDescription	CHARACTER	Descrição do documento

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

Não

Não se aplica

idi

layout-

visualiz-inicial

padrao

initialView

defaultLayout

INTEGER

LOGICAL

Visualização inicial

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

Layout padrão

Não

Não se aplica

num-registro-paginacpageRecordsNumberINTEGERNúmero de registros por páginattCompany

sigla

shortName

CHARACTER

Sigla do documento

Não

Não se aplica

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

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

cCodecodeCHARACTERCódigo da empresa

cod-id-campo

id

CHARACTER

Identificador do campo

Sim

Não se aplica

cName

idi-compon

name

componentType

CHARACTER

INTEGER

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

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

cCodecodeCHARACTERCódigo do estabelecimento

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

cName

cdn-tamanho

name

size

CHARACTER

INTEGER

Nome

Tamanho do

estabelecimento

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

cCodeCompanycodeCompanyCHARACTERCódigo da empresaSimNão se aplica.

tt-document					Entrada/Saída
Temp-table com dados de documentospendê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
objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	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	documentDescriptiondocumentKey	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

Chave do documento	Sim	Não se aplica
dt-geracao	generateDate	DATE	Data de geração

cdn-doctoINTEGERCódigo do documento

	Sim	Não se aplica
cod-usuar	approver	CHARACTER	Código do aprovador	Sim	Não se aplica

idi

ind-

interfac

situacao

status

INTEGER

Interface (

Situação da pendência

1 -

Lista / 2 - Detalhe)

Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

Sim

Não se aplica

cod

ep-

id-campo

codigo

id

company

CHARACTER

Identificador do campo

Empresa

Sim

Não se aplica

idi

cod-

compon

estabel

componentType

site

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

CHARACTER

Estabelecimento

Sim

Não se aplica

nom-rotu-campolabelCHARACTER Rótulo do campo

tipo

pendencyType

INTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre

Sim

Não

Não se aplica

des

valor-

campo

doc

description

price

CHARACTER

DECIMAL

Descrição

Valor do

campo

documento

SimNão se aplica

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

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

Sim

Não se aplica

cdn

id-

ord

campo

id

INTEGER

CHARACTER

Ordem

ID do campo

Sim

Não se aplica

cod-entid-pai

valor-campo

value

CHARACTER

Identificação da entidade paiNãoNão se aplicaÍndice: visivel-ordem, log-visivel, cdn-ordtt-mla-doc-pend-aprov

Valor do campo

Sim

Não se aplica

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-transtransactionNumberINTEGERNúmero da transaçãoSimNão se aplicacod-tip-docdocumentTypeINTEGERCódigo do documento


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	Sim	Não se aplica

chave-doc

alternativePendencies

documentKeyCHARACTER Chave do documento

LOGICAL

Indica se devem ser apresentadas as pendências alternativas

Sim

Não se aplica

dt-geracao

masterPendencies

generateDateDATE

LOGICAL

Indica se devem ser apresentadas as pendências como mestre

Data de geração

Sim

Não se aplica

cod-usuar

approver

documents

CHARACTER

Código do aprovador

Documentos a serem considerados (separados por vírgula)

Sim

Não se aplica

ind-situacao

pendingPendencies

statusINTEGER

Situação da pendência

1 - Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

LOGICAL

Indica se devem ser apresentadas pendências "pendentes"

Sim

Não se aplica

ep-codigo

approvedPendencies

companyCHARACTER Empresa

LOGICAL

Indica se devem ser apresentadas pendências "aprovadas"

Sim

Não se aplica

cod-estabel

rejectedPendencies

siteCHARACTER

LOGICAL

Indica se devem ser apresentadas pendências "reprovadas"

Estabelecimento

Sim

Não se aplica

tipo

reApprovedPendencies

pendencyTypeINTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre

LOGICAL

Indica se devem ser apresentadas pendências "reaprovadas"

Sim

Não se aplica

valor-doc

sortType

priceDECIMALValor 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çãoSim

Não se aplica

id-campo

pageSize

idCHARACTER ID do campo

INTEGER

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

Não

Sim

Não se aplica

valor-campo

nextPageRowid

value

ROWID

CHARACTER Valor do campo

Rowid do registro da próxima página

Não

SimttParamPendingApproval

Não se aplica

ttRejectionCode					Entrada/Saída
Temp-table com

parâmetros para busca de pendências

informações de códigos de rejeição					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

company

iCodRejeita

code

CHARACTER Empresa, se deixar em branco serão consideradas todas as empresas

INTEGER

Código de rejeição

Sim

Não

	Não se aplica
cCodRejeita

establishment

description

CHARACTER

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

Descrição

Sim

Não

	Não se aplica
obriga-narrativa

initialGenerationDate

reasonIsRequired

DATEData de geração inicial

LOGICAL

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

Sim

Não

Não se aplica

finalGenerationDate

ttHistoricPending

DATEData de geração finalNãoNão se aplicamainPendenciesLOGICALIndica se devem ser apresentadas as pendências principaisSimNão se aplicaalternativePendenciesLOGICALIndica se devem ser apresentadas as pendências alternativas

Entrada/Saída
Temp-table com informações dos históricos de aprovação					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nivel		INTEGER	Nível de aprovação	Sim	Não se

aplicamasterPendenciesLOGICALIndica se devem ser apresentadas as pendências como mestre

aplica
desc-nivel	approveType	CHARACTER	Descrição do nível de aprovação	Sim	Não se aplica
cod-aprovador

documents

approverCode

CHARACTER

Documentos a serem considerados (separados por vírgula)

Código do aprovador

Sim

Não se aplica

pendingPendenciesLOGICALIndica se devem ser apresentadas pendências "pendentes"

nome-aprovador

approverDescription

CHARACTER

Nome do aprovador

Sim

Não se aplica

approvedPendenciesLOGICALIndica se devem ser apresentadas pendências "aprovadas"

data-aprovacao	approveDate	DATE	Data da aprovação	Sim	Não se aplica
hora-aprovacao

rejectedPendencies

approveHour

LOGICALIndica se devem ser apresentadas pendências "reprovadas"

CHARACTER

Hora da aprovação

Sim

Não se aplica

reApprovedPendencies

narrativa

text

LOGICALIndica se devem ser apresentadas pendências "reaprovadas"

CHARACTER	Narrativa	Sim	Não se aplica
situacao

sortType

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

tt-anexo

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ãoNão se aplicapageSizeINTEGERTamanho da página (número de registros retornados). Se não informado será considerado: 20.NãoNão se aplicanextPageRowidROWID

Rowid do registro da próxima página

NãoNão se aplicattRejectionCode

					Entrada/Saída
Temp-table com

informações de códigos de rejeição

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

iCodRejeita

nr-trans

code

transactionNumber

INTEGER

Código de rejeição

Número da transação	Sim	Não se aplica
id	internalId	CHARACTER	Id interno do anexo	Sim	Não se aplica
nome	name	CHARACTER	Nome do anexo	Sim	Não se aplica
descricao	description	CHARACTER	Descrição do anexo	Não

Sim

Não se aplica

cCodRejeitadescriptionCHARACTER Descrição

dt-hra-criacao

creationDatetime

DATETIME

Data e hora de criação do anexo

Não

Sim

Não se aplica

obriga-narrativareasonIsRequiredLOGICALIndica se o código de rejeição obriga narrativa

grupo

group

CHARACTER

Grupo de ordenação ao qual o anexo pertence

Não

Sim

Não se aplica

ttHistoricPending

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

informações dos históricos de aprovação

as informações do conteúdo do anexo.					Saída
Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nivel

INTEGER

Nível de parovação

Sim

Não se aplica

desc-nivelapproveTypeCHARACTER Descrição do nível de aprovaçãoSimNão se aplicacod-aprovadorapproverCodeCHARACTER Código do aprovadorSimNão se aplicanome-aprovadorapproverDescriptionCHARACTER

	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
nr-trans	transactionNumber	INTEGER	Número da transação

Nome do aprovador

Sim

Não se aplica

data-aprovacao

id

approveDate

internalId

DATEData da aprovação

CHARACTER

Id interno do anexo

Sim

Não se aplica

hora-aprovacao

nome

approveHour

name

CHARACTER Hora da aprovação

CHARACTER

Nome do anexo

Não

Sim

Não se aplica

narrativa

tipo-conteudo

text

contentType

CHARACTER Narrativa

CHARACTER

Tipo do conteúdo usado para a abertura do arquivo

Não

Sim

Não se aplica

situacao

conteudo

status

content

INTEGER

Situação

1 - Pendente

2 - Aprovada

3 - Reprovada

4 - Reaprovada

CLOB

Conteúdo do arquivo em Base64

Sim

Não se aplica

Árvore de páginas

Versões comparadas

Versão antiga 8

Nova versão Atual

Chave