Academy
ERP Connectors

ERP Integration: Sankhya

Sankhya is one of the leading ERP systems in Brazil, widely used by medium and large Brazilian companies. The integration is done via Sankhya W REST API, using OAuth 2.0 authentication managed by the system itself.

This article guides you through setting up the credential and details the reports available for this connector. For the step-by-step use in the data preparation flow — selecting the connector, credential, report, and parameters — see the ERP Step article.


Credential Setup

Authentication is via OAuth 2.0 (Client Credentials) with the Sankhya W platform.

Field

Description

Required

Auth URL

Authentication URL (default: https://api.sankhya.com.br/authenticate)

Yes

Base URL

API base URL (default: https://api.sankhya.com.br)

Yes

Client ID

OAuth client ID provided by Sankhya

Yes

Client Secret

OAuth client secret

Yes

X-Token

Additional integration token, if required by the environment

No

Grant Type

Grant type (default: client_credentials)

No

Tip: Integration credentials are generated inside the Sankhya W portal (Settings → Integrations → Applications). The application user must have permission for the entities that will be queried.


Available Reports

Module: Accounts Payable


Accounts Payable (Expenses)

Returns the payable titles (financial expenses) registered in Sankhya.

Filter parameters:

Parameter

Description

Required

Options

codigoEmpresa

Company code in Sankhya

No

dataNegociacaoInicio

Negotiation start date. Automatically filled with the 1st day of the reference month

No

dataNegociacaoFinal

Negotiation end date. Automatically filled with the last day of the reference month

No

statusFinanceiro

Title status

No

1 = Open, 2 = Settled, 3 = Partially settled

tipoFinanceiro

Financial title type

No

1 = Normal, 2 = Advance, 3 = Agreed

codigoParceiro

Partner code (supplier) to filter

No

sort

Field to sort the results

No

Returned fields (main):

Field

Description

codigoEmpresa

Company code

nomeEmpresa

Company name

codigoFinanceiro

Financial title code

codigoParceiro

Partner code

nomeParceiro

Supplier name

valorParcela

Installment amount

valorBaixa

Amount already paid/settled

dataVencimento

Due date

dataNegociacao

Negotiation date

dataBaixa

Payment date

numeroParcela

Installment number

origemFinanceiro

Entry origin

codigoTipoOperacao

Operation type code

nomeTipoOperacao

Operation type description


Module: Accounts Receivable


Accounts Receivable (Revenue)

Returns the receivable titles (financial revenue) registered in Sankhya.

Filter parameters:

Parameter

Description

Required

Options

codigoEmpresa

Company code

No

dataNegociacaoInicio

Initial date. Automatically filled with the 1st day of the reference month

No

dataNegociacaoFinal

Final date. Automatically filled with the last day of the reference month

No

statusFinanceiro

Title status

No

1 = Open, 2 = Settled, 3 = Partially settled

tipoFinanceiro

Title type

No

1 = Normal, 2 = Advance, 3 = Agreed

codigoParceiro

Customer code

No

sort

Field to sort

No

Returned fields (main): Same as Accounts Payable, with customer data.


Module: Inventory


Inventory Balance by Product

Returns the inventory balance by product and storage location.

Filter parameters:

Parameter

Description

Required

codigoEmpresa

Company code

No

Returned fields:

Field

Description

codigoEmpresa

Company code

codigoProduto

Product code

codigoLocal

Storage location

controle

Control type (batch/serial)

estoque

Stock quantity


Module: Accounting


Trial Balance (Income Statement)

Returns the accounting trial balance with opening balances, movements, and closing balances by account.

Filter parameters:

Parameter

Description

Required

CodEmpr

Company code

No

DtIni

Start date for the period. Automatically filled with the 1st day of the reference month

No

DtFim

End date for the period. Automatically filled with the last day of the reference month

No

CodCusto

Cost center code to filter

No

Returned fields:

Field

Description

CodEmpr

Company code

CodCta

Accounting account code

DesCta

Account description

DtIni

Start date

DtFim

End date

VlrSalIni

Opening balance

VlrDeb

Total debits

VlrCred

Total credits

VlrSalFim

Closing balance


Accounting Ledger (Entries)

Returns the detailed accounting ledger entries.

Filter parameters:

Parameter

Description

Required

CodEmpr

Company code

No

DtIni

Start date of the entries. Automatically filled with the 1st day of the reference month

No

DtFim

End date of the entries. Automatically filled with the last day of the reference month

No

CodConta

Accounting account code to filter a specific account

No

Returned fields:

Field

Description

CodEmpr

Company code

CodCta

Account code

DesCta

Account description

DtLanc

Entry date

NumDoc

Document number

DesHist

Entry description

VlrDeb

Debit amount

VlrCred

Credit amount

SaldoAcu

Accumulated balance


Module: Sales


Sales Orders

Returns the sales orders recorded in Sankhya.

Filter parameters:

Parameter

Description

Required

Options

codigoEmpresa

Company code

No

codigoCliente

Customer code

No

dataNegociacaoInicio

Initial date. Automatically filled with the 1st day of the reference month

No

dataNegociacaoFinal

Final date. Automatically filled with the last day of the reference month

No

statusWMS

Order status in WMS

No

1 to 6

situacaoWMS

Detailed status in WMS

No

1 to 22

statusConferencia

Checking status

No

1 to 11

confirmada

Order confirmed?

No

true / false

pendente

Pending order?

No

true / false

codigoNota

Internal note code

No

numeroNota


Invoice number


No

Returned fields (main):

Field

Description

codigoEmpresa / nomeEmpresa

Company

dataNegociacao

Order date

numeroNota / codigoNota

Note identification

confirmada / pendente

Status

statusWMS / situacaoWMS

Status in WMS

codigoTipoOperacao / nomeTipoOperacao

Operation type

Module: Fiscal

Electronic Invoices (NF-e)

Returns the issued NF-e and their respective status in SEFAZ.

Filter parameters:

Parameter

Description

Required

Options

codigoEmpresa

Company code

No

codigoCliente

Customer code

No

statusNFe

NF-e status in SEFAZ

No

statusWMS


Status in WMS


No

1 to 6

dataNegociacaoInicio

Initial date. Automatically filled with the 1st day of the reference month

No

dataNegociacaoFinal

Final date. Automatically filled with the last day of the reference month

No

confirmada

NF-e confirmed?

No

true / false

pendente

Pending NF-e?

No

true / false

Returned fields (main):

Field

Description

chaveNFe

NF-e access key (44 digits)

statusNFe

Status in SEFAZ

numeroProtocoloNFe

Authorization protocol number

dataProtocoloNFe


Protocol date


loteNFe

Submission batch

numeroNota / codigoNota / serieNota

Note identification

Fixed Parameters (managed automatically)

Parameter

Default value

Reason

$select

(preconfigured field list)

Defines the fields returned for each report, avoiding unnecessary data transfer

Related articles

ERP Step

Introduction to integrations

Custom integrations via REST API and SQL connectors

dataNegociacaoInicio

Start date. Filled in automatically with the 1st day of the reference month

No

dataNegociacaoFinal

End date. Filled in automatically with the last day of the reference month

No

statusWMS

Order status in the WMS

No

1 to 6

situacaoWMS

Detailed status in the WMS

No

1 to 22

statusConferencia

Conference status

No

1 to 11

confirmada

Order confirmed?

No

true / false

pendente

Order pending?

No

true / false

codigoNota

Internal invoice code

No

numeroNota

Invoice number

No

Returned fields (main):

Field

Description

codigoEmpresa / nomeEmpresa

Company

dataNegociacao

Order date

numeroNota / codigoNota

Invoice identification

confirmada / pendente

Status

statusWMS / situacaoWMS

Status in the WMS

codigoTipoOperacao / nomeTipoOperacao

Operation type


Module: Fiscal


Electronic Invoices (NF-e)

Returns the issued NF-e and their respective statuses in SEFAZ.

Filter parameters:

Parameter

Description

Required

Options

codigoEmpresa

Company code

No

codigoCliente

Customer code

No

statusNFe

NF-e status in SEFAZ

No

statusWMS

Status in the WMS

No

1 to 6

dataNegociacaoInicio

Start date. Filled in automatically with the 1st day of the reference month

No

dataNegociacaoFinal

End date. Filled in automatically with the last day of the reference month

No

confirmada

NF-e confirmed?

No

true / false

pendente

NF-e pending?

No

true / false

Returned fields (main):

Field

Description

chaveNFe

NF-e access key (44 digits)

statusNFe

Status in SEFAZ

numeroProtocoloNFe

Authorization protocol number

dataProtocoloNFe

Protocol date

loteNFe

Submission batch

numeroNota / codigoNota / serieNota

Invoice identification


Fixed parameters (managed automatically)

Parameter

Default value

Reason

$select

(preconfigured field list)

Defines the fields returned for each report, avoiding unnecessary data transfer


  • ERP Step

  • Introduction to integrations

  • Custom integrations via REST API and SQL connectors

Was this helpful?