Consulta de Bancos

Regras de negócio

Para realizar consulta de bancos no ERP, será necessário efetuar cadastro correspondente ao banco e sua nomenclatura para o qual você pode pesquisar, inserir um novo registro, exibir a tela em modo grade, entre outras possibilidades.
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/360044598894-Bancos

Dependências

Não possui dependências

Detalhes Técnicos

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

• ABREVIATURA – Abreviatura do nome do banco.

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

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

Caso deseje pesquisar por todos os bancos cadastrados, basta remover o trecho acima do json para retornar todos os bancos cadastrados.

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 TSIBCO

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": "Banco",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.ABREVIATURA = ?"
        },
        "parameter": [
           {
             "$": "BB",
             "type": "S"
           }
        ]
      },
      "entity": {
        "fieldset": {
              "list":"CODBCO,ABREVIATURA,NOMEBCO"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "43AA056D4EC5D13062174576B74FC07F",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODBCO"
                        },
                        {
                            "name": "ABREVIATURA"
                        },
                        {
                            "name": "NOMEBCO"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "1"
                },
                "f1": {
                    "$": "BB"
                },
                "f2": {
                    "$": "Banco do Brasil S.A."
                }
            }
        }
    }
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!