Consulta de Vendedor

Regras de negócio

Para efetuar consulta vendedores/compradores, e otimizar controle de pagamentos de comissões e acompanhamento de desempenho de vendas e de compras com determinadas características.
Para efetuar, consulta necessário efetuar cadastramento dos vendedores/compradores preenchendo no sistema os campos obrigatórios,como parceiros e cadastro da empresa, para que seja possível realizar consulta.
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/360045111133-Vendedores-Compradores

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Vendedor que por sua vez instancia a tabela TGFVEN 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.

Na busca dos dados foram utilizados os campos CODPARC, porém também podem ser utilizados os demais campos para consulta utilizando filtro no corpo da requisição.
Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
    "criteria": {
      "expression": {
        "$": "this.CODPARC = ?"
      },
      "parameter":[
        {
           "type":"I",
           "value":"268"
        }
      ]
    }

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 TGFVEN

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": "Vendedor",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODPARC = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":"268"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODVEND,CODPARC,CODPARC,APELIDO"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "DD0EDD0BD9C180F5AEFEE5E3F0BE1F79",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODVEND"
                        },
                        {
                            "name": "CODPARC"
                        },
                        {
                            "name": "APELIDO"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "20"
                },
                "f1": {
                    "$": "268"
                },
                "f2": {
                    "$": "VENDEDOR 1"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!