Consulta de pedidos

Regras de negócio

Permite a consulta das informações relacionadas aos pedidos de venda e permite validar os valores e condições negociadas entre empresa e parceiro.O detalhamento de cada parametrização e/ou preenchimento, deve ser verificado junto aos gestores de sua empresa e/ou consultores Sankhya.
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/360044612654-Portal-de-Vendas#oqueumpedidodevenda

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a CabecalhoNota que por sua vez instancia a tabela TGFCAB mapeando os campos principais na busca de pedidos.
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 DTNEG, porém pode ser utilizados outros campos da entidade.

• DTNEG – Data da negociação.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
              "criteria": {
                  "expression": {
                      "$": "(this.DTNEG = ? )"
                  },
                  "parameter": [
                     {
                        "$": "28/10/2016",
                        "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 TGFCAB

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": "CabecalhoNota",
              "includePresentationFields": "S",
              "offsetPage": "0",
              "criteria": {
                  "expression": {
                      "$": "(this.DTNEG = ? )"
                  },
                  "parameter": {
                      "$": "28/10/2016",
                      "type": "D"
                  }
              },
              "entity": {
                  "fieldset": {
                      "list": "NUNOTA,CODEMP,CODPARC,DTNEG"
                  }
              }
          }
      }
  }

Retorno em json:

  {
      "serviceName": "CRUDServiceProvider.loadRecords",
      "status": "1",
      "pendingPrinting": "false",
      "transactionId": "AD583F694F1AC8CD86D328EE246B7A1B",
      "responseBody": {
          "entities": {
              "total": "12",
              "hasMoreResult": "false",
              "offsetPage": "0",
              "offset": "0",
              "metadata": {
                  "fields": {
                      "field": [
                          {
                              "name": "NUNOTA"
                          },
                          {
                              "name": "CODEMP"
                          },
                          {
                              "name": "CODPARC"
                          },
                          {
                              "name": "DTNEG"
                          },
                          {
                              "name": "Empresa_NOMEFANTASIA"
                          },
                          {
                              "name": "Parceiro_NOMEPARC"
                          }
                      ]
                  }
              },
              "entity": [
                  {
                      "f0": {
                          "$": "5996"
                      },
                      "f1": {
                          "$": "2"
                      },
                      "f2": {
                          "$": "3"
                      },
                      "f3": {
                          "$": "28/10/2016"
                      },
                      "f4": {
                          "$": "EMPRESA MODELO"
                      },
                      "f5": {
                          "$": "BRASIL TECIDOS"
                      }
                  },
                  {
                      "f0": {
                          "$": "5998"
                      },
                      "f1": {
                          "$": "2"
                      },
                      "f2": {
                          "$": "3"
                      },
                      "f3": {
                          "$": "28/10/2016"
                      },
                      "f4": {
                          "$": "EMPRESA MODELO"
                      },
                      "f5": {
                          "$": "BRASIL TECIDOS"
                      }
                  }
              ]
          }
      }
  }

TESTE

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