get https://api.sankhya.com.br/ContatoCliente
Regras de negócio
Para realizar consulta de contatos de clientes no sistema ERP é necessário definir as funções do parceiro no sistema. Cada uma das possíveis definições deste campo possuem uma simbologia própria. 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/360044594494-Cadastro-de-Parceiros#abacontatos
Dependências
Não possui dependênciasDetalhes Técnicos
A entidade utilizada é a Contato que por sua vez instancia a tabela TGFCTT 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.
Na busca dos dados foi utilizado o campo CODPARC, porém também podem ser utilizados os demais campos para consulta utilizando filtro no corpo da requisição.
Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
"criteria": {
"expression": {
"$": "this.CODPARC = ?"
},
"parameter": [
{
"$": "55",
"type": "I"
}
]
}
Descritivo de campos da entidade
Acesse aqui o dicionário de dados da tabela TGFCTTExemplo 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": "Contato",
"criteria": {
"expression": {
"$": "this.CODPARC = ?"
},
"parameter": [
{
"$": "55",
"type": "I"
}
]
},
"entity": {
"fieldset": {
"list": "CODPARC,CODCONTATO,NOMECONTATO,APELIDO,TELEFONE,EMAIL"
}
}
}
}
}
Retorno em json:
{
"serviceName": "CRUDServiceProvider.loadRecords",
"status": "1",
"pendingPrinting": "false",
"transactionId": "3ED27462A3E508FCC9E77D77624E5791",
"responseBody": {
"entities": {
"total": "1",
"metadata": {
"fields": {
"field": [
{
"name": "CODPARC"
},
{
"name": "CODCONTATO"
},
{
"name": "NOMECONTATO"
},
{
"name": "APELIDO"
},
{
"name": "TELEFONE"
},
{
"name": "EMAIL"
}
]
}
},
"entity": {
"f0": {
"$": "8"
},
"f1": {
"$": "1"
},
"f2": {
"$": "CONTATO"
},
"f3": {},
"f4": {},
"f5": {}
}
}
}
}