Árvore de páginas

Versões comparadas

Chave

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

...

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
titleExemplo
{
   "pathParams": [
      "getPendingApprovalToList"
   ],
   "queryParams": {
      "mainPendencies": [
         ""
      ],
      "pendingPendencies": [
         ""
      ],
      "approvedPendencies": [
         ""
      ],
      "rejectedPendencies": [
         ""
      ],
      "reApprovedPendencies": [
         ""
      ],
      "documents": [
         "3,8"
      ],
      "order": [
         "-price"
      ],
      "pageSize": [
         "30"
      ]
  },
}
oOutputJsonObjectOUTPUT

Informações das pendências:


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


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

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

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


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

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

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

 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)SimNão se aplica
cod-tip-docdocumentCodeINTEGERCódigo do documentoSimNão se aplica
desc-tip-docdocumentDescriptionCHARACTER Descrição do documentoNãoNão se aplica
log-mostra-todas-empresasallCompanies
layout-padraodefaultLayoutLOGICAL
Indica apresentação de pendências de todas as empresas
Layout padrãoNãoNão se aplica
log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivo
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
cdn-tempo-desfundoTimeINTEGERTempo de desfazerNãoNão se aplicaidi-acao-swip-direrightSwipeActionINTEGER

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)

Não

cod-usuar


CHARACTER 

Código do aprovador

Sim

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
nom-rotu-campolabelCHARACTER Rótulo do campoNão
Sim
Não se aplica
cCode
des-campo
code
description
CHARACTER
CHARACTER Descrição do campo
Código da empresa
SimNão se aplica
cName
log-visivel
name
visible
CHARACTER
LOGICALVisibilidade 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

cdn-tamanhosizeINTEGERTamanho do campo
cCodecodeCHARACTERCódigo do estabelecimento
SimNão se aplica
cName
cdn-ord
name

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



tt-mla-doc-pend-aprov

cCodeCompanycodeCompanyCHARACTERCódigo da empresaSimNão se aplica.usuar

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

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

cod-usuar

approver

CHARACTER 

Código do aprovador

Sim

Não se aplica

idi
ind-
interfac
situacaostatusINTEGER

Situação da pendência

Interface (

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 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
des-campodescriptionCHARACTER Descrição do campoSimNão se aplicalog-visivelvisibleLOGICALVisibilidade do campoSimNão se aplicacdn-tamanhosizeINTEGERTamanho 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-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-transtransactionNumberINTEGERNúmero da transaçãoSimNão se aplicacod-tip-docdocumentType

Evolução

companyCHARACTER Empresa, se deixar em branco serão consideradas todas as empresasNão
INTEGERCódigo do documentoSim
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
Sim
inicialNão
se aplica

cod-usuar

approver

CHARACTER 

Código do aprovadorSim
Não se aplica
ind-situacao
finalGenerationDate
statusINTEGER

Situação da pendência

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

DATEData de geração finalNão
Sim
Não se aplica
ep-codigo
mainPendencies
companyCHARACTER 
LOGICALIndica se devem ser apresentadas as pendências principais
Empresa
SimNão se aplica
cod-estabel
alternativePendencies
siteCHARACTER 
LOGICALIndica se devem ser apresentadas as pendências alternativas
Estabelecimento
SimNão se aplica
tipo
masterPendencies
pendencyTypeINTEGER

Tipo

1 - Principal

2 - Alternativa

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

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
rejectedPendencies
idCHARACTER ID do campo
LOGICALIndica se devem ser apresentadas pendências "reprovadas"SimNão se aplica
valor-campo
reApprovedPendencies
valueCHARACTER 
LOGICALIndica se devem ser apresentadas pendências "reaprovadas"
Valor do campo
SimNão se aplica
sortType

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 empresasNãoNão se aplicaestablishmentCHARACTER Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos
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 aplica
initialGenerationDate
pageSize
DATEData de geração inicial
INTEGERTamanho da página (número de registros retornados). Se não informado será considerado: 20.NãoNão se aplica
finalGenerationDate
nextPageRowid
DATEData de geração final
ROWID

Rowid do registro da próxima página

NãoNão se aplica



ttRejectionCode

mainPendenciesLOGICALIndica se devem ser apresentadas as pendências principaisSimNão se aplicaalternativePendenciesLOGICALIndica se devem ser apresentadas as pendências alternativasSimNão se aplica

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
masterPendenciesLOGICALIndica se devem ser apresentadas as pendências como mestre

Sim

Não se aplica

cCodRejeita
documents
descriptionCHARACTER 
Documentos a serem considerados (separados por vírgula)
DescriçãoSimNão se aplica
obriga-narrativa
pendingPendencies
reasonIsRequiredLOGICALIndica se
devem ser apresentadas pendências "pendentes"
o código de rejeição obriga narrativaSimNão se aplica
approvedPendenciesLOGICALIndica se devem ser apresentadas pendências "aprovadas"



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 parovação

Sim

Não se aplica

desc-nivel
rejectedPendencies
approveType
LOGICALIndica se devem ser apresentadas pendências "reprovadas"
CHARACTER Descrição do nível de aprovaçãoSimNão se aplica
cod-aprovador
reApprovedPendencies
approverCode
LOGICALIndica se devem ser apresentadas pendências "reaprovadas"
CHARACTER Código do aprovadorSimNão se aplica
nome-aprovador
sortType
approverDescriptionCHARACTER 

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 aplica
Nome do aprovadorSimNão se aplica
data-aprovacaoapproveDateDATEData da aprovaçãoSimNão se aplica
hora-aprovacaoapproveHourCHARACTER Hora da aprovaçãoSimNão se aplica
narrativatextCHARACTER NarrativaSimNão se aplica
situacaostatusINTEGER

Situação

1 - Pendente 

2 - Aprovada

3 - Reprovada

4 - Reaprovada

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