Skip to main content
Linx Microvix is a retail ERP from Linx, widely used by Brazilian retail chains and franchise networks to run stores, stock, sales and finance. Its “Web Service de Saída Padrão” exposes the registrations and movements of every store in a portal, which Nekt uses to bring your sales, product, customer, stock and financial data into the Lakehouse.

​
Before you start

The Web Service de Saída Padrão is a paid, separately contracted service from Linx. Before configuring the source, confirm with Linx that it is activated for your portal — during activation Linx provides the access key and the group name required below.
Linx documents that integration keys generating excessive traffic may be deactivated without prior notice. This connector follows the vendor’s recommended pattern: it reads incrementally by row version and paces its requests. Avoid forcing repeated full re-extractions.

​
Configuring Linx Microvix as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Linx Microvix option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

The following configurations are available:
  • Access Key: the chave provided by Linx when the Web Service de Saída Padrão was activated for your portal. It is a unique identifier such as 7d73503f-db26-4112-ac66-94033ac4986p.
  • Group Name: the name of the group registered by Linx at activation. Nekt uses it to list every store (CNPJ) of your group or franchise network.
  • Portal ID: only required when your access key serves more than one portal in Microvix.
  • Store CNPJs: restrict the extraction to specific stores. Leave it empty to extract every store returned for your group.
  • Start Date: (Default: 2000-01-01) lower bound for the date filters that some Linx methods require. The default covers the full history on the first sync.
  • Inventory Date: (Default: the day the sync runs) the date used to read the stock position in the Product Inventory stream.
  • Start Row Version: (Default: 0) the Microvix row version to start reading from on the first sync. Leave it at 0 to load the full history once.
  • Portal-wide Extraction: (Default: false) reads the whole portal in a single pass for the methods that support it (movements, invoices, sales and purchase orders, cash movements) instead of querying store by store. It is much faster for large chains, but it only covers the portal your access key belongs to — leave it disabled if your group spans more than one portal.
  • Interval Between Requests: (Default: 0.2 seconds) the pause applied between requests. Lower it only with care, given the traffic warning above.
  • Use Acceptance Portal: (Default: false) connects to the Linx acceptance (homologação) environment instead of production.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Your access key is scoped to the Microvix modules your company contracted. If a selected stream belongs to a module you don’t have, Nekt logs that the table was skipped and continues with the remaining streams.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
How incremental sync works

Microvix does not expose an “updated at” date that can be trusted across all routines. Instead, every record carries a timestamp column, which despite the name is not a date: it is a SQL Server row version, a counter that increases on every database operation. Nekt uses it exactly as Linx recommends: each extraction asks for the records above the highest row version already retrieved, and stores the new highest value for the next run. This keeps extractions small and avoids re-reading history, which is what protects your integration key from being throttled. A few streams (Store Groups, Product Inventory, Customer Contacts, Payment Plan Card Brands) carry no row version and are therefore always extracted as full tables.

​
Streams and Fields

Below you’ll find all available data streams from Linx Microvix and their corresponding fields:

​
Stores and portal structure

Every store (CNPJ) that belongs to the contracted group or franchise network.Source method: LinxGrupoLojas. Full table sync (this method returns no row version).Primary key: portal, cnpjFields:
  • cnpj - CNPJ (Brazilian tax ID) of the store
  • nome_empresa - Store name
  • id_empresas_rede - Chain code in Microvix
  • rede - Chain name in Microvix
  • portal - Portal code in Microvix
  • nome_portal - Portal name in Microvix
  • empresa - Company code within the portal
  • lojas_proprias - Whether the portal belongs to the chain’s own stores
  • classificacao_portal - Portal classification
Registration data of each store of the portal.Source method: LinxLojas. Incremental sync on the timestamp row version.Primary key: portal, empresaFields:
  • portal - Portal code in Microvix
  • empresa - Company code in Microvix
  • nome_emp - Trade name of the company
  • razao_emp - Legal company name
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • inscricao_emp - State tax registration number
  • endereco_emp - Street address
  • num_emp - Street number of the address
  • complement_emp - Address complement
  • bairro_emp - Neighbourhood
  • cep_emp - Postal code (CEP)
  • cidade_emp - City
  • estado_emp - State abbreviation (UF)
  • fone_emp - Phone number of the customer
  • email_emp - Email address
  • cod_ibge_municipio - IBGE code of the municipality
  • data_criacao_emp - Date the company was created in Microvix
  • data_criacao_portal - Date the portal was created in Microvix
  • sistema_tributacao - Taxation regime of the company
  • regime_tributario - Tax regime of the company
  • area_empresa - Floor area of the store in square metres
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • sigla_empresa - Short code of the company
  • id_classe_fiscal - Identifier of the fiscal class attached to the company
  • centro_distribuicao - Whether the store is a distribution centre
  • inscricao_municipal_emp - Municipal tax registration number of the company
  • cnae_emp - CNAE economic activity code of the company
  • cod_cliente_linx - Linx ERP customer/supplier code of the store
  • tabela_preco_preferencial - Code of the company’s preferred price table in Microvix
  • subrede - Name of the subchain
  • produto_disponivel_empresa - Whether the portal differentiates products between companies
  • id_grupo - Identifier of the group

​
Sales movements

Sales and purchase movements, one row per item of each fiscal invoice or sales ticket.Source method: LinxMovimento. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, transacao, ordemFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • transacao - Internal Microvix code
  • usuario - User that performed the movement
  • documento - Fiscal document number
  • chave_nf - Access key of the fiscal invoice (NF-e)
  • ecf - Fiscal printer (ECF) number
  • numero_serie_ecf - Serial number of the fiscal printer (ECF)
  • modelo_nf - Fiscal invoice model code
  • data_documento - Date the record was generated in Microvix
  • data_lancamento - Date the fiscal document was posted
  • codigo_cliente - Customer code in Microvix
  • serie - Series of the document
  • desc_cfop - Description of the fiscal CFOP
  • id_cfop - Code of the fiscal CFOP
  • cod_vendedor - Salesperson code in Microvix
  • quantidade - Quantity of the product
  • preco_custo - Cost price of the product
  • valor_liquido - Net amount of the product
  • desconto - Discount applied to the sale
  • cst_icms - ICMS tax situation code (CST)
  • cst_pis - PIS tax situation code (CST)
  • cst_cofins - COFINS tax situation code (CST)
  • cst_ipi - IPI tax situation code (CST)
  • valor_icms - ICMS tax amount
  • aliquota_icms - ICMS tax rate
  • base_icms - ICMS tax base amount
  • valor_pis - PIS tax amount
  • aliquota_pis - PIS tax rate
  • base_pis - PIS tax base amount
  • valor_cofins - COFINS tax amount
  • aliquota_cofins - COFINS tax rate
  • base_cofins - COFINS tax base amount
  • valor_icms_st - ICMS ST tax amount
  • aliquota_icms_st - ICMS ST tax rate
  • base_icms_st - ICMS ST tax base amount
  • valor_ipi - IPI tax amount
  • aliquota_ipi - IPI tax rate
  • base_ipi - IPI tax base amount
  • valor_total - Total amount of the item
  • forma_dinheiro - Whether the sale was paid in cash
  • total_dinheiro - Total amount paid in cash
  • forma_cheque - Whether the sale was paid by cheque
  • total_cheque - Total amount paid by cheque
  • forma_cartao - Whether the sale was paid by card
  • total_cartao - Total amount paid by card
  • forma_crediario - Whether the sale was paid with store credit (crediário)
  • total_crediario - Total amount paid with store credit (crediário)
  • forma_convenio - Whether the sale was paid through a corporate agreement (convênio)
  • total_convenio - Total amount paid through a corporate agreement (convênio)
  • frete - Freight amount
  • tipo_transacao - Operation of the movement: E inbound, S outbound, DE inbound return, DS outbound return, N neutral, C receipt-replacing invoice
  • cod_produto - Service order role of the movement: A for service order billing, O for service order consumption write-off, empty to consider only the operation
  • cod_barra - Barcode of the product
  • cancelado - Whether the document is cancelled (S) or valid (N)
  • excluido - Whether the record was deleted (S) or is valid (N)
  • soma_relatorio - Whether the movement uses an operation nature that is excluded from report totals
  • deposito - Name of the warehouse
  • obs - Note about the document
  • preco_unitario - Unit price of the item at the time of sale
  • hora_lancamento - Time the movement was posted
  • natureza_operacao - Description of the operation nature
  • tabela_preco - Code of the price table used
  • nome_tabela_preco - Name of the price table
  • cod_sefaz_situacao - Status code of the document at SEFAZ
  • desc_sefaz_situacao - Description of the document status at SEFAZ
  • protocolo_aut_nfe - Authorisation protocol of the fiscal invoice for outbound operations
  • dt_update - Timestamp of the last update of the record in the database, including cancellations
  • forma_cheque_prazo - Whether the sale was paid by post-dated cheque
  • total_cheque_prazo - Total amount paid by post-dated cheque
  • cod_natureza_operacao - Code of the operation nature
  • preco_tabela_epoca - Price of the product at the time of sale according to the default price table
  • desconto_total_item - Discount amount applied to the item
  • conferido - Whether the transfer note was checked: S for yes, N for no
  • transacao_pedido_venda - Transaction number of the related sales order
  • codigo_modelo_nf - Code of the fiscal invoice model
  • acrescimo - Surcharge applied to the sale
  • mob_checkout - Whether the sale was made through the mobile checkout
  • aliquota_iss - ISS tax rate
  • base_iss - ISS tax base amount
  • ordem - Sequence of the item within the transaction in the ERP
  • codigo_rotina_origem - Code of the ERP routine that originated the record
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • troco - Change given for the cash payment
  • transportador - Code of the carrier registered in Microvix
  • icms_aliquota_desonerado - ICMS exemption tax rate
  • icms_valor_desonerado_item - ICMS exemption amount for the item
  • empresa - Company code within the portal
  • desconto_item - Discount applied to the item
  • aliq_iss - ISS tax rate
  • iss_base_item - Base amount of the item
  • despesas - Expense amount
  • seguro_total_item - Total insurance charged to the item
  • acrescimo_total_item - Total surcharge applied to the item
  • despesas_total_item - Total expenses charged to the item
  • forma_pix - Whether the sale was paid by Pix
  • total_pix - Total amount paid by Pix
  • forma_deposito_bancario - Whether the sale was paid by bank deposit
  • total_deposito_bancario - Total amount paid by bank deposit
  • id_venda_produto_b2c - Identifier of the product sale in the B2C channel
  • item_promocional - Whether the item is part of a promotion
  • acrescimo_item - Surcharge applied to the item
  • icms_st_antecipado_aliquota - Anticipated ICMS ST tax rate
  • icms_st_antecipado_margem - Anticipated ICMS ST margin
  • icms_st_antecipado_percentual_reducao - Reduction percentage of the anticipated ICMS ST
  • icms_st_antecipado_valor_item - Anticipated ICMS ST amount for the item
  • icms_base_desonerado_item - ICMS exemption base amount for the item
  • codigo_status_nfe - Status code of the electronic invoice (NF-e)
  • preco_produto_epoca - Price of the product before any promotional discount
  • ficha - Card (ficha) number
  • numero_sequencial_pos - Sequential number of the POS terminal
  • dt_insert - Date the record was inserted into the ERP database
  • custo_medio_epoca - Average cost of the product at the time the entry was posted
  • conhecimento - Freight bill of lading
Payment plans used to settle each movement.Source method: LinxMovimentoPlanos. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, identificador, planoFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • identificador - Identifier that groups the records belonging to the same fiscal document
  • plano - Internal payment plan code in Microvix
  • desc_plano - Description of the payment plan
  • total - Total amount settled through the payment plan
  • qtde_parcelas - Number of instalments
  • indice_plano - Index of the payment plan applied to the movement
  • cod_forma_pgto - Code of the payment method
  • forma_pgto - Name of the payment method
  • tipo_transacao - Card payment type: D for debit, C for credit
  • taxa_financeira - Financial fee percentage charged by the card administrators
  • ordem_cartao - Sequence of the card (1, 2, 3, …); only filled for card payment plans
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • empresa - Company code within the portal
Card transactions captured on each sales movement.Source method: LinxMovimentoCartoes. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, identificador, ordem_cartaoFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • codlojasitef - Sitef store code
  • data_lancamento - Date the document was posted
  • identificador - Identifier of the movement
  • cupomfiscal - Fiscal receipt number
  • credito_debito - Card transaction type: C for credit, D for debit
  • id_cartao_bandeira - Identifier of the card brand registry
  • descricao_bandeira - Description of the card brand used
  • valor - Amount charged to the card
  • ordem_cartao - Sequence number of the card when several cards are used
  • nsu_host - Host NSU (unique sequential number) of the transaction
  • nsu_sitef - Sitef NSU (unique sequential number) of the transaction
  • cod_autorizacao - Authorisation code of the transaction
  • id_antecipacoes_financeiras - Identifier of the financial advance, when there is one
  • texto_comprovante - Receipt text printed for the card transaction
  • id_maquineta_pos - Identifier of the card terminal registry (non-TEF)
  • descricao_maquineta - Description given to the card terminal
  • serie_maquineta - Serial number of the card terminal
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • cartao_prepago - Whether a prepaid card was used
  • transacao_cancelada_smartpos - Whether the SmartPOS transaction was cancelled
  • usuario_cancelamento_transacao_smartpos - User that cancelled the SmartPOS transaction
  • data_hora_cancelamento_transacao_smartpos - Date the SmartPOS transaction was cancelled
Exchange vouchers applied to sales movements.Source method: LinxMovimentoTrocas. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, identificador, num_valeFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • identificador - Identifier that groups the records belonging to the same fiscal document
  • num_vale - Number of the exchange voucher
  • valor_vale - Amount of the exchange voucher
  • motivo - Description of the reason for the exchange
  • doc_origem - Number of the source document related to the return
  • serie_origem - Series of the source document related to the return
  • doc_venda - Number of the document related to the sale
  • serie_venda - Series related to the sale
  • excluido - Whether the exchange was deleted
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • desfazimento - Set to 1 when the exchange has a null identifier, a negative balance and doc_venda equal to 0
  • empresa - Company code within the portal
  • vale_cod_cliente - Code of the customer of the sale where the standalone credit voucher was used as payment
  • vale_codigoproduto - Product code recorded on the exchange voucher
  • id_vale_ordem_servico_externa - Identifier of the external service order voucher
  • doc_venda_origem - Source sale document, shown for nationwide exchange operations
  • serie_venda_origem - Source sale series, shown for nationwide exchange operations
  • cod_cliente - Code of the customer chosen when the standalone credit voucher was created
  • data_vencimento - Expiry date of the exchange voucher
  • valor_original - Original amount of the exchange voucher; negative when it offsets a balance
  • id_antecipacoes_financeiras - Identifier of the financial advance in the antecipacoes_financeiras table
Promotional campaigns applied to sales movements.Source method: LinxMovimentoAcoesPromocionais. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, identificador, id_acoes_promocionaisFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • identificador - Identifier that groups the records belonging to the same fiscal document
  • transacao - Internal Microvix code
  • id_acoes_promocionais - Code of the promotional campaign
  • desconto_item - Discount amount granted by the promotional campaign
  • quantidade - Number of promotional campaigns applied to the sale
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key

​
Products and stock

Product catalogue of the portal.Source method: LinxProdutos. Incremental sync on the timestamp row version.Primary key: portal, cod_produtoFields:
  • portal - Portal code in Microvix
  • cod_produto - Product code in Microvix
  • cod_barra - Barcode of the product
  • nome - Name of the product
  • ncm - NCM tax classification code of the product
  • cest - CEST tax classification code of the product
  • referencia - Reference code of the product
  • cod_auxiliar - Auxiliary code of the product
  • unidade - Measurement unit the product is registered with
  • desc_cor - Description of the product’s second grid dimension (colour) in Microvix
  • desc_tamanho - Description of the product’s first grid dimension (size) in Microvix
  • desc_setor - Description of the product sector in Microvix
  • desc_linha - Description of the product line in Microvix
  • desc_marca - Description of the product brand in Microvix
  • desc_colecao - Description of the product collection in Microvix
  • dt_update - Date the product was last changed
  • cod_fornecedor - Internal Microvix code of the supplier linked to the product
  • desativado - Whether the product is deactivated
  • desc_espessura - Description of the product thickness in Microvix
  • id_espessura - Product thickness code in Microvix
  • desc_classificacao - Description of the product classification in Microvix
  • id_classificacao - Product classification code in Microvix
  • origem_mercadoria - Code of the goods origin in Microvix
  • peso_liquido - Net weight of the product in Microvix
  • peso_bruto - Gross weight of the product in Microvix
  • id_cor - Code of the product’s second grid dimension (colour) in Microvix
  • id_tamanho - Code of the product’s first grid dimension (size) in Microvix
  • id_setor - Product sector code in Microvix
  • id_linha - Product line code in Microvix
  • id_marca - Product brand code in Microvix
  • id_colecao - Product collection code in Microvix
  • dt_inclusao - Date the product was added
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • fator_conversao - Conversion factor of the unit
  • codigo_integracao_ws - For customers integrated through the inbound web service: the code sent on integration
  • codigo_integracao_reshop - For customers integrated through the inbound web service: the code field sent on integration
  • id_produtos_opticos_tipo - Code of the optical product type
  • id_sped_tipo_item - SPED item type identifier
  • componente - Whether the product is a component: S for yes, N for no
  • altura_para_frete - Height of the product considered for freight calculation
  • largura_para_frete - Width of the product considered for freight calculation
  • comprimento_para_frete - Product length considered for freight calculation
  • codigoproduto_io - Product code in Linx IO
  • cod_comprador - Buyer code
  • codigo_integracao_oms - Product code used by the OMS
  • obrigatorio_identificacao_cliente - Whether identifying the customer is mandatory on sales
  • descricao_basica - Basic description of the product
  • curva - ABC curve classification of the product
  • tributa_fcp - Whether the product is subject to the poverty relief fund tax (FCP)
  • observacao - Note about the product, limited to 1000 characters; only returned when the exibe_observacao parameter is set to 1
  • codigo_adicional_reshop - Additional product code in the ERP, used by Reshop
  • brinde - Whether the product is a giveaway
  • exige_controle - Whether the product requires stock control: S for yes, N for no
  • multiplo_venda - Sales multiple of the product — the quantity increment it can be sold in
Per-store product data: current stock balance, prices, costs and tax setup.Source method: LinxProdutosDetalhes. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, cod_produtoFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • cod_produto - Product code in Microvix
  • cod_barra - Barcode of the product
  • quantidade - Current stock balance of the product
  • preco_custo - Cost price of the product including ICMS
  • preco_venda - Sale price of the item in the default price table
  • custo_medio - Average cost of the product
  • id_config_tributaria - Code of the tax configuration attached to the product
  • desc_config_tributaria - Description of the tax configuration attached to the product
  • despesas1 - Amount recorded in the expenses field
  • qtde_minima - Minimum stock quantity
  • qtde_maxima - Maximum stock quantity
  • ipi - IPI tax rate
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • custototal - Total cost of the product
  • empresa - Company code within the portal
  • id_produtos_status_compra - Identifier of the status in the produtos_status_compra table
  • localizacao - Storage location of the product
Barcodes registered for each product.Source method: LinxProdutosCodBar. Incremental sync on the timestamp row version.Primary key: portal, cod_produto, cod_barraFields:
  • portal - Portal code in Microvix
  • cod_produto - Product code in Microvix
  • cod_barra - Barcode of the product
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
Stock position of each product on the requested date.Source method: LinxProdutosInventario. Full table sync (this method returns no row version).Primary key: portal, cnpj_emp, cod_produto, cod_depositoFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • cod_produto - Product code in Microvix
  • cod_barra - Barcode of the product
  • quantidade - Stock balance on the requested date
  • cod_deposito - Warehouse code — only returned when at least one warehouse is requested
  • empresa - Company code within the portal
Warehouses (depósitos) registered for the stores.Source method: LinxProdutosDepositos. Incremental sync on the timestamp row version.Primary key: portal, cod_depositoFields:
  • portal - Portal code in Microvix
  • cod_deposito - Warehouse code
  • nome_deposito - Name of the warehouse
  • disponivel - Whether the warehouse is available for sales
  • disponivel_transferencia - Whether the warehouse is available for transfers between branches
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key

​
Product classification

Product brands registered in the portal.Source method: LinxMarcas. Incremental sync on the timestamp row version.Primary key: portal, id_marcaFields:
  • id_marca - Identifier of the brand
  • desc_marca - Description of the brand
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • portal - Portal code in Microvix
Product lines registered in the portal.Source method: LinxLinhas. Incremental sync on the timestamp row version.Primary key: portal, id_linhaFields:
  • id_linha - Identifier of the product line
  • desc_linha - Description of the product line
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • portal - Portal code in Microvix
  • coeficiente_comissao - Commission coefficient
Product collections registered in the portal.Source method: LinxColecoes. Incremental sync on the timestamp row version.Primary key: portal, id_colecaoFields:
  • id_colecao - Identifier of the collection
  • desc_colecao - Description of the collection
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • portal - Portal code in Microvix
Product sectors registered in the portal.Source method: LinxSetores. Incremental sync on the timestamp row version.Primary key: portal, id_setorFields:
  • id_setor - Identifier of the sector
  • desc_setor - Description of the sector
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • ativo - Whether the record is active (1) or inactive (0)
  • portal - Portal code in Microvix
Product sizes registered in the portal.Source method: LinxTamanhos. Incremental sync on the timestamp row version.Primary key: portal, id_tamanhoFields:
  • id_tamanho - Identifier of the size
  • desc_tamanho - Description of the size
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • ativo - Whether the record is active (1) or inactive (0)
  • portal - Portal code in Microvix
Product colours registered in the portal.Source method: LinxCores. Incremental sync on the timestamp row version.Primary key: portal, id_corFields:
  • id_cor - Identifier of the colour
  • desc_cor - Description of the colour
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • ativo - Whether the record is active (1) or inactive (0)
  • portal - Portal code in Microvix
Product classifications registered in the portal.Source method: LinxClassificacoes. Incremental sync on the timestamp row version.Primary key: portal, id_classificacaoFields:
  • id_classificacao - Identifier of the classification
  • desc_classificacao - Description of the classification
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_integracao_ws - Code assigned by the web service integration
  • ativo - Whether the record is active (1) or inactive (0)
  • portal - Portal code in Microvix
Measurement units registered in the portal.Source method: LinxUnidades. Incremental sync on the timestamp row version.Primary key: portal, unidadeFields:
  • unidade - Measurement unit
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • portal - Portal code in Microvix

​
Customers and suppliers

Customers and suppliers registered in the stores.Source method: LinxClientesFornec. Incremental sync on the timestamp row version.Primary key: portal, cod_clienteFields:
  • portal - Portal code in Microvix
  • cod_cliente - Customer/supplier code in Microvix
  • razao_cliente - Legal name of the customer or supplier
  • nome_cliente - Name of the customer or supplier
  • doc_cliente - CPF or CNPJ (Brazilian tax ID) of the customer
  • tipo_cliente - Whether the customer is an individual or a company
  • endereco_cliente - Street address
  • numero_rua_cliente - Street number of the address
  • complement_end_cli - Address complement
  • bairro_cliente - Neighbourhood
  • cep_cliente - Postal code (CEP)
  • cidade_cliente - City
  • uf_cliente - State abbreviation (UF)
  • pais - Country
  • fone_cliente - Phone number of the customer
  • email_cliente - Email address
  • sexo - Gender
  • data_cadastro - Date the customer was registered
  • data_nascimento - Date of birth of the customer
  • cel_cliente - Mobile phone number of the customer
  • ativo - Whether the customer is active (S) or not (N)
  • dt_update - Date the record was last changed
  • inscricao_estadual - State tax registration number
  • incricao_municipal - Municipal tax registration number
  • identidade_cliente - RG (Brazilian ID document) of the customer
  • cartao_fidelidade - Loyalty card number in Microvix, when the loyalty module is used
  • cod_ibge_municipio - IBGE code of the municipality
  • classe_cliente - Code and name of the class linked to the customer; only one class is returned
  • matricula_conveniado - Code of the affiliated party (conveniado)
  • tipo_cadastro - Registry type: C for customers, F for suppliers, A for both
  • empresa_cadastro - Whether the record is a carrier (T)
  • id_estado_civil - Marital status: 1 not informed, 2 married, 3 single, 4 divorced, 5 widowed
  • fax_cliente - Fax number of the customer
  • site_cliente - Website of the customer
  • timestamp - Row version of the underlying table, used as the incremental replication key
  • cliente_anonimo - Whether the customer is anonymous
  • limite_compras - Purchase limit registered as store credit (crediário) in the customer and supplier registry
  • codigo_ws - Code sent through the inbound web service integration
  • limite_credito_compra - Purchase limit registered for cash and card payments in the customer and supplier registry
  • id_classe_fiscal - Identifier of the fiscal class assigned to the customer
  • obs - Note about the customer or supplier
  • mae - Mother’s name of the customer
  • cliente_contribuinte - Whether the customer is a registered taxpayer
  • id_tipo_registro_profissional - Identifier in the tipo_registro_profissional table
  • registro_profissional - Description of the professional registration
  • recebe_newsletter - Whether the customer subscribes to the newsletter
  • diferencial_icms_fornec - Whether an ICMS rate differential applies
  • perc_diferencial_icms_fornec - ICMS rate differential percentage
  • id_classe_preferencial - Code of the preferred class linked to the customer
  • id_subclasse_preferencial - Code of the preferred subclass linked to the customer
Contacts attached to each customer or supplier.Source method: LinxClientesFornecContatos. Full table sync (this method returns no row version).Primary key: portal, cod_cliente, nome_contatoFields:
  • portal - Portal code in Microvix
  • cod_cliente - Customer/supplier code in Microvix
  • nome_contato - Contact name
  • sexo_contato - Gender of the contact: F for female, M for male
  • contatos_clientes_parentesco - Relationship code of the contact
  • fone1_contato - Primary phone number of the contact
  • fone2_contato - Secondary phone number of the contact
  • celular_contato - Mobile phone number of the contact
  • email_contato - Email address of the contact
  • data_nasc_contato - Date of birth of the contact
  • tipo_contato - Type of contact

​
Finance

Accounts receivable and payable instalments.Source method: LinxFaturas. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, codigo_fatura, ordem_parcelaFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • codigo_fatura - Internal invoice code in Microvix
  • data_emissao - Issue date of the invoice
  • cod_cliente - Code of the customer of the invoice
  • nome_cliente - Name of the customer or supplier of the invoice
  • data_vencimento - Due date of the invoice
  • data_baixa - Date the invoice was settled
  • valor_fatura - Original amount of the invoice
  • valor_pago - Amount paid when the invoice was settled
  • valor_desconto - Discount amount granted on the invoice
  • valor_juros - Interest amount charged on the invoice
  • documento - Number of the document that generated the invoice
  • serie - Series of the document generated for the invoice
  • ecf - Number of the fiscal printer (ECF) that generated the invoice
  • observacao - Note about the invoice
  • qtde_parcelas - Total number of instalments of the invoice
  • ordem_parcela - Instalment sequence number
  • receber_pagar - Whether the invoice is receivable or payable
  • vendedor - Code of the salesperson linked to the invoice
  • excluido - Whether the invoice was deleted
  • cancelado - Whether the invoice is cancelled
  • identificador - Identifier that references the records belonging to the same fiscal document
  • nsu - NSU of the invoice settled through TEF
  • cod_autorizacao - Authorisation code of the invoice settled through TEF
  • documento_sem_tef - Document number entered manually for sales without TEF
  • autorizacao_sem_tef - Authorisation code entered manually for sales without TEF
  • plano - Internal payment plan code in Microvix
  • conta_credito - Credit account code of the accounting entry
  • conta_debito - Debit account code of the accounting entry
  • conta_fluxo - Cash-flow account code of the accounting entry
  • cod_historico - Code of the history entry in Microvix
  • forma_pgto - Name of the payment method
  • ordem_cartao - Sequence of the card (1, 2, 3, …); only filled for card payment plans
  • banco_codigo - Bank code, used for cheque invoices
  • banco_agencia - Bank branch code, used for cheque invoices
  • banco_conta - Bank account code, used for cheque invoices
  • banco_autorizacao_garantidora - Guarantor code, used for cheque invoices
  • numero_bilhete_seguro - Only used with the third-party services sales module
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • empresa - Company code within the portal
  • id_categorias_financeiras - Identifier of the financial category
  • taxa_financeira - Financial fee applied to the invoice
  • valor_abatimento - Rebate amount applied to the invoice
  • valor_multa - Penalty amount charged on the invoice
  • centrocusto - Identifier of the cost centre
  • perc_taxa_adquirente - Fee percentage charged by the card acquirer
  • fatura_origem_importacao_erp - Original number of the invoice imported into the ERP
  • cod_portador - Code of the invoice holder (portador)
  • nsu_host - Host NSU (unique sequential number) of the transaction
  • nsu_sitef - Sitef NSU (unique sequential number) of the transaction
  • previsao - Whether the invoice is a forecast: S for yes, N for no
  • data_lanc - Date the invoice was posted
  • dt_insert - Date the record was inserted
  • plano_pagamento_baixa - Identifier of the payment plan used to settle the invoice
Payment plans registered in the portal.Source method: LinxPlanos. Incremental sync on the timestamp row version.Primary key: portal, planoFields:
  • portal - Portal code in Microvix
  • plano - Internal payment plan code in Microvix
  • desc_plano - Description of the payment plan
  • qtde_parcelas - Number of instalments
  • prazo_entre_parcelas - Number of days between instalments
  • tipo_plano - Transaction type: C for purchase, V for sale
  • indice_plano - Index of the payment plan
  • cod_forma_pgto - Code of the payment method
  • forma_pgto - Name of the payment method
  • conta_central - Central account code linked to the customer/supplier registry
  • tipo_transacao - Card payment type: D for debit, C for credit
  • taxa_financeira - Financial fee percentage charged by the card administrators
  • dt_upd - Date the record was last changed
  • desativado - Whether the payment plan is deactivated: S for yes, N for no
  • usa_tef - Whether the plan uses TEF: S (yes) or N (no)
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • codigo_ws - Code received from the web service integration
  • valor_minimo_parcela - Minimum instalment amount
Card brands linked to each payment plan.Source method: LinxPlanosBandeiras. Full table sync (this method returns no row version).Primary key: portal, plano, bandeiraFields:
  • portal - Portal code in Microvix
  • plano - Internal payment plan code in Microvix
  • bandeira - Card brand description in Microvix
  • tipo_bandeira - Description of the linked card brand type
  • adquirente - Code of the card acquirer or operator, linked to the customer/supplier registry
  • nome_adquirente - Name of the card acquirer or operator, linked to the customer/supplier registry
  • codigo_bandeira_sitef - Sitef card brand code
Cash withdrawals (sangrias) and supplies registered at the cash register.Source method: LinxSangriaSuprimentos. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, id_sangria_suprimentosFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • usuario - User that performed the movement
  • data - Date of the record
  • valor - Amount of the cash withdrawal or cash supply
  • obs - Description of the cash withdrawal or supply
  • cancelado - Whether the record is cancelled (S) or valid (N)
  • conferido - Whether the document has been checked (1) or not (0)
  • cod_historico - Code of the history entry in Microvix
  • desc_historico - Description of the history entry
  • id_sangria_suprimentos - Identifier of the cash withdrawal or supply entry
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key

​
Salespeople

Salespeople registered in the stores.Source method: LinxVendedores. Incremental sync on the timestamp row version.Primary key: portal, cod_vendedorFields:
  • portal - Portal code in Microvix
  • cod_vendedor - Salesperson code in Microvix
  • nome_vendedor - Name of the customer or supplier
  • tipo_vendedor - Role: V for salesperson, C for buyer, A for both
  • end_vend_rua - Street address
  • end_vend_numero - Street number of the address
  • end_vend_complemento - Address complement
  • end_vend_bairro - Neighbourhood
  • end_vend_cep - Postal code (CEP)
  • end_vend_cidade - City
  • end_vend_uf - State abbreviation (UF)
  • fone_vendedor - Phone number of the customer
  • mail_vendedor - Email address
  • dt_upd - Date the record was last changed
  • cpf_vendedor - CPF (Brazilian individual tax ID) of the salesperson
  • ativo - Whether the salesperson is active: S for yes, N for no
  • data_admissao - Hiring date of the salesperson
  • data_saida - Termination date of the salesperson
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • matricula - Employee registration number of the salesperson
  • id_tipo_venda - Identifier of the sale type
  • descricao_tipo_venda - Description of the sale type
  • cargo - Job title of the salesperson
  • nome_exibicao - Display name of the salesperson in Microvix
  • funcao - Job function of the salesperson
  • empresa - Company the salesperson is assigned to
  • codigo_integracao_ws - Code sent through the web service integration
  • meta_peso - Weight of the sales target
Sales targets assigned to salespeople.Source method: LinxMetasVendedores. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, id_meta, cod_vendedorFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • id_meta - Sales target code in Microvix
  • descricao_meta - Description of the sales target
  • data_inicial_meta - Start date of the sales target
  • data_final_meta - End date of the sales target
  • valor_meta_loja - Sales target amount for the store
  • valor_meta_vendedor - Sales target amount for the salesperson
  • cod_vendedor - Salesperson code in Microvix
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key

​
Promotions

Promotional campaigns registered in the stores.Source method: LinxAcoesPromocionais. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, id_acoes_promocionaisFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • id_acoes_promocionais - Code of the promotional campaign
  • vigencia_inicio - Start date of the validity period
  • vigencia_fim - End date of the validity period
  • observacao - Note about the promotional campaign
  • ativa - Whether the promotional campaign is active
  • excluida - Whether the promotional campaign was deleted
  • integrada - Whether the promotional campaign was integrated
  • qtde_integrada - Maximum quantity integrated by the franchisor
  • valor_pago_franqueadora - Amount paid by the franchisor
  • id_acoes_promocionais_origem - Identifier of the originating promotional campaign
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key

​
Orders

Sales orders, one row per item.Source method: LinxPedidosVenda. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, cod_pedido, posicao_itemFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • cod_pedido - Order code
  • data_lancamento - Date of the order
  • hora_lancamento - Time the order was posted
  • transacao - Internal Microvix code
  • usuario - User that placed the order
  • codigo_cliente - Customer code
  • cod_produto - Product code
  • quantidade - Quantity of the product
  • valor_unitario - Unit price of the product
  • cod_vendedor - Salesperson code in Microvix
  • valor_frete - Freight amount
  • valor_total - Total amount of the order
  • desconto_item - Discount applied to the item
  • cod_plano_pagamento - Code of the payment plan
  • plano_pagamento - Name of the payment plan
  • obs - Note about the order
  • aprovado - Whether the record is already an order (S) or still a quotation (N)
  • cancelado - Flag with values S (yes) or N (no)
  • data_aprovacao - Date the order was approved
  • data_alteracao - Date the record was last changed
  • tipo_frete - Freight type: 1 for CIF, 2 for FOB
  • natureza_operacao - Description of the operation nature
  • tabela_preco - Code of the price table used
  • nome_tabela_preco - Name of the price table
  • previsao_entrega - Expected delivery date
  • realizado_por - Code of the customer the order was placed for
  • pontuacao_ser - Customer code in the Pontuação Ser loyalty programme
  • venda_externa - Flag with values S (yes) or N (no)
  • nf_gerada - Comma-separated numbers of the fiscal invoices generated when the order was billed
  • status - Billing status: F fully billed, P partially billed, N not billed
  • numero_projeto_officina - Project code
  • cod_natureza_operacao - Code of the operation nature
  • margem_contribuicao - Contribution margin of the store
  • doc_origem - Source document number
  • posicao_item - Position of the item within the sales order
  • orcamento_origem - Number the quotation originated from; 0 when it has no origin
  • transacao_origem - Original transaction kept when a sales order is partially approved and a new transaction is generated
  • timestamp - Original transaction the record refers to, used as the incremental replication key
  • desconto - Total discount of the sales order
  • transacao_ws - Transaction sent through the web service integration
  • empresa - Company code within the portal
  • transportador - Identifier of the carrier registered in the portal
  • deposito - Identifier of the warehouse in the portal
  • texto_agrupamento - Grouping text of the order
  • posicao - Code of the quotation position
  • encerrado - Whether the quotation or order was closed
Purchase orders, one row per item.Source method: LinxPedidosCompra. Incremental sync on the timestamp row version.Primary key: portal, cnpj_emp, cod_pedido, cod_produtoFields:
  • portal - Portal code in Microvix
  • cnpj_emp - CNPJ (Brazilian tax ID) of the store
  • cod_pedido - Order code
  • data_pedido - Date of the order
  • transacao - Internal Microvix code
  • usuario - User that placed the order
  • codigo_fornecedor - Supplier code
  • cod_produto - Product code
  • quantidade - Quantity of the product
  • valor_unitario - Unit price of the product
  • cod_comprador - Buyer code in Microvix
  • valor_frete - Freight amount
  • valor_total - Total amount of the order
  • cod_plano_pagamento - Code of the payment plan
  • plano_pagamento - Name of the payment plan
  • obs - Note about the order
  • aprovado - Flag with values S (yes) or N (no)
  • cancelado - Flag with values S (yes) or N (no)
  • encerrado - Flag with values S (yes) or N (no)
  • data_aprovacao - Date the order was approved
  • numero_ped_fornec - Supplier’s own order number, when informed
  • tipo_frete - Freight type code
  • natureza_operacao - Description of the operation nature
  • previsao_entrega - Expected delivery date
  • numero_projeto_officina - Project code
  • status_pedido - Order status: E for delivered, P for pending
  • qtde_entregue - Quantity of items already delivered
  • descricao_frete - Description of the freight
  • integrado_linx - Whether the order was integrated by Linx (1) or not (0)
  • nf_gerada - Number of the fiscal invoice generated when the order was billed; only the first invoice is shown
  • timestamp - Row version of the underlying table, used as the incremental replication key (not a date — it is a SQL Server row-version counter), used as the incremental replication key
  • empresa - Company code within the portal
  • nf_origem_ws - Number of the fiscal invoice created through the LinxCadastraNotas method
  • id_compras_pedido_status - Identifier of the purchase order status
  • qtde_desejada - Quantity requested
  • motivo_ajuste - Reason for the adjustment
  • saldo_disponivel_api - Balance still available through the API