Componente Sankhya - Dados do Cliente – Sankhya Sandbox

O componente Dados do Cliente permite consultar, dentro do fluxo do bot, os dados cadastrais de um parceiro (cliente ou fornecedor) registrados no ERP Sankhya utilizando CPF ou CNPJ como identificador principal.

bot-server: versão 1.4.0

bot-component-service: versão 1.0.0

Doc Sankhya: https://developer.sankhya.com.br/docs/operacoes-comerciais#tgfpar

Captura de Tela 2026-02-11 às 16.43.07.png

Esse componente possibilita:

Personalização do atendimento
Validações cadastrais
Regras comerciais baseadas em crédito
Automação de fluxos de venda, cobrança e suporte
Enriquecimento de dados para integrações posteriores

Os dados retornados são armazenados em uma variável do fluxo e podem ser reutilizados em qualquer etapa subsequente do bot.

Índice:

Objetivo do componente
Integração técnica
Configuração no construtor de bot
Parâmetros de entrada
CPF/CNPJ (Obrigatório)
Armazenamento
Variável de armazenamento
Variável de Escopo global
Estrutura do retorno
Exemplo completo
Descrição dos campos retornados
Informações básicas
Informações de crédito
Informações de contato
Endereço
Mapeamento técnico Sankhya
Boas práticas
Segurança e performance
Dependências técnicas
Exemplo de fluxo
Retorno de erro

Objetivo do componente

Centralizar e disponibilizar, dentro do Construtor de Bot Neppo, informações oficiais do cadastro do cliente no Sankhya para suportar automações conversacionais inteligentes.

Integração técnica

A consulta é realizada via integração com serviços internos Neppo responsáveis pela comunicação com o Sankhya.

Os dados são obtidos principalmente da tabela:

TGFPAR – Cadastro de Parceiros

E também de tabelas relacionadas:

TSIEND – Endereços
TSICID – Cidade
TSIBAI – Bairro

Configuração no construtor de bot

Parâmetros de entrada

CPF/CNPJ (Obrigatório)

Documento do cliente utilizado como chave de busca no Sankhya.

Exemplo:

Armazenamento

Variável de armazenamento

Define onde o retorno da consulta será salvo.

Exemplo:

Variável de Escopo global

Quando habilitada:

Torna os dados acessíveis em todo o fluxo
Permite reutilização em múltiplos componentes
Evita novas consultas desnecessárias

Estrutura do retorno

Exemplo completo

Descrição dos campos retornados

Informações básicas

Campo	Descrição
found	Indica se o cliente foi encontrado
code	Código do parceiro
document	CPF ou CNPJ
type	F (Pessoa Física) / J (Pessoa Jurídica)
name	Nome do parceiro
tradeName	Razão social
gender	Sexo
birthDate	Data nascimento ou fundação
active	Cliente ativo
hasSupplier	Indica se também é fornecedor
stateRegistration	Inscrição estadual

Informações de crédito

Campo	Descrição
creditLine	Limite de crédito cadastrado
authGroup	Grupo de autorização

Informações de contato

Campo	Descrição
phoneNumber	Telefone fixo
cellphoneOrFaxNumber	Celular ou Fax
email	Email principal
nfseEmail	Email NFS-e
cteEmail	Email CT-e
deliveryNotificationEmail	Email notificações de entrega

Endereço

Campo	Descrição
streetType	Tipo do logradouro
streetName	Nome do logradouro
number	Número
complement	Complemento
neighborhood	Bairro
city	Cidade
state	UF
postalCode	CEP
latitude	Latitude
longitude	Longitude

Mapeamento técnico Sankhya

Campo JSON	Campo Sankhya	Tabela	Comentário
`data.code`	Cód. Parceiro	TGFPAR.CODPARC	Identificador único
`data.document`	CPF/CNPJ	TGFPAR.CGC_CPF	Documento do cliente
`data.type`	Tipo de Pessoa	TGFPAR.TIPPESSOA	F: Física, J: Jurídica
`data.name`	Nome Parceiro	TGFPAR.NOMEPARC	Nome completo
`data.tradeName`	Razão Social	TGFPAR.RAZAOSOCIAL	Nome fantasia
`data.gender`	Sexo	TGFPAR.SEXO	M, F, ou null
`data.birthDate`	Data Nascimento	TGFPAR.DTNASC	Pessoa física ou fundação
`data.authGroup`	Grupo Autorização	TGFPAR.GRUPOAUTOR	Controle de acesso
`data.active`	Cliente Ativo	TGFPAR.CLIENTE	true/false
`data.hasSupplier`	Fornecedor	TGFPAR.FORNECEDOR	true/false
`data.creditLine`	Limite de Crédito	TGFPAR.LIMCRED	Valor R$
`data.stateRegistration`	Insc. Estadual	TGFPAR.IDENTINSCESTAD	ou “ISENTO”
`data.contact.phoneNumber`	Telefone	TGFPAR.TELEFONE	Fixo
`data.contact.cellphoneOrFaxNumber`	Celular/Fax	TGFPAR.FAX	Celular principal
`data.contact.email`	Email	TGFPAR.EMAIL	Contato
`data.contact.nfseEmail`	Email NFSe	TGFPAR.EMAILNFSE	Específico para nota
`data.contact.cteEmail`	Email CTe	TGFPAR.EMAILCTE	Específico para transporte
`data.contact.deliveryNotificationEmail`	Email Entrega	TGFPAR.EMAILNOTIFENTREGA	Confirmações
`data.address.streetName`	Endereço	TSIEND.NOMEEND	Nome da rua
`data.address.streetType`	Prefixo (Av/Rua)	TSIEND.TIPO	Ex: “Av”
`data.address.number`	Número	TGFPAR.NUMEND	n°
`data.address.complement`	Complemento	TGFPAR.COMPLEMENTO	Sala, bloco, etc.
`data.address.neighborhood`	Bairro	TSIBAI.NOMEBAI	Bairro do endereço
`data.address.city`	Cidade	TSICID.NOMECID	Nome da cidade
`data.address.state`	UF	TSICID.UF	Estado
`data.address.postalCode`	CEP	TGFPAR.CEP	Código postal
`data.address.latitude`	Latitude	TGFPAR.LATITUDE	Coordenada geográfica
`data.address.longitude`	Longitude	TGFPAR.LONGITUDE	Coordenada geográfica

Boas práticas

Validar CPF/CNPJ antes da consulta
Evitar múltiplas chamadas desnecessárias
Utilizar escopo global quando aplicável
Sempre prever fallback para cliente não encontrado

Segurança e performance

Dados respeitam permissões do ERP
Consulta realizada via APIs autenticadas
Cache recomendado para fluxos intensivos

Dependências técnicas

Integração Sankhya habilitada
Credenciais configuradas
Permissão de leitura do cadastro de parceiros

Exemplo de fluxo

Retorno de erro

Dados Cliente com CPF/CNPJ incorreto
Quando o CPF/CNPJ informado estiver em formato inválido (ex.: curto, com caracteres incorretos ou fora do padrão), a API retorna found=false e traz um objeto de erro indicando validação.

Dados Cliente com CPF não cadastrado na base
Quando o CPF/CNPJ estiver válido, mas não existir registro na base, a API retorna found=false sem erro (erro null), indicando ausência de cadastro.

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 0

Pesquisa

Resolva em até 2 minutos com a Bia!

Componente Sankhya - Dados do Cliente