Histórico da Página

...

pi-get-defaults-v1

Requisito

Nenhum.

Descrição

Retorna dados principais para carregamento inicial do APP: empresas, estabelecimentos e documentos do aprovador com seus layouts.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do aprovadordos dados iniciais:

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

queryParams → expand: Utilizando este parâmetro com as opções abaixo permite retornar também as informações de:

visualConfigurations: Configurações Visuais
groupCompanies: Grupo de empresas
documents: Documentos
documents.fields: Componentes de cada docmento
establishments: Estabelecimentos

Bloco de código

title	Exemplo

{
    "queryParams": {
    "expand": [     "visualConfigurations,groupsCompanies,documents,documents.fields,establishments"
    ]
  },
    "pathParams": [
       "getDefaults",
       "super"
    ],
}

oOutput

JsonObject

OUTPUT

Informações iniciais para o APP:

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",
          "groupsCompanies",
          "documents",
          "documents.fields",
          "establishments"
        ],
        "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ],
        "groupsCompanies": [
          {
            "sequence": 1,
            "name": "Grupo de Empresas 1",
            "companies": [
              {
                "code": "002",
                "name": "TOTVS SA - E-kanban"
              },
              {
                "code": "10",
                "name": "10 TOTVS S.A"
              },
              {
                "code": "11",
                "name": "TOTVS"
              }
           }
         ],
         "documents": [
          {
            "documentCode": 1,
            "documentDescription": "Solicitação de Compra - Item",
            "defaultLayout": false,
            "shortName": "SC",
            "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
              }
            ]
          },
          {
            "documentCode": 5,
            "documentDescription": "Cotação de Materiais",
            "defaultLayout": false,
            "shortName": "CO",
            "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
              }
            ]
          }
        ],
        "establishments": [
          {
            "code": "A1",
            "name": "Estabelecimento TOTVS",
            "codeCompany": "10"
          },
          {
            "code": "10000",
            "name": "Estab 10000",
            "codeCompany": "10"
          }
         ]         
      }
    ]
  }
}

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

tt-aprovador: contém as informações principais do aprovador
tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário.
groupsCompanies:
- sequencia: sequência do grupo de empresa;
- name: Nome do grupo de empresa;
- ttCompany (companies): contém informações de empresas
tt-document (documents): contém informações dos documentos
- tt-layout (fields): contém informações de campos do layout de documento
ttEstablishments (establishments): contém informações dos estabelecimentos

RowErrors

Temp-table

OUTPUT

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

Retorno

Dados principais para inicialização do APP ou erros ocorridos durante o processo de busca.

pi-get-document-abrev
Requisito	Nenhum.
Descrição	Retorna a sigla do documento
	Parâmetros	Tipo	Input/Output	Descrição
	piDocumentCode	INTEGER	INPUT	Código do documento
	pcDocumentDescription	CHARACTER	INPUT	Descrição do documento
	pcSigla	CHARACTER	OUTPUT	Sigla do documento
Retorno	Sigla do documento.

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

busca

validação do aprovador:

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

Bloco de código

title	Exemplo

{
    "pathParams": [
    "validateUserInfo",
    "super"
  ],
}

oOutput

JsonObject

OUTPUT

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

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "passed": true       
      }
    ]
  }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de validação.

Retorno

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

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

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‡geraçãofinal 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ênciaspendências "reprovadas"
reApprovedPendencies: Indica se devem ser apresentadas pendências "reaprovadas"
order: Ordenação: Opçõess 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
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

title	Exemplo

{
   "pathParams": [
      "getPendingApprovalToList"
   ],
   "queryParams": {
      "mainPendencies": [
         ""
      ],
      "pendingPendencies": [
         ""
      ],
      "approvedPendencies": [
         ""
      ],
      "rejectedPendencies": [
         ""
      ],
      "reApprovedPendencies": [
         ""
      ],
      "documents": [
         "3,8"
      ],
      "order": [
         "-price"
      ],
      "pageSize": [
         "30"
      ]
  },
}

oOutput

JsonObject

OUTPUT

Informações das pendências:

Bloco de código

title	Exemplo

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

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca das pendências.

Retorno

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

pi-query-pending-approval

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave