Integração ERP: Sankhya
O Sankhya é um dos principais ERPs nacionais, amplamente utilizado por empresas brasileiras de médio e grande porte. A integração é feita via API REST Sankhya W, usando autenticação OAuth 2.0 gerenciada pelo próprio sistema.
Este artigo orienta a configuração da credencial e detalha os relatórios disponíveis deste conector. Para o passo a passo de uso no fluxo de preparação de dados — seleção do conector, credencial, relatório e parâmetros — veja o artigo Etapa ERP.
Configuração da Credencial
A autenticação é via OAuth 2.0 (Client Credentials) com a plataforma Sankhya W.
Campo | Descrição | Obrigatório |
|---|---|---|
Auth URL | URL de autenticação (padrão: | Sim |
Base URL | URL base da API (padrão: | Sim |
Client ID | ID do cliente OAuth fornecido pelo Sankhya | Sim |
Client Secret | Segredo do cliente OAuth | Sim |
X-Token | Token adicional de integração, se exigido pelo ambiente | Não |
Grant Type | Tipo de concessão (padrão: | Não |
Dica: As credenciais de integração são geradas dentro do portal Sankhya W (Configurações → Integrações → Aplicativos). O usuário do aplicativo deve ter permissão nas entidades que serão consultadas.
Relatórios Disponíveis
Módulo: Contas a Pagar
Contas a Pagar (Despesas)
Retorna os títulos a pagar (despesas financeiras) cadastrados no Sankhya.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
codigoEmpresa | Código da empresa no Sankhya | Não | — |
dataNegociacaoInicio | Data inicial de negociação. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
dataNegociacaoFinal | Data final de negociação. Preenchido automaticamente com o último dia do mês de referência | Não | — |
statusFinanceiro | Status do título | Não |
|
tipoFinanceiro | Tipo do título financeiro | Não |
|
codigoParceiro | Código do parceiro (fornecedor) para filtrar | Não | — |
sort | Campo para ordenação dos resultados | Não | — |
Campos retornados (principais):
Campo | Descrição |
|---|---|
codigoEmpresa | Código da empresa |
nomeEmpresa | Nome da empresa |
codigoFinanceiro | Código do título financeiro |
codigoParceiro | Código do parceiro |
nomeParceiro | Nome do fornecedor |
valorParcela | Valor da parcela |
valorBaixa | Valor já pago/baixado |
dataVencimento | Data de vencimento |
dataNegociacao | Data de negociação |
dataBaixa | Data do pagamento |
numeroParcela | Número da parcela |
origemFinanceiro | Origem do lançamento |
codigoTipoOperacao | Código do tipo de operação |
nomeTipoOperacao | Descrição do tipo de operação |
Módulo: Contas a Receber
Contas a Receber (Receitas)
Retorna os títulos a receber (receitas financeiras) cadastrados no Sankhya.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
codigoEmpresa | Código da empresa | Não | — |
dataNegociacaoInicio | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
dataNegociacaoFinal | Data final. Preenchido automaticamente com o último dia do mês de referência | Não | — |
statusFinanceiro | Status do título | Não |
|
tipoFinanceiro | Tipo do título | Não |
|
codigoParceiro | Código do cliente | Não | — |
sort | Campo para ordenação | Não | — |
Campos retornados (principais): Mesmos de Contas a Pagar, com dados do cliente.
Módulo: Estoque
Saldo de Estoque por Produto
Retorna o saldo de estoque por produto e local de armazenagem.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
codigoEmpresa | Código da empresa | Não |
Campos retornados:
Campo | Descrição |
|---|---|
codigoEmpresa | Código da empresa |
codigoProduto | Código do produto |
codigoLocal | Local de armazenagem |
controle | Tipo de controle (lote/série) |
estoque | Quantidade em estoque |
Módulo: Contabilidade
Balancete (DRE)
Retorna o balancete contábil com saldos iniciais, movimentos e saldos finais por conta.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
CodEmpr | Código da empresa | Não |
DtIni | Data inicial do período. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DtFim | Data final do período. Preenchido automaticamente com o último dia do mês de referência | Não |
CodCusto | Código do centro de custo para filtrar | Não |
Campos retornados:
Campo | Descrição |
|---|---|
CodEmpr | Código da empresa |
CodCta | Código da conta contábil |
DesCta | Descrição da conta |
DtIni | Data inicial |
DtFim | Data final |
VlrSalIni | Saldo inicial |
VlrDeb | Total de débitos |
VlrCred | Total de créditos |
VlrSalFim | Saldo final |
Razão Contábil (Lançamentos)
Retorna os lançamentos contábeis detalhados do razão.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
CodEmpr | Código da empresa | Não |
DtIni | Data inicial dos lançamentos. Preenchido automaticamente com o 1º dia do mês de referência | Não |
DtFim | Data final dos lançamentos. Preenchido automaticamente com o último dia do mês de referência | Não |
CodConta | Código da conta contábil para filtrar uma conta específica | Não |
Campos retornados:
Campo | Descrição |
|---|---|
CodEmpr | Código da empresa |
CodCta | Código da conta |
DesCta | Descrição da conta |
DtLanc | Data do lançamento |
NumDoc | Número do documento |
DesHist | Histórico do lançamento |
VlrDeb | Valor de débito |
VlrCred | Valor de crédito |
SaldoAcu | Saldo acumulado |
Módulo: Comercial
Movimentos (Notas Fiscais)
Retorna os movimentos comerciais (notas fiscais de entrada e saída).
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
CodEmpr | Código da empresa | Não | — |
DtNeg | Data inicial de negociação. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
DtNegFim | Data final de negociação. Preenchido automaticamente com o último dia do mês de referência | Não | — |
TipMov | Tipo de movimento | Não |
|
CodTipOper | Código do tipo de operação (TOP) | Não | — |
Campos retornados:
Campo | Descrição |
|---|---|
CodEmpr | Código da empresa |
nunota | Número único da nota |
DtNeg | Data de negociação |
CodParc | Código do parceiro |
NomParc | Nome do parceiro |
TipMov | Tipo de movimento |
CodTipOper | Tipo de operação |
VlrNota | Valor da nota |
NumNota | Número da nota fiscal |
Módulo: Parceiros
Parceiros Cadastrais
Retorna o cadastro geral de parceiros (clientes, fornecedores, transportadoras etc.).
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
Ativo | Filtrar apenas parceiros ativos | Não |
|
Cliente | Filtrar apenas clientes | Não |
|
Fornecedor | Filtrar apenas fornecedores | Não |
|
Campos retornados:
Campo | Descrição |
|---|---|
CodParc | Código do parceiro |
NomParc | Nome / Razão social |
CgcCpf | CNPJ / CPF |
Ativo | Ativo? |
Cliente | É cliente? |
Fornecedor | É fornecedor? |
NomCid | Cidade |
Módulo: Contas a Receber (API v1)
Clientes (API v1)
Retorna o cadastro detalhado de clientes pela API v1 do Sankhya.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório |
|---|---|---|
dataHoraAlteracao | Data/hora mínima de alteração para filtrar apenas clientes modificados recentemente | Não |
Campos retornados (principais):
Campo | Descrição |
|---|---|
codigoCliente | Código do cliente |
tipo | Tipo (PF/PJ) |
cnpjCpf | CNPJ / CPF |
nome | Nome / Razão social |
telefoneDdd / telefoneNumero | Telefone |
limiteCredito | Limite de crédito |
endereco.* | Endereço completo (logradouro, número, bairro, cidade, CEP, coordenadas) |
Módulo: Vendas
Pedidos de Venda
Retorna os pedidos de venda registrados no Sankhya.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
codigoEmpresa | Código da empresa | Não | — |
codigoCliente | Código do cliente | Não | — |
dataNegociacaoInicio | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
dataNegociacaoFinal | Data final. Preenchido automaticamente com o último dia do mês de referência | Não | — |
statusWMS | Status do pedido no WMS | Não |
|
situacaoWMS | Situação detalhada no WMS | Não |
|
statusConferencia | Status de conferência | Não |
|
confirmada | Pedido confirmado? | Não |
|
pendente | Pedido pendente? | Não |
|
codigoNota | Código interno da nota | Não | — |
numeroNota | Número da nota fiscal | Não | — |
Campos retornados (principais):
Campo | Descrição |
|---|---|
codigoEmpresa / nomeEmpresa | Empresa |
dataNegociacao | Data do pedido |
numeroNota / codigoNota | Identificação da nota |
confirmada / pendente | Situação |
statusWMS / situacaoWMS | Status no WMS |
codigoTipoOperacao / nomeTipoOperacao | Tipo de operação |
Módulo: Fiscal
Notas Fiscais Eletrônicas (NF-e)
Retorna as NF-e emitidas e seus respectivos status na SEFAZ.
Parâmetros de filtro:
Parâmetro | Descrição | Obrigatório | Opções |
|---|---|---|---|
codigoEmpresa | Código da empresa | Não | — |
codigoCliente | Código do cliente | Não | — |
statusNFe | Status da NF-e na SEFAZ | Não | — |
statusWMS | Status no WMS | Não |
|
dataNegociacaoInicio | Data inicial. Preenchido automaticamente com o 1º dia do mês de referência | Não | — |
dataNegociacaoFinal | Data final. Preenchido automaticamente com o último dia do mês de referência | Não | — |
confirmada | NF-e confirmada? | Não |
|
pendente | NF-e pendente? | Não |
|
Campos retornados (principais):
Campo | Descrição |
|---|---|
chaveNFe | Chave de acesso da NF-e (44 dígitos) |
statusNFe | Status na SEFAZ |
numeroProtocoloNFe | Número do protocolo de autorização |
dataProtocoloNFe | Data do protocolo |
loteNFe | Lote de envio |
numeroNota / codigoNota / serieNota | Identificação da nota |
Parâmetros Fixos (gerenciados automaticamente)
Parâmetro | Valor padrão | Motivo |
|---|---|---|
| (lista de campos pré-configurada) | Define os campos retornados para cada relatório, evitando trafegar dados desnecessários |
Artigos relacionados
Etapa ERP
Introdução às integrações
Integrações customizadas via API Rest e conectores SQL