Árvore de páginas

Versões comparadas

Chave

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

...

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
titleExemplo
{
    "pathParams": [
    "validateUserInfo",
    "super"
  ],
}
oOutputJsonObjectOUTPUT

Campo indicando se o usuário está válido:


Bloco de código
titleExemplo
{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "passed": true       
      }
    ]
  }
}
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de validação.

Retorno

Indica se o usuário está válido e caso não esteja, os erros de validação.

...

pi-query-pending-approval

Requisito

Nenhum.

Descrição

Realiza a busca de pendências a ser apresentada na listagem do APP.

Parâmetros

Tipo

Input/Output

Descrição

ttParamPendingApprovalTEMP-TABLEINPUTParâmetros para busca dos registros de pendências
tt-mla-doc-pend-aprovTEMP-TABLEOUTPUTListagem com informações das pendências
lHasNextLOGICALOUTPUTIndica que existem mais registros a serem mostrados
rNextRowidROWIDOUTPUTPróximo rowid para busca de novos registros 
RowErrorsTEMP-TABLEOUTPUTInformações sobre os erros ocorridos durante o processo de busca das pendências.

Retorno

Informações de pendências a serem apresentadas ou erros ocorridos durante a busca.



pi-query-rejection-options-v1

Requisito

Nenhum.

Descrição

Realiza a busca de códigos de rejeição disponíveis

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca dos códigos de rejeição:

pathParams:  Informar: rejectionOptions.


Bloco de código
titleExemplo
{
    "pathParams": [
    "rejectionOptions"
  ],
}
oOutputJsonObjectOUTPUT

Lista de rejeições:


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


RowErrorsTemp-tableOUTPUTInformaçõ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
titleExemplo
{
    "pathParams": [
       "detailPending",
       "90667"
    ],
}
oOutputJsonObjectOUTPUT

Informações de layouts e dados da pendência solicitada:


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


RowErrorsTemp-tableOUTPUTInformaçõ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
titleExemplo
{
    "pathParams": [
       "detailHistoricPending",
       "89469"
    ],
}
oOutputJsonObjectOUTPUT

Informações de histórico:


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


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

pi-reprove-v1

pi-reapprove-v1

pi-process-pending-v1

Definição de temp-tables:

Requisito

Nenhum.

Descrição

Realiza a aprovação de pendência(s).

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para aprovação de pendência(s):

pathParams:  Informar: approve

payload:

  • transactions: Transações de pendências que devem ser aprovadas (pode ser uma ou várias):
    • transactionNumber: Número da transação
    • approveText: Comentário da aprovação


Bloco de código
titleExemplo
{
    "pathParams": [
       "approve"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
       ],
       "approveText": "Aprovada!"
    },
}
oOutputJsonObjectOUTPUT

Informações da aprovação:


Bloco de código
titleExemplo
{
  "status": 200,
  "payload": {
    "sucessProcess": true
  }
}
RowErrorsTemp-tableOUTPUTInformaçõ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
titleExemplo
{
    "pathParams": [
       "reprove"
    ],
    "payload": {
       "transactions": [
          {
             "transactionNumber": 90390
          }
        ],
       "reproveText": "Reprovada por falta de orçamento",
       "rejectCode": 8
    },
}
oOutputJsonObjectOUTPUT

Informações da reprovação:


Bloco de código
titleExemplo
{
  "status": 500,
  "payload": {
    "sucessProcess": false,
    "errors": {
      "errorMessage": [
        {
          "code": 2609,
          "message": "Código de rejeição não cadastrado",
          "detailedMessage": ".\n",
          "type": "ERROR"
        }
      ]
    }
  }
}
RowErrorsTemp-tableOUTPUTInformaçõ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
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 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
titleExemplo
{
    "pathParams": [
    "attachmentContent",
    "412297",
	"2"
  ],
}
oOutputJsonObjectOUTPUT

Objeto com o conteúdo do anexo solicitado:


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

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

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 empresasNãoNão se aplica
log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivoNãoNão se aplica
cdn-tempo-desfundoTimeINTEGERTempo de desfazerNã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)

NãoNão se aplica
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
num-registro-paginacpageRecordsNumberINTEGERNúmero de registros por páginaNãoNã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

cCodecodeCHARACTERCódigo da empresaSimNão se aplica
cNamenameCHARACTERNome da empresaSimNã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 estabelecimentoSimNão se aplica
cNamenameCHARACTERNome do estabelecimentoSimNão se aplica
cCodeCompanycodeCompanyCHARACTERCódigo da empresaSimNão se aplica.



tt-document

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 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 aplicaenvia-emailsendEmailLOGICALIndica se envia e-mailNãoNão se aplicarecebe-emailreceiveEmailLOGICALIndica se recebe e-mailNãoNão se aplicausuar-mestremasterUserLOGICALIndica se o usuário é mestreNãoNão se aplicamo-codigocurrencyINTEGERMoeda do aprovadorNãoNão se aplicasigla-moedacurrencyAbbrevCHARACTER Sigla da moeda do usuárioNãoNão se aplicaaprova-autoautomacticApprovalLOGICALIndica se o aprovador aprova automaticamenteNãoNão se aplicaaprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovadorNãoNão se aplicacod-estabelsiteCodeCHARACTER Estabelecimento do aprovadorNãoNão se aplicacod-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ãoNão se aplicaidiomalanguageCHARACTER Idioma do aprovadorNãoNão se aplicatt-config-visual

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:

Interface (1 -
Mais recentes
Lista / 2 -
Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)
Detalhe)Sim
Não
Não se aplica
log
cod-
mostra
tip-
todas-empresas
doc
allCompanies
documentCode
LOGICALIndica apresentação de pendências de todas as empresas
INTEGERCódigo do documentoSim
Não
Não se aplica
log
desc-
aprova
tip-
sem-motiv
doc
approveWithoutReason
documentDescription
LOGICALIndica aprovação sem informar motivo
CHARACTER Descrição do documentoNãoNão se aplica
cdn
layout-
tempo-desf
padrao
undoTime
defaultLayout
INTEGERTempo de desfazer
LOGICALLayout padrãoNãoNão se aplica
idi-acao-swip-direrightSwipeActionINTEGER
siglashortNameCHARACTERSigla do documentoNão

Ação do swipe (Direito)

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

Ação do swipe (Esquerdo)

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



tt-layout

Entrada/Saída

Temp-table com campos de layout

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cdn-docto
INTEGERCódigo do documentoSimNão se aplica

cod-usuar


CHARACTER 

Código do aprovador

Sim

Não

Não se aplica

idi-
visualiz-inicialinitialView
interfac
INTEGER

Visualização inicial

Interface (1 -
Todas as pendências
Lista / 2 -
Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre
Detalhe)
Não
SimNão se aplica
num
cod-
registro
id-
paginac
campo
pageRecordsNumber
id
INTEGERNúmero de registros por página
CHARACTER Identificador do campoSim
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
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



usuar

tt-document-mla-doc-pend-aprov

Entrada/Saída

Temp-table com dados de documentospendências

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evoluçãocod

nr-transuserCode

CHARACTER 

Código do aprovador

Sim

Não se aplica

transactionNumberINTEGERNúmero da transaçãoidi-interfacinterfaceINTEGERInterface (1 - Lista / 2 - Detalhe)SimNão se aplica
cod-tip-docdocumentCodedocumentTypeINTEGERCódigo do documentoSimNão se aplica
descchave-tip-docdocumentDescriptionCHARACTER Descrição do documentoNãoNão se aplica
layout-padraodefaultLayoutLOGICALLayout padrãoNãoNão se aplica
documentKeyCHARACTER Chave siglashortNameCHARACTERSigla do documentoNãoSimNão se aplica
tt
dt-
layout

Entrada/Saída

Temp-table com campos de layout

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cdn-doctoINTEGERCódigo do documento
geracaogenerateDateDATEData de geração
SimNão se aplica

cod-usuar

approver

CHARACTER 

Código do aprovador

Sim

Não se aplica

idi
ind-
interfac
situacaostatusINTEGER
Interface (

Situação da pendência

1 -

Lista / 2 - Detalhe)

Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

SimNão se aplica
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-visivelvisibleLOGICAL




tt-fields

Entrada/Saída

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

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-trans


INTEGER

Número da transação
Visibilidade do campo

Sim

Não se aplica

cdn-tamanhosizeINTEGERTamanho do
id-campo
Sim
id
Não se aplicacdn-ordINTEGEROrdem
CHARACTER 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-ordtt-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çãoSim
CHARACTER Empresa, se deixar em branco serão consideradas todas as empresasNãoNão se aplica
cod-tip-docdocumentTypeINTEGERCódigo do documentoSim
establishmentCHARACTER Estabelecimento, se deixar em branco serão considerados todos os estabelecimentosNãoNão se aplica
chave-doc
initialGenerationDate
documentKeyCHARACTER Chave do documento
DATEData de geração inicialNão
Sim
Não se aplica
dt-geracaogenerateDate
finalGenerationDateDATEData de geração finalNãoNão se aplica
mainPendenciesLOGICALIndica se devem ser apresentadas as pendências principaisSimNão se aplica
cod-usuar
alternativePendencies
approver

CHARACTER 

Código do aprovador
LOGICALIndica se devem ser apresentadas as pendências alternativasSimNão se aplica
ind-situacao
masterPendencies
statusINTEGER

Situação da pendência

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada
LOGICALIndica se devem ser apresentadas as pendências como mestreSimNão se aplica
documentsCHARACTER Documentos a serem considerados (separados por vírgula)SimNão se aplica
ep-codigo
pendingPendencies
companyCHARACTER Empresa
LOGICALIndica se devem ser apresentadas pendências "pendentes"SimNão se aplica
cod-estabel
approvedPendencies
siteCHARACTER 
LOGICALIndica se devem ser apresentadas pendências "aprovadas"
Estabelecimento
SimNão se aplica
rejectedPendencies
tipopendencyTypeINTEGER

Tipo

1 - Principal

2 - Alternativa

3 - Mestre
LOGICALIndica se devem ser apresentadas pendências "reprovadas"SimNão se aplica
reApprovedPendenciesLOGICALIndica se devem ser apresentadas pendências "reaprovadas"SimNã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
INTEGERTamanho 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

iCodRejeita

company
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
descriptionCHARACTER 
Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos
DescriçãoSim
Não
Não se aplica
initialGenerationDateDATEData de geração inicial
obriga-narrativareasonIsRequiredLOGICALIndica se o código de rejeição obriga narrativaSim
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 aplica

desc-nivel
masterPendencies
approveType
LOGICALIndica se devem ser apresentadas as pendências como mestre
CHARACTER Descrição do nível de aprovaçãoSimNão se aplica
documents
cod-aprovadorapproverCodeCHARACTER 
Documentos a serem considerados (separados por vírgula)
Código do aprovadorSimNão se aplica
pendingPendenciesLOGICALIndica se devem ser apresentadas pendências "pendentes"
nome-aprovadorapproverDescriptionCHARACTER Nome do aprovadorSimNão se aplica
data-aprovacao
approvedPendencies
approveDate
LOGICALIndica se devem ser apresentadas pendências "aprovadas"
DATEData da aprovaçãoSimNão se aplica
rejectedPendencies
hora-aprovacao
LOGICALIndica se devem ser apresentadas pendências "reprovadas"
approveHourCHARACTER Hora da aprovaçãoSimNão se aplica
narrativa
reApprovedPendencies
text
LOGICALIndica se devem ser apresentadas pendências "reaprovadas"
CHARACTER NarrativaSimNão se aplica
sortTypeCHARACTER 

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

Situação

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

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

ttRejectionCode

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

cCodRejeita
id
description
internalId
CHARACTER 
CHARACTERId interno do anexo
Descrição
SimNão se aplica
obriga-narrativa
nome
reasonIsRequired
name
LOGICALIndica se o código de rejeição obriga narrativa
CHARACTERNome do anexoSimNão se aplica
ttHistoricPending
descricao

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

descriptionCHARACTERDescrição do anexoNãoNão se aplica
dt-hra-criacao creationDatetimeDATETIMEData e hora de criação do anexoNão

nivel

INTEGER

Nível de parovaçãoSim
Não se aplica
desc-nivelapproveTypeCHARACTER Descrição do nível de aprovação
grupo  groupCHARACTERGrupo de ordenação ao qual o anexo pertenceNão
Sim
Não se aplica
cod-aprovadorapproverCodeCHARACTER Código do aprovadorSimNão se aplicanome-aprovadorapproverDescriptionCHARACTER Nome do aprovador

tt-anexo-conteudo

Entrada/Saída

Temp-table com as informações do conteúdo do anexo.

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

nr-trans

transactionNumber

INTEGER

Número da transação

Sim

Não se aplica

data-aprovacao
id
approveDate
internalId
DATEData da aprovação
CHARACTERId interno do anexoSimNão se aplica
hora-aprovacao
nome
approveHour
name
CHARACTER Hora da aprovação
CHARACTERNome do anexoNão
Sim
Não se aplica
narrativa
tipo-conteudo
text
contentType
CHARACTER Narrativa
CHARACTERTipo do conteúdo usado para a abertura do arquivoNão
Sim
Não se aplica
situacao
conteudo
status
content
INTEGER

Situação

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada
CLOBConteúdo do arquivo em Base64SimNão se aplica