Consulta de Volumes

Regras de negócio

A consulta de volumes visa padronizar as unidades de medida que serão utilizadas para os produtos.Como no sistema, e permitido a utilização de várias unidades de medida para o cadastro de um mesmo produto ou serviço; estas poderão ser empregadas nos lançamentos de todos os tipos de movimento,desde a compra até a venda.
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/360044597094-Unidades

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Volume que por sua vez instancia a tabela TGFVOL 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 CODVOL, porém você pode utilizar outros campos da entidade .

• CODVOL – Código do Volume(Este campo não pode ser repetido);

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:

    "criteria": {
      "expression": {
        "$": "this.CODVOL = ?" 
      },
      "parameter": [
         {
           "$": "UN",
           "type": "S"
         }
      ]
    }
    

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 TGFVOL

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": "Volume",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODVOL = ?" 
        },
        "parameter": [
           {
             "$": "UN",
             "type": "S"
           }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODVOL,DESCRVOL"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "A070530ED9138D0953A3B565FE735A7D",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODVOL"
                        },
                        {
                            "name": "DESCRVOL"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "UN"
                },
                "f1": {
                    "$": "Unidade"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!