Consulta de Promoções - Produtos

Regras de negócio

O ERP permite o cadastro de descontos, restringindo este por "produto/serviço", "grupo de produto" ou "Todos", sendo que quando definido com esta última opção, todos os produtos sem exceção serão "afetados" pelo desconto configurado.Para que o processo seja validado é importante efetuar as devidas configurações no ERP e informar o produto para o qual será concedido o desconto.
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/360044600034-Descontos-Promocionais

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Desconto que por sua vez instancia a tabela TGFDES 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 foram utilizados como filtro os campos CODPROD,DTINICIAL e DTFINAL para poder pesquisar as promoções cadastradas por Produto e por período de vigência da Promoção, porém você pode utilizar outros campos da entidade. .

• CODPROD – Código do Produto.
• DTINICIAL – Data Inicial.
• DTFINAL – Data Final.
Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
      "criteria": {
        "expression": {
          "$": "this.CODPROD = ? AND this.DTINICIAL = ? AND this.DTFINAL = ?"                        
        },
        "parameter": [
          {
            "$": "542",
            "type": "I"
          },
          {
            "$": "15/03/2020",
            "type": "D"
          },
          {
            "$": "31/03/2020",
            "type": "D"
          }
        ]
      }

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 TGFDES

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": "Desconto",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODPROD = ? AND this.DTINICIAL = ? AND this.DTFINAL = ?"                        
        },
        "parameter": [
          {
            "$": "542",
            "type": "I"
          },
          {
            "$": "15/03/2020",
            "type": "D"
          },
          {
            "$": "31/03/2020",
            "type": "D"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "DTINICIAL,DTFINAL,CODPROD,VLRDESC,CODEMP,NUPROMOCAO,DESCRPROMOCAO"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "9F5C7EB92A2865760E33F886DE469E57",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "DTINICIAL"
                        },
                        {
                            "name": "DTFINAL"
                        },
                        {
                            "name": "CODPROD"
                        },
                        {
                            "name": "VLRDESC"
                        },
                        {
                            "name": "CODEMP"
                        },
                        {
                            "name": "NUPROMOCAO"
                        },
                        {
                            "name": "DESCRPROMOCAO"
                        },
                        {
                            "name": "Produto_DESCRPROD"
                        },
                        {
                            "name": "Empresa_NOMEFANTASIA"
                        }
                    ]
                }
            },
            "entity": {
                "f6": {
                    "$": "CALCULADORA EMPRESA 1"
                },
                "f7": {
                    "$": "CALCULADORA HP12"
                },
                "f8": {
                    "$": "WCS PRESTAÇÃO DE SERVIÇOS"
                },
                "f0": {
                    "$": "15/03/2020"
                },
                "f1": {
                    "$": "31/03/2020"
                },
                "f2": {
                    "$": "542"
                },
                "f3": {
                    "$": "0"
                },
                "f4": {
                    "$": "1"
                },
                "f5": {
                    "$": "301"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!