Consulta de Plano de contas

Regras de negócio

Para realizar a consulta e plano de contas é necessário efetuar o cadastramento das contas contábeis que irão compor o plano de contas da empresa, para que seja possível fazer a inclusão/cadastro, exclusão, consulta e pesquisa das Contas Contábeis.
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/360044608054-Plano-de-Contas

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a PlanoConta que por sua vez instancia a tabela TCBPLA 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 os campos CODCTACTB e CODEMP, porém você pode utilizar outros campos da entidade.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
    "criteria": {
      "expression": {
        "$": "this.CODCTACTB = ? and this.CODEMP = ?" 
      },
      "parameter": [
         {
           "$": "142",
           "type": "I"
         },
         {
           "$": "201",
           "type": "I"
         }
      ]
    }

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 TCBPLA

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": "PlanoConta",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODCTACTB = ? and this.CODEMP = ?" 
        },
        "parameter": [
           {
             "$": "142",
             "type": "I"
           },
           {
             "$": "201",
             "type": "I"
           }
        ]
      },                                       
      "entity": {
        "fieldset": {
          "list": "CODCTACTB,CODEMP,CTACTB,GRAU,DESCRCTA,CODCTACTBPAI,CODGRUPOCTA"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "CBBE81FDAF61695D8F66B438C03E4E55",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODCTACTB"
                        },
                        {
                            "name": "CODEMP"
                        },
                        {
                            "name": "CTACTB"
                        },
                        {
                            "name": "GRAU"
                        },
                        {
                            "name": "DESCRCTA"
                        },
                        {
                            "name": "CODCTACTBPAI"
                        },
                        {
                            "name": "CODGRUPOCTA"
                        },
                        {
                            "name": "Empresa_NOMEFANTASIA"
                        }
                    ]
                }
            },
            "entity": {
                "f6": {},
                "f7": {
                    "$": "A CONSOLIDAR 2"
                },
                "f0": {
                    "$": "142"
                },
                "f1": {
                    "$": "201"
                },
                "f2": {
                    "$": "1.01"
                },
                "f3": {
                    "$": "2"
                },
                "f4": {
                    "$": "ATIVO CIRCULANTE"
                },
                "f5": {
                    "$": "141"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!