Histórico da Página

...

Esta API tem como objetivo realizar a apresentações apresentação de dados e realizar configurações visuais para o aplicativo do MLA.

...

pi-get-approverUser-v1

Requisito

Nenhum.

Descrição

Retorna informações de um aprovador do MLA.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do aprovador:

queryParams → fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis no oOutput.

queryParams → expand: Utilizando este parâmetro com a informação "visualConfigurations", são retornadas também as configurações visuais do usuário.

pathParams: Informar o código do usuário aprovador que se deseja buscar as informações.

Bloco de código

title	Exemplo

{
    "queryParams": {
        "fields" [
            "userCode",
            "userName"
        ],
        "expand": [
            "visualConfigurations"
        ],
    },
    "pathParams": [
        "super"
    ]
}

oOutput

JsonObject

OUTPUT

Informações do aprovador.

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "userCode": "super",
        "userName": "Super Usuário",
        "eMail": "",
        "sendEmail": true,
        "receiveEmail": true,
        "masterUser": false,
        "currency": 0,
        "currencyAbbrev": "R$",
        "automaticApproval": true,
        "automaticApprovalApprover": true,
        "siteCode": "1",
        "allocationCode": "10702",
        "releaseAmount": false,
        "configuratorUser": true,
        "companyCode": "10",
        "language": "pt",
        "_expandables": [
          "visualConfigurations"
        ],
        "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ]
      }
    ]
  }
}

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação.:

tt-aprovador: que contém as informações principais do aprovador
tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos aprovadores

Retorno

Aprovadores do MLA conforme filtros passados.

pi-

ativa-mla

Requisito

Nenhum.

Descrição

Cria e ativa a função de ativação do módulo do MLA

Parâmetros

Não se aplica

Retorno

Não se aplica.

pi-valida-funcao-excecao-aprov-compra

get-layoutSetting-data
Requisito	Nenhum.
Descrição

Verifica se há função de exceção ativa para gerar pendência pela aprovação de compras ao invés do MLA

Retorna layout de documento de um usuário
Parâmetros	Tipo	Input/Output	Descrição

i-documento

pcUser

INTEGERpi-desativa-excecao-aprov-compra

Requisito

Nenhum.

Descrição

Desativa a função de exceção para gerar pendência pela aprovação de compras ao invés do MLA

Parâmetros

Tipo

Input/Output

Descrição

i-documento

CHARACTER

INPUT

Código do

documento do MLA a ser verificado

l-ativo

LOGICAL

OUTPUT

Indica se a função existe e está ativada

Retorno

Não se aplica.

usuário que se deseja buscar o layout
piInterface	INTEGER	INPUT	Código da interface (1 - Lista / 2 - Detalhe)
piDocumentType

INTEGER

INPUT

Código do documento

do MLA

plOnlyVisible

Retorno

Não se aplica.

pi-verifica-doc-contrato

Requisito

Nenhum.

Descrição

Verifica se o documento de contrato está habilitado para geração de pendência

Parâmetros

Tipo

Input/Output

Descrição

l-ativo

LOGICAL

OUTPUT

Indica se o documento está habilitado

Retorno

Não se aplica.

pi-ativa-doc-contrato

Requisito

Nenhum.

Descrição

Ativa o documento de contrato para aprovação pelo MLA

LOGICAL	INPUT	Indica que deve retornar apenas campos visíveis
pcFields	LONGCHAR	INPUT	Lista de campos a serem considerados na busca, separados por vírgula (verificar na temp-table tt-document-com-expand para saber os nomes a utilizar).
pcExpand	LONGCHAR	INPUT	Lista de entidades filhas expansíveis. Para mostrar os campos do layout utilizar "fields"
tt-document-com-expand	TEMP-TABLE	OUTPUT	Informações do documento
tt-layout	TEMP-TABLE	OUTPUT	Lista de campos do layout do documento
RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de busca de layout
Retorno	Layout do documento para o usuário e interface solicitados.

pi-get-layoutSetting-v1

Parâmetros

Não se aplica

Retorno

Não se aplica.

pi-verifica-doc-medicao


Requisito	Nenhum.
Descrição

Verifica se o documento de medição de contrato está habilitado para geração de pendência

Retorna layout de documento de um usuário
Parâmetros	Tipo	Input/Output	Descrição

l-ativo

oInput

LOGICAL

JsonObject

OUTPUT

Indica se o documento está habilitado

Retorno

Não se aplica.

pi-ativa-doc-medicao

Requisito

Nenhum.

Descrição

Ativa o documento de medição de contrato para aprovação pelo MLA

Parâmetros

Não se aplica

Retorno

Não se aplica.

pi-verifica-doc-evento

Requisito

Nenhum.

Descrição

Verifica se o documento de evento de contrato está habilitado para geração de pendência

Parâmetros

Tipo

Input/Output

Descrição

l-ativo

LOGICAL

OUTPUT

Indica se o documento está habilitado

Retorno

Não se aplica.

pi-ativa-doc-evento

Requisito

Nenhum.

Descrição

Ativa o documento de evento de contrato para aprovação pelo MLA

Parâmetros

Não se aplica

Retorno

Não se aplica.

INPUT

Parâmetros para a busca do layout:

queryParams → expand: Utilizando este parâmetro com a informação "fields", são retornadas também os campos do layout.

pathParams: Informar na seguinte ordem: o código do aprovador, interface e número de documento.

Bloco de código

title	Exemplo

{
    "queryParams": {
        "expand": [
          "fields"
        ]
     },
  "pathParams": [
    "super",
    "1",
    "2"
  ],
}

oOutput

JsonObject

OUTPUT

Informações do layout:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "userCode": "super",
    "userName": "Super Usuário",
    "interface": 1,
    "documentCode": 2,
    "documentDescription": "Solicitação de Compra - Total",
    "_expandables": [
      "fields"
    ],
    "fields": [
      {
        "id": "doc-nr-requisicao",
        "componentType": 1,
        "label": "",
        "description": "Número da Solicitação de Compra",
        "visible": true,
        "size": 100
      },
      {
        "id": "pend-valor-doc",
        "componentType": 1,
        "label": "",
        "description": "Valor da Pendência de Aprovação",
        "visible": true,
        "size": 100
      }
   }     
}

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação.:

tt-document-com-expand: que contém as informações do documento.
tt-layout (fields): contém as informações de campos do layout.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca de layout

Retorno

Layout do documento para o usuário e interface solicitados.

pi-get-users-with-layoutSetting-v1
Requisito	Nenhum.
Descrição	Retorna a lista de usuários que possuem layouts salvos para determinado documento

pi-exporta-ccusto

Requisito

Nenhum.

Descrição

Exportação de centros de custo conforme empresa

Parâmetros

Tipo

Input/Output

Descrição

c-empresa

CHARACTER

INPUT

Código da empresa

c-arq

CHARACTER

OUTPUT

Arquivo (.csv) gerado com os centros de custo.

Obs.: O arquivo gerado é no formato para importação através do MLA0171.

Retorno

Caso não haja centros de custo a serem exportados, a variável c-arq terá o valor branco "".

pi-exporta-ccusto-produtivo

Requisito

Nenhum.

Descrição

Exportação de centros de custo produtivos

Parâmetros

Tipo

Input/Output

Descrição

c-arq

CHARACTER

OUTPUT

Arquivo (.csv) gerado com os centros de custo

Obs.: O arquivo gerado é no formato para importação através do MLA0171.

Retorno

Não se aplica.

pi-retorna-documentos-existentes

Requisito

Nenhum.

Descrição

Retorna quais os tipos de documento cadastrados no módulo

Parâmetros

Tipo

Input/Output

Descrição

tt-docs-existentes

TEMP-TABLE

OUTPUT

Temp-table contendo os tipos
de documento cadastrados

Retorno

Não se aplica.

pi-verifica-prog-consulta

Requisito

Nenhum.

Descrição

Verifica se há algum programa de consulta cadastrado para o documento.

Parâmetros

Tipo

Input/Output

Descrição

i-documento

INTEGER

INPUT

Código do documento do MLA

Retorno

Se existir algum programa retorna "OK", caso contrário "NOK".

pi-cria-programa-consulta

Requisito

Documento previamente cadastrado no MLA.

Descrição

Cria os programas de consulta padrões para o documento.


Parâmetros	Tipo	Input/Output	Descrição

i-documento

oInput

INTEGER

JsonObject

INPUT

Código do documento do MLA

c-empresaCHARACTERINPUTCódigo da empresa

Parâmetros para a busca dos usuários:

pathParams: Informar na seguinte ordem: USERSWITHLAYOUT e número de documento.

Bloco de código

title	Exemplo

{
  "pathParams": [
    "USERSWITHLAYOUT ",
    "1",
  ],
}

oOutput

JsonObject

OUTPUT

Informações dos usuários:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "layoutUsers": [
        {
            "userCode": "super",
            "userName": "Super Usuário"
        },
        {
            "userCode": "super2",
            "userName": "Super Usuário 2"
        }
     ]
   }     
}

Sobre os campos retornados:

userCode: Código do usuário
userName: Nome do usuário

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca de usuários

Retorno

Usuários que possuem layout salvo para o documento solicitado.

pi-delete-layoutSetting
Requisito	Nenhum.
Descrição	Elimina o layout de documento de um usuário

tt-mla-prog-consultaTEMP-TABLEOUTPUTProgramas criados

Retorno

Caso o documento não esteja tratado pelo método, ou seja, não há programas de consulta para criar, retorna "NOK".

pi-verifica-chave-mla

Requisito

Documento previamente cadastrado no MLA.

Descrição

Verifica a existência da chave do documento.


Parâmetros	Tipo	Input/Output	Descrição

i-documento

pcUser

INTEGER

CHARACTER

INPUT

Código do

documento do MLA

usuário que se deseja eliminar o layout
piInterface	INTEGER

c-empresaCHARACTER

INPUT

Código da

empresatt-mla-chave-doc-aprovTEMP-TABLEOUTPUTChave do documento

interface (1 - Lista / 2 - Detalhe)
piDocumentType	INTEGER	INPUT	Código do documento
oError	Progress.Lang.AppError	OUTPUT	Informações sobre os erros ocorridos durante o processo de eliminação de layout
RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de eliminação de layout
Retorno	Erros ocorridos no processo de eliminação.

Retorno

Se a chave não existe, retorna "NOK".

pi-cria-chave-mla

Requisito

Documento previamente cadastrado no MLA.

Descrição

Cria as chaves dos documentos padräes no MLA0102 de acordo com o documento

pi-delete-layoutSetting-v1
Requisito	Nenhum.
Descrição	Elimina o layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

c-empresa

oInput

CHARACTER

JsonObject

INPUT

Código da empresa

i-documento

INTEGER

INPUT

Código do documento do MLA

pl-efetiva-criacaoLOGICALINPUTIndica que a chave deve ser efetiva no
banco de dadospl-elimina-chaveLOGICALINPUTIndica que a chave atual do documento deve
ser eliminadatt-mla-chave-doc-aprovTEMP-TABLEOUTPUTChave do documento

Parâmetros para a busca dos usuários:

pathParams: Informar na seguinte ordem: o código do aprovador, interface e número de documento.

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1",
    "2"
  ],
}

oOutput

JsonObject

OUTPUT

Informações do processamento:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
  }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de eliminação de layout

Retorno

Erros ocorridos no processo de eliminação.

Retorno

Caso o documento não esteja tratado pelo método, ou seja, não há chaves para criar, retorna "NOK".

Caso ocorra algum erro na criação da chave para o documento, retorna "NOK".

pi-compara-chave-padrao-chave-doc

Requisito

Nenhum.

Descrição

Compara a chave do documento recebida com a chave padrão do mesmo

pi-delete-every-layoutSetting-v1
Requisito	Nenhum.
Descrição	Elimina todos os layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

c-empresa

cUsuario

CHARACTER

INPUT

Código

da empresa

i-documento

INTEGER

INPUT

Código do documento do MLA

tt-mla-chave-doc-aprov-docTEMP-TABLEOUTPUT

Chave do documento a ser validada

Retorno

Se a chave recebida estiver diferente da chave padrão do documento, retorna "NOK".

pi-existencia-tipos-aprovacao

do usuário
RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de eliminação de layouts
Retorno	Erros ocorridos no processo de eliminação.

pi-delete-batch-layoutSetting-v1
Requisito	Nenhum.
Descrição

Verifica se há algum tipo de aprovação cadastrado.

Parâmetros

Não se aplica

Retorno

Se existir algum tipo de aprovação retorna "OK", caso contrário "NOK".

pi-cria-tipos-aprovacao

Requisito

Executar o "pi-existencia-tipos-aprovacao" antes para garantir que não há tipos de aprovação cadastrados.

Descrição

Realiza a criação dos tipos de aprovação. Um de cada tipo:

Hierarquia
Faixa
Lista
Padrão
Técnica

Parâmetros

Não se aplica

Retorno

Não se aplica.

pi-exporta-usuarios

Requisito

Usuários cadastrados.

Descrição

Exportação de usuários.

Parâmetros

Tipo

Input/Output

Descrição

tt-param-usuarTEMP-TABLEINPUTParâmetros a serem considerados para exportação.

c-arq

CHARACTER

OUTPUT

Arquivo (.csv) gerado com os usuários

Obs.: O arquivo gerado é no formato para importação através do MLA0171.

RowErrorsTEMP-TABLEOUTPUTTemp-table contendo erros ocorridos no processo.

Retorno

Retorna "NOK" caso ocorra algum erro.

pi-verifica-permissoes-aprovadores

Requisito

Aprovadores cadastrados no módulo do MLA.

Descrição

Verifica a existência de permissões cadastradas (MLA0104) para os usuários aprovadores do módulo.

Parâmetros

Tipo

Input/Output

Descrição

tt-aprovadoresTEMP-TABLEOUTPUTAprovadores que não possuem nenhuma permissão.

Retorno

Não se aplica.

pi-verifica-lotacoes-aprovadores

Requisito

Aprovadores cadastrados no módulo do MLA.

Descrição

Verifica a existência de lotações cadastradas (MLA0106) para os usuários aprovadores do módulo.

Parâmetros

Tipo

Input/Output

Descrição

tt-aprovadoresTEMP-TABLEOUTPUTAprovadores que não possuem nenhuma permissão em lotações.

Retorno

Não se aplica.

pi-verifica-utilizacao-verba

Requisito

Nenhum.

Descrição

Verifica se algum documento utiliza controle de verba no módulo

Parâmetros

Tipo

Input/Output

Descrição

l-utiliza

LOGICAL

OUTPUT

Indica utilização de verba por algum documento

Retorno

Não se aplica.

pi-verifica-prioridade-aprov-item-referencia

Requisito

Nenhum.

Descrição

Verifica se algum documento utiliza prioridade de aprovação por item ou referência.

Parâmetros

Tipo

Input/Output

Descrição

l-utiliza

LOGICAL

OUTPUT

Indica utilização de prioridade por item ou referência

Retorno

Não se aplica.

pi-verifica-prioridade-aprov-referencia

Requisito

Nenhum.

Descrição

Verifica se algum documento utiliza prioridade de aprovação por referência.

Parâmetros

Tipo

Input/Output

Descrição

l-utiliza

LOGICAL

OUTPUT

Indica utilização de prioridade por referência

Retorno

Não se aplica.

pi-verifica-utiliza-tipo-aprov

Requisito

Nenhum.

Descrição

Verifica se há algum tipo de aprovação para o tipo solicitado.

Parâmetros

Tipo

Input/Output

Descrição

i-tipoINTEGERINPUT

Tipo de aprovação.

1 - Hierarquia

2 - Lista

3 - Padrão

4 - Técnica

5 - Faixa

l-utiliza

LOGICAL

OUTPUT

Indica a existência do tipo de aprovação.

Retorno

Não se aplica.

pi-retorna-chave-doc

Requisito

Nenhum.

Descrição

Retorna a chave de um determinado documento

Eliminação de layouts de documento de usuário em lote

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca dos usuários:

pathParams: Informar: BATCH

payload: Informar o objeto com layouts a serem eliminados

userCode: Código do usuário
interface: Interface
documentCode: Documento

Bloco de código

title	Exemplo

{
  "pathParams": [
    "BATCH"
  ],
  "payload": {
    "layouts": [
      {
          "userCode":"super",
          "interface":1,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":1,
          "documentCode":3
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":3
      }
    ]
   }
}

oOutput

JsonObject

OUTPUT

Informações do processamento (para cada layout):

Bloco de código

title	Exemplo

{
  "batchReturn": [
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de eliminação de layouts

Retorno

Erros ocorridos no processo de eliminação.

pi-create-visualConfiguration-v1
Requisito	Nenhum.
Descrição	Cria as configurações visuais do usuário
	Parâmetros	Tipo	Input/Output	Descrição

p-cod-tip-codINTEGER

oInput

JsonObject

INPUT

Código do documento

tt-chave

TEMP-TABLE

OUTPUT

Chaves do documento

Retorno

Não se aplica.

pi-localiza-info-documento

Requisito

Nenhum.

Descrição

Localiza informações como Empresa, Estabelecimento, Valor, Lotação, Item e Referência de um documento, com base em sua chave

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUT

Código do documento

tt-chave

TEMP-TABLE

INPUT

Chaves do documento (para localização)

c-empresaCHARACTEROUTPUTCódigo da empresa do documentoc-estabelCHARACTEROUTPUTCódigo do estabelecimento do documentode-valor-docDECIMALOUTPUTValor do documentoc-lotacaoCHARACTEROUTPUTLotação do documentoc-itemCHARACTEROUTPUTItem do do documentoc-familiaCHARACTEROUTPUTFamília do Item do documentoc-referenciaCHARACTEROUTPUTReferência do documentol-item-informadoLOGICALOUTPUTIndica se localizou o item

Retorno

Retorna "NOK" caso não consiga localizar o documento com base na chave recebida.

Trata a localização dos documentos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 18, 19, 20 e 21.

pi-valida-parametros-de-compra

Requisito

Nenhum.

Descrição

Se for recebido um documento de compras, valida se o mesmo está ativo na aprovação eletrônica (CD1750)

Parâmetros para criação das configurações visuis:

payload: Informações das configurações visuais a serem criadas.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "payload": {
    "userCode":"super",
    "interface":1,
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a criação das configurações visuais.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-upatch-visualConfiguration-v1
Requisito	Nenhum.
Descrição	Atualiza as configurações visuais do usuário. Obs.: Permite atualização parcial dos dados, ou seja, pode-se enviar apenas os campos que se deseja alterar.
	Parâmetros	Tipo	Input/Output	Descrição

i-documento

oInput

INTEGER

JsonObject

INPUT

Código do documento

l-configurado

LOGICAL

OUTPUT

Indica se o documento está parametrizado corretamente na aprovação de compras.

Retorno

Caso não seja um documento de compras irá retornar como configurado.

Documentos considerados de compras: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 e 19.

pi-verifica-mla-param-aprov

Requisito

Nenhum.

Descrição

Verifica a existência de parametrização de aprovação para empresa e estabelecimento (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento

l-existe

LOGICAL

OUTPUT

Indica se existe a parametrização

Retorno

Não se aplica.

pi-verifica-mla-tipo-doc-aprov

Requisito

Nenhum.

Descrição

Verifica a existência de parametrização de tipo de documento (MLA0101)

Parâmetros para alteração das configurações visuais:

pathParams: Informar na seguinte ordem: o código do aprovador e interface.

payload: Informações das configurações visuais a serem alteradas.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

oOutput

JsonObject

OUTPUT

Resultado da alteração do registro:

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração das configurações visuais.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-update-visualConfiguration-v1
Requisito	Nenhum.
Descrição	Atualiza as configurações visuais do usuário. Obs.: Realiza atualização total dos dados, ou seja, se algum campo não for enviado seu conteúdo será limpo.
	Parâmetros	Tipo	Input/Output	Descrição

i-documento

oInput

INTEGER

JsonObject

INPUT

Código do documento

c-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimento

l-existe

LOGICAL

OUTPUT

Indica se existe a parametrização

l-aprovLOGICALOUTPUTIndica se o documento está marcado para sofrer aprovaçãoi-prioridade-aprovINTEGEROUTPUTPrioridade de aprovação do documento

Retorno

Não se aplica.

pi-verifica-usuario

Requisito

Nenhum.

Descrição

Retorna a existência do usuário, sua lotação e forma de geração do documento

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUT

Código do usuário

c-lotacaoCHARACTEROUTPUT

Código da lotação

i-responsavelINTEGEROUTPUTResponsável pela geração (1 - Lotação, 2 - Centro de Custo)

l-utiliza-lotacao-orig

LOGICAL

OUTPUT

Indica se deve utilizar a lotação do usuário do documento de origem

Retorno

Retorna "NOK" caso não encontre o usuário.

Parâmetros para alteração das configurações visuais:

pathParams: Informar na seguinte ordem: o código do aprovador e interface.

payload: Informações das configurações visuais a serem alteradas.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

oOutput

JsonObject

OUTPUT

Resultado da alteração do registro:

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração das configurações visuais.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-query-approverUser-v1

pi-retorna-tipos-aprovacao-prioridade


Requisito	Nenhum.
Descrição	Retorna

os tipos

informações de

aprovação conforme a prioridade

aprovadores conforme filtros informados.
Parâmetros	Tipo	Input/Output	Descrição

i-documento

oInput

INTEGER

JsonObject

INPUT

Código do documento

c-empresaCHARACTERINPUT

Código da empresa

i-prioridadeINTEGERINPUTPrioridade de aprovação (1 - Documento, 2 - Item, 3 - Referência, 4 - Família)c-item-fam-refCHARACTERINPUTCódigo do item, família ou referência (conforme a prioridade informada)c-programaCHARACTEROUTPUTNome do programa de configuraçõestt-tipo-aprovTEMP-TABLEOUTPUTTipos de aprovação do documento

Retorno

Não se aplica.

pi-retorna-familia-item

Requisito

Nenhum.

Descrição

Verifica se o item existe e caso exista, retorna sua família.

Parâmetros

Tipo

Input/Output

Descrição

c-itemCHARACTERINPUT

Código do item

c-familiaCHARACTEROUTPUTCódigo da família

Retorno

Se o item não existir retorna "NOK"

pi-valida-existencia-usuar

Requisito

Nenhum.

Descrição

Verifica se o usuário informado existe

Parâmetros

Tipo

Input/Output

Descrição

c-usuarCHARACTERINPUT

Código do usuário

l-existeLOGICALOUTPUTIndica existência do usuário

Retorno

Não se aplica.

pi-verifica-referencia

Requisito

Nenhum.

Descrição

Verifica existência da referência

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

i-documentoINTEGERINPUTCódigo do documentoc-referenciaCHARACTERINPUTCódigo da referência

Retorno

Retorna "NOK" caso a referência não exista.

pi-verifica-lotacao

Requisito

Nenhum.

Descrição

Verifica existência da lotação no MLA

Parâmetros

Tipo

Input/Output

Descrição

c-empresaCHARACTERINPUT

Código da empresa

c-lotacaoCHARACTERINPUTCódigo da lotação

Retorno

Retorna "NOK" caso a referência não exista.

pi-retorna-lotacao

Requisito

Nenhum.

Descrição

Retorna a informação da lotação ou da onde ela deve vir, para cada documento

Parâmetros

Tipo

Input/Output

Descrição

c-lotacao-localizadaCHARACTERINPUT

Lotação que foi localizada para o documento (caso não tenha sido, enviar em branco)

c-usuar-geradorCHARACTERINPUTUsuário gerador da pendênciai-documentoINTEGERINPUTCódigo do documentoc-lotacaoCHARACTEROUTPUTLotação a ser utilizadac-msg-lotacao-docCHARACTEROUTPUTMensagem indicando da onde a lotação vem

Retorno

Não se aplica.

pi-retorna-hierarquia-aprovadores

Requisito

Nenhum.

Descrição

Retorna os aprovadores da hierarquia

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentoc-lotacao-docCHARACTERINPUTCódigo da lotaçãott-aprovadoresTEMP-TABLEOUTPUTAprovadores da hierarquia

Retorno

Não se aplica.

pi-retorna-aprovadores-lista-por-prioridade

Requisito

Nenhum.

Descrição

Retorna os aprovadores da lista conforme prioridade de aprovação

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentoi-prioridadeINTEGERINPUTPrioridade de aprovação (1 - Documento, 2 - Item, 3 - Referência, 4 - Família)c-item-fam-refCHARACTERINPUTCódigo do item, família ou referência (conforme a prioridade)c-programaCHARACTEROUTPUTNome do programa de configuraçõestt-aprovadoresTEMP-TABLEOUTPUTAprovadores da lista

Retorno

Não se aplica.

pi-retorna-aprovador-padrao

Requisito

Nenhum.

Descrição

Retorna o aprovador padrão para o tipo de aprovação, empresa e estabelecimento

Parâmetros

Tipo

Input/Output

Descrição

i-tip-aprovINTEGERINPUTCódigo do tipo de aprovaçãoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentott-aprovadoresTEMP-TABLEOUTPUTAprovador padrão

Retorno

Não se aplica.

pi-retorna-faixa-aprovacao

Requisito

Nenhum.

Descrição

Verifica a faixa de aprovação conforme valor e documento

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentoc-lotacaoCHARACTERINPUTCódigo da lotaçãode-valorDECIMALINPUTValor da pendênciai-num-faixaINTEGEROUTPUTNúmero da faixac-des-faixaCHARACTEROUTPUTDescrição da faixade-lim-iniDECIMALOUTPUTLimite inicial da faixade-lim-fimDECIMALOUTPUTLimite final da faixa

Retorno

Se a faixa não existir retorna "NOK"

pi-verifica-aprovadores-hierarquia-faixa

Requisito

Nenhum.

Descrição

Retorna os aprovadores da hierarquia/faixa

Parâmetros

Tipo

Input/Output

Descrição

i-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentoc-lotacaoCHARACTERINPUTCódigo da lotaçãoi-num-faixaINTEGERINPUTNúmero da faixatt-aprovadoresTEMP-TABLEOUTPUTAprovadores da hierarquia/faixa

Retorno

Não se aplica.

pi-verifica-permissao-limite-usuario

Requisito

Nenhum.

Descrição

Verifica a permissão e limite do usuário no documento

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuárioi-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentode-valorDECIMALINPUTValor da pendêncial-existeLOGICALOUTPUTIndica se existe o cadastro da permissão para o usuáriol-validaLOGICALOUTPUTIndica se a permissão no documento está na validadel-limiteLOGICALOUTPUTIndica se existe o limite está válido

Retorno

Não se aplica.

pi-verifica-lotacao-usuario

Requisito

Nenhum.

Descrição

Verifica a permissão do usuário na lotação

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuárioc-empresaCHARACTERINPUT

Código da empresa

c-lotacaoCHARACTERINPUTCódigo da lotaçãol-existeLOGICALOUTPUTIndica se existe o cadastro de lotação para o usuáriol-validaLOGICALOUTPUTIndica se a permissão na lotação está na validade

Retorno

Não se aplica.

pi-verifica-verba-usuario

Requisito

Nenhum.

Descrição

Verifica a verba do usuário para o documento em questão

Parâmetros

Tipo

Input/Output

Descrição

c-cod-usuarCHARACTERINPUTCódigo do usuárioi-documentoINTEGERINPUTCódigo do documentoc-empresaCHARACTERINPUT

Código da empresa

c-estabCHARACTERINPUTCódigo do estabelecimentode-valorDECIMALINPUTValor da pendêncial-usa-verbaLOGICALOUTPUTIndica se o documento utiliza verbal-existe-verbaLOGICALOUTPUTIndica se existe a verba cadastradal-verba-validaLOGICALOUTPUTIndica se a verba está na validade e valor correto

Retorno

Não se aplica.

Tabelas temporárias utilizadas como parâmetro:

Parâmetros para a busca de aprovadores:

queryParams:

fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis na temp-table tt-aprovador no final desta documentação (utilizar o "Nome no objeto");
quickSearch: Filtro rápido por código ou nome do aprovador;
order: Ordenação (verificar campos possíveis na temp-table tt-aprovador no final desta documentação (utilizar o "Nome no objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
<Nome no objeto>: Filtro pelo campo informado;
userCodeIni: Filtra por aprovadores com código maior ou igual ao informado;
userCodeEnd: Filtra por aprovadores com código menor ou igual ao informado;
userNameIni: Filtra por aprovadores com nome maior ou igual ao informado;
userNameEnd: Filtra por aprovadores com nome menor ou igual ao informado;
pageSize: Tamanho da página (registros que serão retornados por vez);

Bloco de código

title	Exemplo

{
  "queryParams": {
    "userCodeIni": [
      "ana"
    ],
    "userCodeEnd": [
      "super"
    ],
    "order": [
      "-userCode"
    ],
    "pageSize": [
      "10"
    ]
  },
}

aOutput

JsonArray

OUTPUT

Lista de aprovadores retornados na busca.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-aprovador

Bloco de código

title	Exemplo

[
  {
    "userCode": "super",
    "userName": "Super Usuário",
    "eMail": "[email protected]",
    "sendEmail": true,
    "receiveEmail": true,
    "masterUser": true,
    "currency": 0,
    "automaticApproval": false,
    "automaticApprovalApprover": false,
    "siteCode": "1",
    "allocationCode": "10702",
    "releaseAmount": true,
    "configuratorUser": true,
    "companyCode": "10",
    "language": "pt"
  },
  {
    "userCode": "massao",
    "userName": "M.Massao Matsunaka-Ger.Suprim.",
    "eMail": "[email protected]",
    "sendEmail": true,
    "receiveEmail": true,
    "masterUser": false,
    "currency": 0,
    "automaticApproval": true,
    "automaticApprovalApprover": false,
    "siteCode": "1",
    "allocationCode": "",
    "releaseAmount": false,
    "configuratorUser": false,
    "companyCode": "10",
    "language": "pt"
  },
  {
    "userCode": "ana claudia",
    "userName": "Ana Cludia de Oliveira",
    "eMail": "[email protected]",
    "sendEmail": false,
    "receiveEmail": false,
    "masterUser": false,
    "currency": 0,
    "automaticApproval": true,
    "automaticApprovalApprover": false,
    "siteCode": "a1",
    "allocationCode": "",
    "releaseAmount": false,
    "configuratorUser": false,
    "companyCode": "",
    "language": "pt"
  }
]

lHasNext

LOGICAL

OUTPUT

Indica existência de mais registros para busca

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a busca de aprovadores.

Retorno

Informações de aprovadores ou erros ocorridos no processo de busca.

pi-query-layoutSetting-v1

Requisito

Nenhum.

Descrição

Retorna informações de documentos disponíveis para configuração de layout do aprovador conforme filtros informados.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca de documentos:

queryParams:

userCode: Código do aprovador que se deseja verificar os layouts;
interface: Interface para qual se deseja verificar os layouts;
fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome no objeto");
order: Ordenação (verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome no objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
<Nome no objeto>: Filtro pelo campo informado;
documentCodeIni: Filtra por documentos com código maior ou igual ao informado;
documentCodeEnd: Filtra por documentos com código menor ou igual ao informado;

Bloco de código

title	Exemplo

{
  "queryParams": {
    "userCode": [
      "super"
    ],
    "interface": [
      "1"
    ],
    "order": [
      "shortName"
    ]
  }
}

aOutput

JsonArray

OUTPUT

Lista de documentos retornados na busca.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:

tt-aprovador

Bloco de código

title	Exemplo

[
  {
    "documentCode": 5,
    "documentDescription": "Cotação de Materiais",
    "defaultLayout": false,
    "shortName": "CO"
  },
  {
    "documentCode": 501,
    "documentDescription": "Documento Específico",
    "defaultLayout": true,
    "shortName": "D"
  },
  {
    "documentCode": 1,
    "documentDescription": "Solicitação de Compra - Item",
    "defaultLayout": false,
    "shortName": "SC"
  }
]

lHasNext

LOGICAL

OUTPUT

Indica existência de mais registros para busca

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a busca de documentos.

Retorno

Informações de documentos ou erros ocorridos no processo de busca.

pi-create-layoutSetting-v1

Requisito

Nenhum.

Descrição

Cria layout de documento do usuário

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para criação do layout do usuário para documento:

payload: Informações do layout a ser criado:

userCode: Código do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "payload": {
      "userCode": "super",
      "interface": 1,
      "documentCode": 5,
      "fields": [
        {
           "id": "pend-chave-doc",
           "componentType": 1,
           "label": "Chave",
           "description": "Chave do Documento da Pendência de Aprovação",
           "visible": true,
           "size": 100
         },
         {
           "id": "pend-valor-doc",
           "componentType": 1,
           "label": "Valor",
           "description": "Valor da Pendência de Aprovação",
           "visible": true,
           "size": 100
         }
       ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

userCode: Código do aprovador
userName: Nome do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
documentDescription: Descrição do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "userName": "Super Usuário",
  "interface": 1,
  "documentCode": 5,
  "documentDescription": "Cotação de Materiais",
  "_expandables": [
    "fields"
  ],
  "fields": [
    {
      "id": "pend-chave-doc",
      "componentType": 1,
      "label": "Chave",
      "description": "Chave do Documento da Pendência de Aprovação",
      "visible": true,
      "size": 100
    },
    {
      "id": "pend-valor-doc",
      "componentType": 1,
      "label": "Valor",
      "description": "Valor da Pendência de Aprovação",
      "visible": true,
      "size": 100
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a criação do layout de documento do usuário.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-create-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

Criação de layout de documento do usuário em lote.

Obs: Pode ser usado para criar o layout da Listagem e Detalhe junto para o mesmo documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para criação do layout do usuário para documento:

pathParams: Informar BATCH

payload: Informações do layout a ser criado:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "pathParams": [
      "BATCH"
   ],
   "payload": {
      "layouts": [
      {
        "userCode": "super",
        "interface": 1,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 100
          }
        ]
      },
      {
        "userCode": "super",
        "interface": 2,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-cod-usuar-doc",
            "componentType": 1,
            "label": "Usuário",
            "description": "Código do Usuário da Pendência de Aprovação",
            "visible": true,
            "size": 50
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 50
          }
        ]
      }
    ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "layouts": [
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 1,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 100
        }
      ]
    },
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 2,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-cod-usuar-doc",
          "componentType": 1,
          "label": "Usuário",
          "description": "Código do Usuário da Pendência de Aprovação",
          "visible": true,
          "size": 50
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 50
        }
      ]
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a criação dos layouts de documentos/usuários.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-update-layoutSetting-v1

Requisito

Nenhum.

Descrição

Alteração de layout de documento do usuário

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para alteração do layout do usuário para documento:

pathParams: Informar na seguinte ordem: o código do aprovador, interface e código do documento

payload: Informações do layout a ser alterado:

userCode: Código do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "pathParams": [
    "super",
    "1",
    "5"
   ],
   "payload": {
      "userCode": "super",
      "interface": 1,
      "documentCode": 5,
      "fields": [
        {
           "id": "pend-chave-doc",
           "componentType": 1,
           "label": "Chave",
           "description": "Chave do Documento da Pendência de Aprovação",
           "visible": true,
           "size": 50
         },
         {
           "id": "pend-valor-doc",
           "componentType": 1,
           "label": "Valor",
           "description": "Valor da Pendência de Aprovação",
           "visible": true,
           "size": 50
         }
       ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

userCode: Código do aprovador
userName: Nome do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
documentDescription: Descrição do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "userName": "Super Usuário",
  "interface": 1,
  "documentCode": 5,
  "documentDescription": "Cotação de Materiais",
  "_expandables": [
    "fields"
  ],
  "fields": [
    {
      "id": "pend-chave-doc",
      "componentType": 1,
      "label": "Chave",
      "description": "Chave do Documento da Pendência de Aprovação",
      "visible": true,
      "size": 50
    },
    {
      "id": "pend-valor-doc",
      "componentType": 1,
      "label": "Valor",
      "description": "Valor da Pendência de Aprovação",
      "visible": true,
      "size": 50
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração do layout de documento do usuário.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-update-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

Alteração de layout de documento do usuário em lote.

Obs: Pode ser usado para alteração do layout da Listagem e Detalhe junto para o mesmo documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para alteração do layout do usuário para documento:

pathParams: Informar BATCH.

payload: Informações do layout a ser criado:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "pathParams": [
      "BATCH"
   ],
   "payload": {
      "layouts": [
      {
        "userCode": "super",
        "interface": 1,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 100
          }
        ]
      },
      {
        "userCode": "super",
        "interface": 2,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-cod-usuar-doc",
            "componentType": 1,
            "label": "Usuário",
            "description": "Código do Usuário da Pendência de Aprovação",
            "visible": true,
            "size": 50
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 50
          }
        ]
      }
    ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "layouts": [
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 1,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 100
        }
      ]
    },
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 2,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-cod-usuar-doc",
          "componentType": 1,
          "label": "Usuário",
          "description": "Código do Usuário da Pendência de Aprovação",
          "visible": true,
          "size": 50
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 50
        }
      ]
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração dos layouts de documentos/usuários.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

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âmentros 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	Indice se o aprovador é configurador visual	Não	Não se aplica
empresa	companyCode	CHARACTER	Empresa do aprovador	Não	Não se aplica
idioma	language	CHARACTER	Idioma do aprovador	Não	Não se aplica

tt-config-visual					Entrada/Saída
Temp-table com dados de configurações visuais de aprovadores					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cod-usuar		CHARACTER	Código do aprovador	Não	Não se aplica
idi-ordenacao	ordination	INTEGER	Ordenação padrão: (1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)	Não	Não se aplica
log-mostra-todas-empresas	allCompanies	LOGICAL	Indica apresentação de pendências de todas as empresas	Não	Não se aplica
log-aprova-sem-motiv	approveWithoutReason	LOGICAL	Indica aprovação sem informar motivo	Não	Não se aplica
cdn-tempo-desf	undoTime	INTEGER	Tempo de desfazer	Não	Não se aplica
idi-acao-swip-dire	rightSwipeAction	INTEGER	Ação do swipe (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)		Não se aplica
idi-acao-swip-esq	leftSwipeAction	INTEGER	Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)	Não	Não se aplica
idi-visualiz-inicial	initialView	INTEGER	Visualização inicial (1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)	Não	Não se aplica
num-registro-paginac	pageRecordsNumber	INTEGER	Número de registros por página	Não	Não se aplica

tt-config-visual-upd					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	userCode	CHARACTER	Código do aprovador	Sim	Não se aplica
idi-interfac	idi-interfac	INTEGER	Interface	Sim	Não se aplica
idi-ordenacao	ordination	INTEGER	Ordenação padrão: (1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)	Não	Não se aplica
log-mostra-todas-empresas	allCompanies	LOGICAL	Indica apresentação de pendências de todas as empresas	Não	Não se aplica
log-aprova-sem-motiv	approveWithoutReason	LOGICAL	Indica aprovação sem informar motivo	Não	Não se aplica
cdn-tempo-desf	undoTime	INTEGER	Tempo de desfazer	Não	Não se aplica
idi-acao-swip-dire	rightSwipeAction	INTEGER	Ação do swipe (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)		Não se aplica
idi-acao-swip-esq	leftSwipeAction	INTEGER	Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)	Não	Não se aplica
idi-visualiz-inicial	initialView	INTEGER	Visualização inicial (1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)	Não	Não se aplica
num-registro-paginac	pageRecordsNumber	INTEGER	Número de registros por página	Não	Não se aplica

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 se aplica
idi-interfac	interface	INTEGER	Interface (1 - Lista / 2 - Detalhe)	Sim	Não se aplica
cod-tip-doc	documentCode	INTEGER	Código do documento	Sim	Não se aplica
desc-tip-doc	documentDescription	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-document-com-expand					Entrada/Saída
Temp-table com dados de documentos

tt-docs-existentes

Entrada/Saída

Temp-table contendo os tipos de documento cadastrados

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-tip-doc

Inteiro

>>9

Código do documento

Sim

-

des-tip-doc
Caracterex(40)Descrição do documentoSim-

tt-mla-prog-consulta

Entrada/Saída

Temp-table contendo os programas de consulta

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-prog-consulta

-

tt-mla-chave-doc-aprov

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprovr-RowidROWID-RowidNão-

tt-mla-chave-doc-aprov-doc

Entrada/Saída

Temp-table contendo as chaves de um documento a ser validado

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprovr-RowidROWID-RowidNão-

tt-param-usuar

Entrada/Saída

Temp-table contendo parâmetros para exportação de usuários

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-usuar-ini

Caractere

x(12)

Código Usuário inicial a ser considerado na exportação

Sim

-

cod-usuar-fim

Caractere

x(12)

Código Usuário final a ser considerado na exportação

Sim

-

l-comprador
LógicoYES/NOConsidera usuário somente se ele for compradorSim-l-aprovador
LógicoYES/NOConsidera usuário somente se ele for aprovadorSim-l-solicitante
LógicoYES/NOConsidera usuário somente se ele for solicitanteSim-l-requis
LógicoYES/NOConsidera usuário somente se ele for requisitanteSim-l-requis-manut
LógicoYES/NOConsidera usuário somente se ele for requisitante de manutençãoSim-sc-codigo-iniCaracterex(20)Centro de custo inicial do usuário a ser considerado na exportaçãoSim-sc-codigo-fimCaracterex(20)Centro de custo final do usuário a ser considerado na exportaçãoSim-cod-lotacao-iniCaracterex(20)Lotação inicial do usuário a ser considerado na exportaçãoSim-cod-lotacao-fimCaracterex(20)Lotação final do usuário a ser considerado na exportaçãoSim-l-utiliza-lotacaoLógicoYES/NOIndica a utilização do centro de custo do usuário que está sendo exportado, se não marcado, gera com a lotação do usuário de cópiaSim-

tt-chave

Entrada/Saída

Temp-table contendo as chaves de um documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Definição dos campos deve ser LIKE mla-chave-doc-aprov

-

valorCHARACTERx(20)Valor da chaveNão-

tt-tipo-aprov

Entrada/Saída

Temp-table contendo os tipos de aprovação

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

seqINTEGER>>>>>>>>9Sequência do tipo de aprovaçãoSim-cod-tip-aprovINTEGER>9Código do tipo de aprovaçãoSim-des-tip-aprovCHARACTERx(40)Descrição do tipo de aprovaçãoSim-prioridade-aprovINTEGER>9Prioridade de aprovaçãoSim-log-limiteLOGICALyes/noSomente aprovadores com limiteSim-nr-min-aprovINTEGER>9Número mínimo de aprovaçõesSim-ind-tip-aprovINTEGER>9Tipo de aprovaçãoSim-

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

	userCode	CHARACTER	Código do aprovador	Sim	Não se aplica
nome-usuar	userName	CHARACTER	Nome do aprovador	Não	Não se aplica
idi-interfac	interface	INTEGER	Interface (1 - Lista / 2 - Detalhe)	Sim	Não se aplica
cod-tip-doc	documentCode	INTEGER	Código do documento	Sim	Não se aplica

nome

desc-tip-

usuar

doc

userName

documentDescription

CHARACTER

Nome

Descrição do

aprovador

documento

Não

Não se aplica

e-maileMailCHARACTER

expandables

_expandables

CHARACTER (Extent 1)

Lista de entidades filhas expansíveis

E-mail do aprovador

Não

Não se aplica

envia

tt-

email

layout

sendEmailLOGICALIndica se envia e-mailNãoNão se aplicarecebe-emailreceiveEmailLOGICALIndica se recebe e-mailNãoNão se aplicausuar-mestremasterUserLOGICALIndica se o usuário é mestre

Entrada/Saída
Temp-table com campos de layout					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cdn-docto		INTEGER	Código do documento	Sim

Não

Não se aplica

mo

cod-

codigo

usuar

currency

CHARACTER

INTEGERMoeda

Código do aprovador

Não

Sim	Não se aplica

sigla

idi-

moeda

interfac

currencyAbbrevCHARACTER Sigla da moeda do usuário

INTEGER

Interface (1 - Lista / 2 - Detalhe)

Sim

Não

Não se aplica

aprova

cod-id-

auto

campo

automacticApproval

id

LOGICALIndica se o aprovador aprova automaticamente

CHARACTER

Identificador do campo

Sim

Não

Não se aplica

aprova

idi-

auto-aprov

compon

automacticApprovalApprover

componentType

LOGICALIndica se o aprovador aprova automaticamente pendências do aprovador

INTEGER

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

Sim

Não

Não se aplica

cod-estabelsiteCode


nom-rotu-campo	label	CHARACTER

Estabelecimento

Rótulo do

aprovador

campo

Não

Não se aplica

cod

des-

lotacao

campo

allocationCode

description

CHARACTER

Lotação

Descrição do

aprovador

campo

Não

Sim	Não se aplica

libera

log-

verba

visivel

releaseAmount

visible

LOGICAL

Indica se o aprovador libera verba

Visibilidade do campo

Sim

Não

Não se aplica

log

cdn-

usuar-config

tamanho

configuratorUser

size

LOGICALIndice se o aprovador é configurador visual

INTEGER

Tamanho do campo

Sim

Não

Não se aplica

empresa

cdn-ord

companyCode

INTEGER

CHARACTER Empresa

Ordem do

aprovador

campo

Não

Sim	Não se aplica

idiomalanguageCHARACTER Idioma do aprovador

cod-entid-pai		CHARACTER	Identificação da entidade pai	Não	Não se aplica
Índice: visivel-ordem, log-visivel, cdn-ord

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Tabelas temporárias utilizadas como parâmetro: