Histórico da Página

Parâmetros para a busca dos dados iniciais:

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

.

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

Informações

iniciais para o APP:

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

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.

{
    "queryParams": {
       "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"
              }
           }
         ],
         "expanddocuments": [
          "fields"{
        ]
    "documentCode": }1,
  "pathParams          "documentDescription": [
"Solicitação de Compra - "superItem",
    "1",
    "2"
  ],
}

Informações do layout:

{
  "statusdefaultLayout": 200false,
  "payload": {
    "userCode": "super",
    "userNameshortName": "Super UsuárioSC",
       "interface": 1,
    "documentCodefields": 2,[
    "documentDescription": "Solicitação de Compra - Total",
    "_expandables": [{
       "fields"
    ],
     "fieldsid": [
"doc-nr-requisicao",
        {
        "idcomponentType": "doc-nr-requisicao"1,
        "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
        "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.

Parâmetros para a busca dos usuários:

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

{
  "payload": {
    "userCode":"super",
    "interface":1,
    ""
  }
}

Informações dos usuários:

{
  "status": 200,
  "payload": {
    "layoutUsers": [
        {
          },
          {
            "documentCode": 5,
            "documentDescription": "Cotação de Materiais",
            "defaultLayout": false,
            "shortName": "CO",
            "fields": [
              {
                "id": "pend-chave-doc",
                "componentType": 1,
                "userCodelabel": "superChave",
                "userNamedescription": "SuperChave Usuário"
do Documento da Pendência     }de Aprovação",
        {
            "userCodevisible": "super2"true,
                "userNamesize": "Super100
 Usuário 2"
        }
     ]},
   }     
}

Sobre os campos retornados:

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

Parâmetros para a busca dos usuários:

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

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

Informações do processamento:

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

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

Parâmetros para a validação do aprovador:

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

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

{
  "status": 200,
  

Parâmetros para a busca das 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)

{
   "pathParams": [
      "getPendingApprovalToList"
   ],
   "queryParams": {
      "mainPendencies": [
         ""
      ],
      "

Informações das pendências:

Parâmetros para

busca dos códigos de rejeição:

pathParams: 

Informar: rejectionOptions.

Lista de rejeições:

{
  "status": 200: "super",
  "payload": {
    "interfacetotal": 13,
      "documentCodehasNext": 5false,
      "fieldsitems": [
        {
           "idcode": "pend-chave-doc"6,
           "componentTypedescription": "Rejeição 1comum",
           "labelreasonIsRequired": "Chave",true
      },
     "description": "Chave do Documento da Pendência de Aprovação", {
           "visiblecode": true7,
           "sizedescription": 100
         },
         {
   "Pedido suspenso",
        "idreasonIsRequired": "pend-valor-doc",true
      },
     "componentType": 1,
  {
          "labelcode": "Valor"8,
           "description": "ValorRejeição da Pendência de Aprovaçãosem narrativa",
           "visiblereasonIsRequired": true,
           "size": 100
   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

Parâmetros para detalhamento da pendência:

pathParams:  Informar na ordem: detailPending e o número da transação.

{
    "

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

{interface": 1,
  "documentCodestatus": 5200,
  "documentDescriptionpayload": "Cotação de Materiais",
  "_expandables": [{
    "total": 1,
    "hasNext": false,
    "fieldsitems": [
     ],
 {
        "fieldslayout": [
          {
            "id": "penddoc-chavenr-docrequisicao",
            "componentType": 1,
      "      "label": "ChaveRequisição",
            "description": "Chave do DocumentoNúmero da PendênciaRequisição de AprovaçãoEstoque",
            "visible": true,
            "size": 10050
          },
          {
            "id": "penddoc-valordt-docrequisicao",
            "componentType": 1,
            "label": "ValorData Requisição",
            "description": "ValorData da PendênciaRequisição de AprovaçãoEstoque",
            "visible": true,
            "size": 100
50
          },
  ]
}

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

{
   "pathParams": [
      "BATCH"
   ],
   "payload": {
      "layouts": [
      {
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor do Documento",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 100
          }
         ],
         "userCodefieldValues": "super",
 [
          {
            "interfaceid": 1"doc-nr-requisicao",
            "documentCodevalue": 5,"123457111"
         "fields": [ },
          {
            "id": "penddoc-chavedt-docrequisicao",
            "componentTypevalue": 1,
"14\/04\/2021"
          },
         "label": "Chave", {
            "descriptionid": "Chave do Documento da Pendência de Aprovaçãopend-valor-doc",
            "visiblevalue": true,
            "size": 100"R$ 1,25"
          },
          {]
      }
      "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "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-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

Parâmetros para busca do histórico de aprovação:

pathParams:  Informar na ordem: detailHistoricPending e o número da transação.

{
    "pathParams": [
       

Informações de histórico:

{
  "status": 200  },
      {
        "userCode": "super",
    "payload": {
    "interfacetotal": 21,
        "documentCodehasNext": 5false,
        "fieldsitems": [
          {
            "idapproveType": "pend-chave-docFaixa",
            "componentTypeapproverCode": 1"super",
            "labelapproverDescription": "ChaveSuper Usuario",
            "descriptionapproveDate": "Chave do Documento da Pendência de Aprovação2021-03-29",
            "visibleapproveHour": true"18:06:13",
            "size": 100
          },
          {
            "id": "pend-cod-usuar-doc",
  text": "Pendência aprovada!",
          "componentTypestatus": 1,4
      }
      "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",
     ]
  }
}

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

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

pathParams:  Informar: approve

payload:

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

{
    "pathParams": [
       "

Resultado Informações da criação do registroaprovação:

• 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