get https://example.com/MetasVenda
Regras de negócio
Para realizar a consulta de metas por vendedor no ERP, necessário efetuar as devidas configurações e definição de metas por vendedor primeiramente, pois logo que uma vez que as metas já estão configuradas, você também poderá definir metas por períodos mensais. Além de lançar metas, você poderá também configurar para quais TOP's o sistema considerará na atualização do realizado.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/360045117773-Metas-Simplificadas-de-Vendas
Dependências
Não possui dependênciasDetalhes Técnicos
A entidade utilizada é a MetaAtual que por sua vez instancia a tabela TGMMET 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 o campo CODVEND, porém você pode utilizar outros campos da entidade .
• CODVEND – Código do vendedor.
"criteria": {
"expression": {
"$": "this.CODVEND = ?"
},
"parameters":[
{
"type":"I",
"value":"22"
}
]
}
Caso deseje pesquisar por todos os bancos cadastrados, basta remover o trecho acima do json para retornar todos os bancos cadastrados.
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 TGMMETExemplo 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": "MetaAtual",
"includePresentationFields": "S",
"offsetPage": "0",
"criteria": {
"expression": {
"$": "this.CODVEND = ?"
},
"parameters":[
{
"type":"I",
"value":"22"
}
]
},
"entity": {
"fieldset": {
"list":"CODMETA,DTREF,CODEMP"
}
}
}
}
}
Retorno em json:
{
"serviceName": "CRUDServiceProvider.loadRecords",
"status": "1",
"pendingPrinting": "false",
"transactionId": "EB05070B28133E0DFCAD20E00300682E",
"responseBody": {
"entities": {
"total": "5",
"hasMoreResult": "false",
"offsetPage": "0",
"offset": "0",
"metadata": {
"fields": {
"field": [
{
"name": "CODMETA"
},
{
"name": "DTREF"
},
{
"name": "CODEMP"
},
{
"name": "CODPROD"
},
{
"name": "CODGRUPOPROD"
},
{
"name": "CODLOCAL"
},
{
"name": "CODPROJ"
},
{
"name": "CODCENCUS"
},
{
"name": "CODNAT"
},
{
"name": "CODREG"
},
{
"name": "CODGER"
},
{
"name": "CODVEND"
},
{
"name": "CODPARC"
},
{
"name": "CODUF"
},
{
"name": "CODCID"
},
{
"name": "CODPAIS"
},
{
"name": "CODTIPPARC"
},
{
"name": "CONTROLE"
},
{
"name": "MARCA"
},
{
"name": "DIA"
},
{
"name": "CODGRUPONAT"
},
{
"name": "ConfiguracaoMeta_DESCRMETA"
},
{
"name": "Empresa_NOMEFANTASIA"
},
{
"name": "Produto_DESCRPROD"
},
{
"name": "GrupoProduto_DESCRGRUPOPROD"
},
{
"name": "LocalFinanceiro_DESCRLOCAL"
},
{
"name": "Projeto_IDENTIFICACAO"
},
{
"name": "CentroResultado_DESCRCENCUS"
},
{
"name": "Natureza_DESCRNAT"
},
{
"name": "Regiao_NOMEREG"
},
{
"name": "Gerente_APELIDO"
},
{
"name": "Vendedor_APELIDO"
},
{
"name": "Parceiro_NOMEPARC"
},
{
"name": "UnidadeFederativaOrigem_UF"
},
{
"name": "Cidade_NOMECID"
},
{
"name": "Pais_DESCRICAO"
},
{
"name": "Perfil_DESCRTIPPARC"
},
{
"name": "GrupoNaturezas_DESCRGRUPONAT"
}
]
}
},
"entity": [
{
"f30": {
"$": "<SEM VENDEDOR>"
},
"f10": {
"$": "0"
},
"f32": {
"$": "<SEM PARCEIRO>"
},
"f31": {
"$": "MAURA"
},
"f12": {
"$": "0"
},
"f34": {
"$": "<SEM DESCRIÇÃO>"
},
"f11": {
"$": "22"
},
"f33": {
"$": "0"
},
"f14": {
"$": "0"
},
"f36": {
"$": "<SEM TIPO PARCEIRO>"
},
"f13": {
"$": "0"
},
"f35": {
"$": "<SEM PAIS>"
},
"f0": {
"$": "196"
},
"f16": {
"$": "0"
},
"f1": {
"$": "15/10/2020"
},
"f15": {
"$": "0"
},
"f37": {
"$": "<SEM GRUPONATUREZA>"
},
"f2": {
"$": "0"
},
"f18": {},
"f3": {
"$": "0"
},
"f17": {},
"f4": {
"$": "0"
},
"f5": {
"$": "0"
},
"f19": {
"$": "15"
},
"f6": {
"$": "0"
},
"f7": {
"$": "0"
},
"f8": {
"$": "0"
},
"f9": {
"$": "0"
},
"f21": {
"$": "META DIÁRIA GENUINA"
},
"f20": {
"$": "0"
},
"f23": {
"$": "<sem descrição>"
},
"f22": {},
"f25": {
"$": "<SEM LOCAL>"
},
"f24": {
"$": "<SEM GRUPO>"
},
"f27": {
"$": "<SEM CENTRO DE RESULTADO>"
},
"f26": {
"$": "<SEM PROJETO>"
},
"f29": {
"$": "<SEM REGIAO>"
},
"f28": {
"$": "<SEM NATUREZA>"
}
}
]
}
}
}