Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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
titleExemplo
{
    "pathParams": [
       "reapprove"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
       ],
       "approveText": "Re-aprovada!"
    },
}
oOutputJsonObjectOUTPUT

Informações da re-aprovação:


Bloco de código
titleExemplo
{
  "status": 200,
  "payload": {
    "sucessProcess": true
  }
}
RowErrorsTemp-tableOUTPUTInformaçõ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
titleExemplo
{
    "pathParams": [
    "attachments",
    "19308"
  ],
}
oOutputJsonObjectOUTPUT

listagem dos anexos do documento:


Bloco de código
titleExemplo
{
    "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.


RowErrorsTemp-tableOUTPUTInformaçõ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

a lista de conteúdo dos anexos

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

a lista de anexos

o conteúdo do anexo:

pathParams:  Informar:

attachmentsContent
  • attachmentContent 
  • número da transação
  • número do ID do anexo


Bloco de código
titleExemplo
{
    "pathParams": [
    "
attachments
attachmentContent",
    "412297",
	"2"
  ],
}
oOutputJsonObjectOUTPUT
listagem dos anexos do documento

Objeto com o conteúdo do anexo solicitado:


Bloco de código
titleExemplo
{    
    "
payload
internalId": 
{
1,
    
"
total
transactionNumber": 
3
412297,
    "
hasNext
name": 
false
"arquivo1.png",
    "
items
contentType": 
[
"image/png",
    
{ "internalId
"content": "
1
iVBORw0KGgoAAAANSUhEUgAAAMkAAADJCAYAAAH+wSaTAAAAAXNSR0IArs4c6QAAAARnQU1BAA"
, "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 }RowErrorsTemp-tableOUTPUTInformaçõ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-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

iActionINTEGERINPUT

Ação 

1 - Aprovação

2 - Reprovação

3 - Reaprovação

ttTransactionsTEMP-TABLEINPUTLista de transações a serem processadascTextCHARACTERINPUTComentário de aprovação/reprovaçãoiRejectionCodeINTEIROINPUTCódigo de rejeiçãosucessProcessLOGICALOUTPUTIndica o processamento com sucesso (de pelo menos uma pendência)RowErrorsTEMP-TABLEOUTPUTInformaçõ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:


}

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.
RowErrorsTemp-tableOUTPUTInformaçõ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

iActionINTEGERINPUT

Ação 

1 - Aprovação

2 - Reprovação

3 - Reaprovação

ttTransactionsTEMP-TABLEINPUTLista de transações a serem processadas
cTextCHARACTERINPUTComentário de aprovação/reprovação
iRejectionCodeINTEIROINPUTCódigo de rejeição
sucessProcessLOGICALOUTPUTIndica o processamento com sucesso (de pelo menos uma pendência)
RowErrorsTEMP-TABLEOUTPUTInformaçõ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

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplica
ErrorParametersCHARACTER Parâmetros da mensagem de erro SimNão se aplica
ErrorTypeCHARACTER Tipo do erro SimNão se aplica
ErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplica
ErrorSubTypeCHARACTERSubtipo do erroSimNã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

userNameCHARACTER Nome do aprovador

Não

Não se aplica

e-maileMailCHARACTER E-mail do aprovadorNãoNão se aplica
envia-emailsendEmailLOGICALIndica se envia e-mailNãoNão se aplica
recebe-emailreceiveEmailLOGICALIndica se recebe e-mailNãoNão se aplica
usuar-mestremasterUserLOGICALIndica se o usuário é mestreNãoNão se aplica
mo-codigocurrencyINTEGERMoeda do aprovadorNãoNão se aplica
sigla-moedacurrencyAbbrevCHARACTER Sigla da moeda do usuárioNãoNão se aplica
aprova-autoautomacticApprovalLOGICALIndica se o aprovador aprova automaticamenteNãoNão se aplica
aprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovadorNãoNão se aplica
cod-estabelsiteCodeCHARACTER Estabelecimento do aprovadorNãoNão se aplica
cod-lotacaoallocationCodeCHARACTER Lotação do aprovadorNãoNão se aplica
libera-verbareleaseAmountLOGICALIndica se o aprovador libera verbaNãoNão se aplica
log-usuar-configconfiguratorUserLOGICALIndica se o aprovador é configurador visualNãoNão se aplica
empresacompanyCodeCHARACTER Empresa do aprovadorNãoNão se aplica
idiomalanguageCHARACTER Idioma do aprovadorNãoNão se aplica



tt-config-visual

RowErrors

Entrada/Saída

Temp-table com dados dos erros ocorridos durante o processo

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

 INTEGER

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 

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

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)

Não

Não se aplica

log-mostra-todas-empresasallCompaniesLOGICALIndica apresentação de pendências de todas as empresas
Código do aprovador
NãoNão se aplica

nome-usuar

userNameCHARACTER 
log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivo
Nome do aprovador
NãoNão se aplica
e
cdn-tempo-
mail
desf
eMail
undoTime
CHARACTER E-mail do aprovador
INTEGERTempo de desfazerNãoNão se aplica
envia-emailsendEmailLOGICALIndica se envia e-mailNãoNão se aplica
idi-acao-swip-direrightSwipeActionINTEGER

Ação de deslizar (Direita)

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


Não se aplica
idi-acao-swip-esqleftSwipeActionINTEGER

Ação de deslizar (Esquerda)

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

recebe-emailreceiveEmailLOGICALIndica se recebe e-mail

NãoNão se aplica
usuar-mestremasterUserLOGICALIndica se o usuário é mestre
idi-visualiz-inicialinitialViewINTEGER

Visualização inicial

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

NãoNão se aplica
mo
num-registro-
codigo
paginac
currency
pageRecordsNumberINTEGER
Moeda do aprovadorNãoNão se aplicasigla-moedacurrencyAbbrevCHARACTER Sigla da moeda do usuário
Número de registros por páginaNãoNão se aplica
aprova-autoautomacticApprovalLOGICALIndica se o aprovador aprova automaticamenteNãoNão se aplicaaprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovador



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

Não se aplica

cod-estabel
cCode
siteCode
code
CHARACTER Estabelecimento do aprovador
CHARACTERCódigo da empresaSim
Não
Não se aplica
cod-lotacao
cName
allocationCode
name
CHARACTER Lotação do aprovador
CHARACTERNome da empresaSim
Não
Não se aplica
libera-verbareleaseAmountLOGICALIndica se o aprovador libera verbaNãoNão se aplicalog-usuar-configconfiguratorUserLOGICALIndica se o aprovador é configurador visual



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 estabelecimentoSim
Não
Não se aplica
empresa
cName
companyCode
name
CHARACTER 
CHARACTER
Empresa
Nome do
aprovador
estabelecimento
Não
SimNão se aplica
idioma
cCodeCompany
language
codeCompany
CHARACTER Idioma do aprovador
CHARACTERCódigo da empresaSim
Não
Não se aplica.



tt-

config-visual

document

Entrada/Saída

Temp-table com dados de

configurações visuais de aprovadores

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

idi-
ordenacao
interfac
ordination
interfaceINTEGER

Ordenação padrão:

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

Interface (1 - Lista / 2 - Detalhe)SimNão se aplica
cod-tip-docdocumentCodeINTEGERCódigo do documentoSim
Não
Não se aplica
log
desc-
mostra
tip-
todas-empresas
doc
allCompanies
documentDescription
LOGICALIndica apresentação de pendências de todas as empresas
CHARACTER Descrição do documentoNãoNão se aplica
log-aprova-sem-motivapproveWithoutReason
layout-padraodefaultLayoutLOGICAL
Indica aprovação sem informar motivo
Layout padrãoNãoNão se aplica
cdn-tempo-desfundoTimeINTEGERTempo de desfazer
siglashortNameCHARACTERSigla do documentoNãoNã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
INTEGERCódigo do documentoSim
idi-acao-swip-direrightSwipeActionINTEGER

Ação de deslizar (Direita)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)
Não se aplica
idi-acao-swip-esqleftSwipeActionINTEGER

Ação de deslizar (Esquerda)

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

NãoNão

cod-usuar


CHARACTER 

Código do aprovador

Sim

Não se aplica

idi-
visualiz-inicial
interfac
initialView

INTEGER

Visualização inicial

Interface (1 -
Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)
Lista / 2 - Detalhe)Sim
NãoNão se aplicanum-registro-paginacpageRecordsNumberINTEGERNúmero de registros por páginaNã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
cod-id-campoidCHARACTER Identificador do campoSimNão se aplica
idi-componcomponentTypeINTEGERTipo de componente (1 - Campo / 2 - Lista / 3 - Separador)SimNão se aplica
cCodecodeCHARACTERCódigo da empresa
nom-rotu-campolabelCHARACTER Rótulo do campoNão
Sim
Não se aplica
cName
des-campo
name
description
CHARACTER
CHARACTER Descrição do campo
Nome da empresa
SimNã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
log-visivelvisibleLOGICALVisibilidade do campoSimNão se aplica
cdn-tamanhosizeINTEGERTamanho do campoSimNão se aplica
cName
cdn-ord
name

INTEGER
CHARACTERNome
Ordem do
estabelecimento
campoSimNão se aplica
cCodeCompanycodeCompanyCHARACTERCódigo da empresa
cod-entid-pai
CHARACTER Identificação da entidade paiNão
Sim
Não se aplica
Índice: visivel-ordem, log-visivel, cdn-ord



tt-mla-doc-pend-aprov

.usuarSigla documentoNão

tt-document

Entrada/Saída

Temp-table com dados de documentospendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evoluçãocod

nr-transtransactionNumberINTEGERNúmero da transaçãouserCode

CHARACTER 

Código do aprovador

Sim

Não se aplica

idi-interfacinterfaceINTEGERInterface (1 - Lista / 2 - Detalhe)SimNão se aplica
cod-tip-docdocumentCodedocumentTypeINTEGERCódigo do documentoSimNão se aplica
descchave-tip-docdocumentDescriptiondocumentKeyCHARACTER Descrição Chave do documentoNãoSimNão se aplica
layoutdt-padraogeracaodefaultLayoutgenerateDateLOGICALLayout padrãoDATEData de geraçãoSimNãoNão se aplicasigla

cod-usuar

shortNameapproverCHARACTER

CHARACTER 

Código do aprovador

Sim

Não se aplica

tt
ind-
layout

Temp-table com campos de layout

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cdn-doctoINTEGERCódigo do documento
situacao

Entrada/Saída

statusINTEGER

Situação da pendência

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

SimNão se aplica

cod-usuar

CHARACTER 

Código do aprovador

Sim

Não se aplica

idi-interfacINTEGERInterface (1 - Lista / 2 - Detalhe)
ep-codigocompanyCHARACTER EmpresaSimNão se aplica
cod-
id-campo
estabel
id
siteCHARACTER 
Identificador do campo
EstabelecimentoSimNão se aplica
idi-compon
tipo
componentType
pendencyTypeINTEGER

Tipo

de componente (

1 -

Campo /

Principal

2 -

Lista /

 Alternativa

3 -

Separador)

Mestre

SimNão se aplica
nom
valor-
rotu-campo
doc
label
price
CHARACTER 
DECIMAL
Rótulo
Valor do
campo
documento
NãoNão se aplicades-campodescriptionCHARACTER Descrição do campoSimNão se aplicalog-visivelvisibleLOGICALVisibilidade do campoSimNão se aplicacdn-tamanhosizeINTEGER




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
Tamanho do campo

Sim

Não se aplica

cdn
id-
ord
campoid
INTEGER
CHARACTER 
Ordem
ID do campoSimNão se aplica
cod-entid-pai
valor-campovalueCHARACTER 
Identificação da entidade pai
Valor do campoSim
Não
Não se aplica
Índice: visivel-ordem, log-visivel, cdn-ord

tt-mla-doc-pend-aprov



ttParamPendingApproval

Entrada/Saída

Temp-table com

dados

parâmetros para busca de pendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-trans
company
transactionNumberINTEGERNúmero da transaçãoSimNão se aplicacod-tip-docdocumentTypeINTEGERCódigo do documento
CHARACTER Empresa, se deixar em branco serão consideradas todas as empresasNão
Sim
Não se aplica
chave-docdocumentKey
establishmentCHARACTER 
Chave do documento
Estabelecimento, se deixar em branco serão considerados todos os estabelecimentosNão
Sim
Não se aplica
dt-geracaogenerateDate
initialGenerationDateDATEData de geração inicial
Sim
NãoNão se aplica
cod-usuar
finalGenerationDate
approver

CHARACTER 

Código do aprovador

Sim

DATEData de geração finalNãoNão se aplica
ind-situacao
mainPendencies
statusINTEGER

Situação da pendência

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

LOGICALIndica se devem ser apresentadas as pendências principaisSimNão se aplica
ep-codigo
alternativePendencies
companyCHARACTER 
LOGICALIndica se devem ser apresentadas as pendências alternativas
Empresa
SimNão se aplica
cod-estabel
masterPendencies
siteCHARACTER 
LOGICALIndica se devem ser apresentadas as pendências como mestre
Estabelecimento
SimNão se aplica
tipo
documents
pendencyTypeINTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre
CHARACTER Documentos a serem considerados (separados por vírgula)SimNão se aplica
valor-doc
pendingPendencies
priceDECIMALValor do documento
LOGICALIndica se devem ser apresentadas pendências "pendentes"SimNão se aplica
approvedPendenciesLOGICALIndica se devem ser apresentadas pendências "aprovadas"SimNão se aplica
rejectedPendenciesLOGICALIndica se devem ser apresentadas pendências "reprovadas"

tt-fields

Entrada/Saída

Temp-table com informações de campos e valores das pendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-trans

INTEGER

Número da transação
SimNão se aplica
id-campo
reApprovedPendencies
idCHARACTER ID do campo
LOGICALIndica se devem ser apresentadas pendências "reaprovadas"SimNão se aplica
valor-campo
sortType
value
CHARACTER 
Valor do campoSimNão se aplica

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

ttParamPendingApproval

Entrada/Saída

Temp-table com parâmetros para busca de pendências

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

companyCHARACTER Empresa, se deixar em branco serão consideradas todas as empresas
NãoNão se aplica
establishmentpageSizeCHARACTER INTEGERTamanho da página (número de registros retornados). Se não informado será considerado: 20.Estabelecimento, se deixar em branco serão considerados todos os estabelecimentosNãoNão se aplica
initialGenerationDatenextPageRowidDATEROWID

Rowid do registro da próxima página

Data de geração inicial

NãoNão se aplicafinalGenerationDate



ttRejectionCode

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

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
alternativePendencies
description
LOGICALIndica se devem ser apresentadas as pendências alternativas
CHARACTER DescriçãoSimNão se aplica
obriga-narrativa
masterPendencies
reasonIsRequiredLOGICALIndica se
devem ser apresentadas as pendências como mestre
o código de rejeição obriga narrativaSimNão se aplica
documentsCHARACTER Documentos a serem considerados (separados por vírgula)SimNão se aplicapendingPendenciesLOGICALIndica se devem ser apresentadas pendências "pendentes"



ttHistoricPending

Entrada/Saída

Temp-table com informações dos históricos de aprovação

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nivel


INTEGER

Nível de aprovação

Sim

Não se aplica

desc-nivel
approvedPendencies
approveType
LOGICALIndica se devem ser apresentadas pendências "aprovadas"
CHARACTER Descrição do nível de aprovaçãoSimNão se aplica
cod-aprovador
rejectedPendencies
approverCode
LOGICALIndica se devem ser apresentadas pendências "reprovadas"
CHARACTER Código do aprovadorSimNão se aplica
nome-aprovador
reApprovedPendencies
approverDescription
LOGICALIndica se devem ser apresentadas pendências "reaprovadas"
CHARACTER Nome do aprovadorSimNão se aplica
sortType
data-aprovacao
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
approveDateDATEData da aprovaçãoSimNão se aplica
hora-aprovacaoapproveHourCHARACTER Hora da aprovaçãoSim
Não
Não se aplica
pageSize
narrativa
INTEGERTamanho da página (número de registros retornados). Se não informado será considerado: 20.
textCHARACTER NarrativaSim
Não
Não se aplica
nextPageRowidROWID

Rowid do registro da próxima página

situacaostatusINTEGER

Situação

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

Sim
Não
Não se aplica



ttRejectionCodettTransactions

Entrada/Saída

Temp-table com informações números de códigos transações de rejeiçãopendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

EvoluçãoiCodRejeita

nr-trans

codetransactionNumber

INTEGER

Código de rejeição
Número da transação

Sim

Não se aplica

cCodRejeitadescriptionCHARACTER DescriçãoSimNão se aplica
obriga-narrativareasonIsRequiredLOGICALIndica se o código de rejeição obriga narrativaSimNão se aplica

ttHistoricPending

tt-anexo

Entrada/Saída

Temp-table com

informações dos históricos de aprovaçã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

nr-trans

nivel
transactionNumber

INTEGER

Nível de aprovação
Número da transação

Sim

Não se aplica

desc-nivel
id
approveType
internalId
CHARACTER 
CHARACTER
Descrição do nível de aprovação
Id interno do anexoSimNão se aplica
cod-aprovador
nome
approverCode
name
CHARACTER 
CHARACTER
Código
Nome do
aprovador
anexoSimNão se aplica
nome-aprovador
descricao
approverDescription
description
CHARACTER 
CHARACTER
Nome
Descrição do
aprovador
anexo
Sim
NãoNão se aplica
data
dt-hra-
aprovacao
criacao 
approveDate
creationDatetime
DATE
DATETIMEData
da aprovação
e hora de criação do anexoNão
SimNão se aplicahora-aprovacaoapproveHourCHARACTER Hora da aprovaçãoSimNão se aplicanarrativatextCHARACTER NarrativaSim
Não se aplica
situacaostatusINTEGER

Situação

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

grupo  groupCHARACTERGrupo de ordenação ao qual o anexo pertenceNão
Sim
Não se aplica
ttTransactions

tt-anexo-conteudo

Entrada/Saída

Temp-table com

números de transações de pendências

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

idinternalIdCHARACTERId interno do anexoSimNão se aplica
nomenameCHARACTERNome do anexoNãoNão se aplica
tipo-conteudocontentTypeCHARACTERTipo do conteúdo usado para a abertura do arquivoNãoNão se aplica
conteudocontentCLOBConteúdo do arquivo em Base64SimNão se aplica