Consulta de Contas Bancárias

Regras de negócio

Dado que o usuário precisa cadastrar uma nova conta bancária. Quando a empresa houver uma nova conta, para recebimentos\pagamentos então este será efetivado o cadastro.
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 ContaBancaria que por sua vez instancia a tabela TSICTA 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 CODPARC, porém você pode utilizar outros campos da entidade .

• CODPARC – Código do Parceiro.
• CODEMP – Código da Empresa.
• CODBCO – Código do Banco.
• CODAGE – Código da Agência.
• CODCTABCO – Número da conta bancária.
• DESCRICAO – Descrição da conta.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
              "criteria": {
                "expression": {
                  "$": "this.CODPARC = ?"
                },
                "parameter": [
                   {
                     "$": "539",
                     "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 TSICTA

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": "ContaBancaria",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODPARC = ?"
        },
        "parameter": [
           {
             "$": "539",
             "type": "I"
           }
        ]
      },
      "entity": {
        "fieldset": {
              "list":"DESCRICAO,CODBCO,CODAGE,CODCTABCO,CODPARC,CODEMP"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "AED0B597895BFACA992B8B9597B3FC56",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "DESCRICAO"
                        },
                        {
                            "name": "CODBCO"
                        },
                        {
                            "name": "CODAGE"
                        },
                        {
                            "name": "CODCTABCO"
                        },
                        {
                            "name": "CODPARC"
                        },
                        {
                            "name": "CODEMP"
                        },
                        {
                            "name": "CODCTABCOINT"
                        }
                    ]
                }
            },
            "entity": {
                "f6": {
                    "$": "5"
                },
                "f0": {
                    "$": "005-Conta Banco do Brasil"
                },
                "f1": {
                    "$": "1"
                },
                "f2": {
                    "$": "10014"
                },
                "f3": {
                    "$": "005"
                },
                "f4": {
                    "$": "539"
                },
                "f5": {
                    "$": "1"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!