v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Como consultar dados?

Consultas com loadRecord (para registro único)

<h1>Regras de negócio</h1> A API possui um serviço genérico para aplicar consultas em todas as Entidades disponíveis no ERP: <b>CRUDServiceProvider.loadRecord</b> com o objetivo de obter 1 registro. O escopo da requisição é mais simples que <b>CRUDServiceProvider.loadRecord</b> e exige apenas o envio dos critérios por meio da tag "rows".

<br /> <h3>Exemplo de uso:</h3>

<ul> <li>URL Gateway Produção: https://api.sankhya.com.br/</li> <li>URL Gateway Sandbox: https://api.sandbox.sankhya.com.br/</li> </ul> <b>URL de chamada</b>: https://[URL_GATEWAY]/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecord&outputType=json <br />Vejamos a seguir a estrutura completa de uma requisição do serviço loadRecords:
{
   "serviceName": "CRUDServiceProvider.loadRecord",
   "requestBody": {
      "dataSet": {
         "rootEntity": "Produto",
         "entity": [
            {
               "path": "",
               "fieldset": {
                  "list": "CODPROD, DESCRPROD"
               }
            },
            {
               "path": "GrupoProduto",
               "fieldset": {
                  "list": "CODGRUPOPROD, DESCRGRUPOPROD"
               }
            },
            {
               "path": "AliquotaIPI",
               "fieldset": {
                  "list": "CODIPI, PERCENTUAL"
               }
            }
         ],
         "rows": {
            "row": {
               "CODPROD": {
                  "$": "4"
               }
            }
         }
      }
   }
}

O retorno para esta requisição é:<br />

{
    "serviceName": "CRUDServiceProvider.loadRecord",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "2B265FCF92393625B097EDE09B031295",
    "responseBody": {
        "entities": {
            "total": "1",
            "entity": {
                "GrupoProduto_CODGRUPOPROD": {
                    "$": "10401"
                },
                "AliquotaIPI_PERCENTUAL": {
                    "$": "3"
                },
                "GrupoProduto_DESCRGRUPOPROD": {
                    "$": "REVENDA DE PRODUTO IMPORTADO"
                },
                "_rmd": {
                    "CODPROD": {
                        "$": "{\"decVlr\":2,\"decQtd\":0,\"controle\":{\"tipoContEst\":\"N\",\"listaContEst\":[\"\"],\"usaMascara\":false}}",
                        "provider": "PRODUTORMP"
                    }
                },
                "DESCRPROD": {
                    "$": "AGUA TONICA "
                },
                "CODPROD": {
                    "$": "4"
                },
                "AliquotaIPI_CODIPI": {
                    "$": "2"
                }
            }
        }
    }
}
get/loadRecord

Response

Consulta efetuada com sucesso