Academy
Conectores ERP

Integración ERP: Sankhya

Sankhya es uno de los principales ERP nacionales, ampliamente utilizado por empresas brasileñas de mediano y gran tamaño. La integración se realiza mediante API REST Sankhya W, usando autenticación OAuth 2.0 gestionada por el propio sistema.

Este artículo orienta sobre la configuración de la credencial y detalla los informes disponibles de este conector. Para ver el paso a paso de uso en el flujo de preparación de datos — selección del conector, credencial, informe y parámetros — consulte el artículo Etapa ERP.

Configuración de la credencial

La autenticación es mediante OAuth 2.0 (Client Credentials) con la plataforma Sankhya W.

Campo

Descripción

Obligatorio

Auth URL

URL de autenticación (predeterminado: https://api.sankhya.com.br/authenticate)

Sí

Base URL

URL base de la API (predeterminado: https://api.sankhya.com.br)

Sí

Client ID

ID del cliente OAuth proporcionado por Sankhya

Sí

Client Secret

Secreto del cliente OAuth

Sí

X-Token

Token adicional de integración, si lo exige el entorno

No

Grant Type

Tipo de concesión (predeterminado: client_credentials)

No

Consejo: Las credenciales de integración se generan dentro del portal Sankhya W (Configuraciones → Integraciones → Aplicaciones). El usuario de la aplicación debe tener permiso en las entidades que se consultarán.

Informes disponibles

Módulo: Cuentas por pagar

Cuentas por pagar (Gastos)

Devuelve los títulos por pagar (gastos financieros) registrados en Sankhya.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

codigoEmpresa

Código de la empresa en Sankhya

No

—

dataNegociacaoInicio

Fecha inicial de negociación. Se completa automáticamente con el 1.º día del mes de referencia

No

—

dataNegociacaoFinal

Fecha final de negociación. Se completa automáticamente con el último día del mes de referencia

No

—

statusFinanceiro

Estado del título

No

1 = Abierto, 2 = Liquidado, 3 = Parcialmente liquidado

tipoFinanceiro

Tipo del título financiero

No

1 = Normal, 2 = Anticipo, 3 = Acordado

codigoParceiro

Código del socio (proveedor) para filtrar

No

—

sort

Campo para ordenar los resultados

No

—

Campos devueltos (principales):

Campo

Descripción

codigoEmpresa

Código de la empresa

nomeEmpresa

Nombre de la empresa

codigoFinanceiro

Código del título financiero

codigoParceiro

Código del socio

nomeParceiro

Nombre del proveedor

valorParcela

Valor de la cuota

valorBaixa

Valor ya pagado/liquidado

dataVencimento

Fecha de vencimiento

dataNegociacao

Fecha de negociación

dataBaixa

Fecha de pago

numeroParcela

Número de la cuota

origemFinanceiro

Origen del registro

codigoTipoOperacao

Código del tipo de operación

nomeTipoOperacao

Descripción del tipo de operación

Módulo: Cuentas por cobrar

Cuentas por cobrar (Ingresos)

Devuelve los títulos por cobrar (ingresos financieros) registrados en Sankhya.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

codigoEmpresa

Código de la empresa

No

—

dataNegociacaoInicio

Fecha inicial. Se completa automáticamente con el 1.º día del mes de referencia

No

—

dataNegociacaoFinal

Fecha final. Se completa automáticamente con el último día del mes de referencia

No

—

statusFinanceiro

Estado del título

No

1 = Abierto, 2 = Liquidado, 3 = Parcialmente liquidado

tipoFinanceiro

Tipo del título

No

1 = Normal, 2 = Anticipo, 3 = Acordado

codigoParceiro

Código del cliente

No

—

sort

Campo para ordenar

No

—

Campos devueltos (principales): Mismos de Cuentas por pagar, con datos del cliente.

Módulo: Inventario

Saldo de inventario por producto

Devuelve el saldo de inventario por producto y ubicación de almacenamiento.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

codigoEmpresa

Código de la empresa

No

Campos devueltos:

Campo

Descripción

codigoEmpresa

Código de la empresa

codigoProduto

Código del producto

codigoLocal

Ubicación de almacenamiento

controle

Tipo de control (lote/serie)

estoque

Cantidad en inventario

Módulo: Contabilidad

Balance de comprobación (DRE)

Devuelve el balance contable con saldos iniciales, movimientos y saldos finales por cuenta.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

CodEmpr

Código de la empresa

No

DtIni

Fecha inicial del período. Se completa automáticamente con el 1.º día del mes de referencia

No

DtFim

Fecha final del período. Se completa automáticamente con el último día del mes de referencia

No

CodCusto

Código del centro de costo para filtrar

No

Campos devueltos:

Campo

Descripción

CodEmpr

Código de la empresa

CodCta

Código de la cuenta contable

DesCta

Descripción de la cuenta

DtIni

Fecha inicial

DtFim

Fecha final

VlrSalIni

Saldo inicial

VlrDeb

Total de débitos

VlrCred

Total de créditos

VlrSalFim

Saldo final

Libro mayor contable (Asientos)

Devuelve los asientos contables detallados del libro mayor.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

CodEmpr

Código de la empresa

No

DtIni

Fecha inicial de los asientos. Se completa automáticamente con el 1.º día del mes de referencia

No

DtFim

Fecha final de los asientos. Se completa automáticamente con el último día del mes de referencia

No

CodConta

Código de la cuenta contable para filtrar una cuenta específica

No

Campos devueltos:

Campo

Descripción

CodEmpr

Código de la empresa

CodCta

Código de la cuenta

DesCta

Descripción de la cuenta

DtLanc

Fecha del asiento

NumDoc

Número del documento

DesHist

Histórico del asiento

VlrDeb

Valor de débito

VlrCred

Valor de crédito

SaldoAcu

Saldo acumulado

Módulo: Comercial

Movimientos (Facturas)

Devuelve los movimientos comerciales (facturas de entrada y salida).

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

CodEmpr

Código de la empresa

No

—

DtNeg

Fecha inicial de negociación. Se completa automáticamente con el 1.º día del mes de referencia

No

—

DtNegFim

Fecha final de negociación. Se completa automáticamente con el último día del mes de referencia

No

—

TipMov

Tipo de movimiento

No

V = Venta, C = Compra, D = Devolución, T = Transferencia

CodTipOper

Código del tipo de operación (TOP)

No

—

Campos devueltos:

Campo

Descripción

CodEmpr

Código de la empresa

nunota

Número único de la factura

DtNeg

Fecha de negociación

CodParc

Código del socio

NomParc

Nombre del socio

TipMov

Tipo de movimiento

CodTipOper

Tipo de operación

VlrNota

Valor de la factura

NumNota

Número de la factura

Módulo: Socios

Socios registrados

Devuelve el registro general de socios (clientes, proveedores, transportistas, etc.).

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

Ativo

Filtrar solo socios activos

No

S = Sí, N = No

Cliente

Filtrar solo clientes

No

S = Sí, N = No

Fornecedor

Filtrar solo proveedores

No

S = Sí, N = No

Campos devueltos:

Campo

Descripción

CodParc

Código del socio

NomParc

Nombre / Razón social

CgcCpf

CNPJ / CPF

Ativo

¿Activo?

Cliente

¿Es cliente?

Fornecedor

¿Es proveedor?

Email

Correo electrónico

NomCid

Ciudad

Módulo: Cuentas por cobrar (API v1)

Clientes (API v1)

Devuelve el registro detallado de clientes mediante la API v1 de Sankhya.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

dataHoraAlteracao

Fecha/hora mínima de modificación para filtrar solo clientes modificados recientemente

No

Campos devueltos (principales):

Campo

Descripción

codigoCliente

Código del cliente

tipo

Tipo (PF/PJ)

cnpjCpf

CNPJ / CPF

nome

Nombre / Razón social

email

Correo electrónico

telefoneDdd / telefoneNumero

Teléfono

limiteCredito

Límite de crédito

endereco.*

Dirección completa (calle, número, barrio, ciudad, CEP, coordenadas)

Módulo: Ventas

Pedidos de venta

Devuelve los pedidos de venta registrados en Sankhya.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

codigoEmpresa

Código de la empresa

No

—

codigoCliente

Código del cliente

No

—

dataNegociacaoInicio

Fecha inicial. Se completa automáticamente con el 1.º día del mes de referencia

No

—

dataNegociacaoFinal

Fecha final. Se completa automáticamente con el último día del mes de referencia

No

—

statusWMS

Estado del pedido en el WMS

No

1 a 6

situacaoWMS

Situación detallada en el WMS

No

1 a 22

statusConferencia

Estado de conferencia

No

1 a 11

confirmada

¿Pedido confirmado?

No

true / false

pendente

¿Pedido pendiente?

No

true / false

codigoNota

Código interno de la factura

No

—

numeroNota

Número de la factura

No

—

Campos devueltos (principales):

Campo

Descripción

codigoEmpresa / nomeEmpresa

Empresa

dataNegociacao

Fecha del pedido

numeroNota / codigoNota

Identificación de la factura

confirmada / pendente

Situación

statusWMS / situacaoWMS

Estado en el WMS

codigoTipoOperacao / nomeTipoOperacao

Tipo de operación

Módulo: Fiscal

Facturas electrónicas (NF-e)

Devuelve las NF-e emitidas y sus respectivos estados en SEFAZ.

Parámetros de filtro:

Parámetro

Descripción

Obligatorio

Opciones

codigoEmpresa

Código de la empresa

No

—

codigoCliente

Código del cliente

No

—

statusNFe

Estado de la NF-e en SEFAZ

No

—

statusWMS

Estado en el WMS

No

1 a 6

dataNegociacaoInicio

Fecha inicial. Se completa automáticamente con el 1.º día del mes de referencia

No

—

dataNegociacaoFinal

Fecha final. Se completa automáticamente con el último día del mes de referencia

No

—

confirmada

¿NF-e confirmada?

No

true / false

pendente

¿NF-e pendiente?

No

true / false

Campos devueltos (principales):

Campo

Descripción

chaveNFe

Clave de acceso de la NF-e (44 dígitos)

statusNFe

Estado en SEFAZ

numeroProtocoloNFe

Número del protocolo de autorización

dataProtocoloNFe

Fecha del protocolo

loteNFe

Lote de envío

numeroNota / codigoNota / serieNota

Identificación de la factura

Parámetros fijos (gestionados automáticamente)

Parámetro

Valor predeterminado

Motivo

$select

(lista de campos preconfigurada)

Define los campos devueltos para cada informe, evitando transferir datos innecesarios

Artículos relacionados

  • Etapa ERP

  • Introducción a las integraciones

  • Integraciones personalizadas vía API Rest y conectores SQL

¿Te fue útil?
¿Te fue útil?