Consulta de Clientes

Regras de negócio

Para realizar a consulta de clientes é necessário definir as funções do parceiro no sistema.Quando você incluir um novo registro do tipo clientes ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.
OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044594494-Cadastro-de-Parceiroso

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Parceiro que por sua vez instancia a tabela TGFPAR mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é um otimo serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro os campos CODPARC e CLIENTE, porém você pode utilizar outros campos da entidade .

Para utilizar o filtro, basta acrescentar o corpo da requisição o código abaixo utilizando o criteria:
              "criteria": {
                "expression": {
                  "$": "this.CLIENTE = ? and this.CODPARC = ?"
                },
                "parameter": [
                   {
                     "$": "S",
                     "type": "S"
                   },
                   {
                     "$": "648",
                     "type": "I"
                   }
                ]
              }

Para melhor performance sempre utilize nas suas consultas apenas os campos necessários, para evitar tráfego de dados que não serão utilizados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFPAR

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição
{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "Parceiro",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CLIENTE = ? and this.CODPARC = ?"
        },
        "parameter": [
           {
             "$": "S",
             "type": "S"
           },
           {
             "$": "648",
             "type": "I"
           }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODPARC,NOMEPARC,FORNECEDOR,CLIENTE,CODCID,CLIENTE,CLASSIFICMS"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "11045006CD6E63CFD528873AA09448AE",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "entity": {
              "f1": {
                  "$": "TESTE123"
              },
              "f0": {
                  "$": "648"
              },
              "f3": {
                  "$": "S"
              },
              "f2": {
                  "$": "S"
              },
              "f5": {
                  "$": "C"
              },
              "f4": {
                  "$": "10"
              }
          },
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODPARC"
                      },
                      {
                          "name": "NOMEPARC"
                      },
                      {
                          "name": "FORNECEDOR"
                      },
                      {
                          "name": "CLIENTE"
                      },
                      {
                          "name": "CODCID"
                      },
                      {
                          "name": "CLASSIFICMS"
                      }
                  ]
              }
          }
      }
  }

}

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!