Página 1
ESPECIFICAÇÃO :
Web Service de Saída Padrão
Linx Microvi x
Página 2
Neste documento apresentamos as informações referentes aos desenvolvimentos de sistemas com
a definição do escopo, prazo e custo.
A LINX SISTEMAS tem acumulado experiências em diversos projetos de desenvolvimento de
sistemas para melhor desempenho das empresas.
Estas experiências estão concentradas em nossas Metodologias de Desenvolvimento e em nossos
profissionais, garantindo o sucesso dos projetos de nossos clientes.
Esperamos que o conteúdo apresentado neste documento atenda as expectativas de V.Sas. de
forma clara e objetiva. E desde já ficamos à disposição para esclarecimentos que sejam necessários.
Obrigado,
Equipe LINX
Página 3
1. Introdução
O Web Service de saída padrão Linx Microvix disponibiliza as seguintes informações do Microvix,
registros de vendas, empresas, produtos, clientes, estoque e faturas de cada loja .
O formato do layout é único e padrão não recebe customizações, somente melhoria s, onde todos
os clientes que utilizarem recebem as melhorias.
2. Especificações
2.1 Escopo do WebService
Os métodos são padrões no Web Service da Linx Microvix, onde será possível buscar os registros
das bases do MicrovixERP de qualquer loja de um Portal (podendo estar até dentro de um grupo
econômico ou rede de franquias ). A chamada dos métodos é sempre feita por CNPJ para retorno das
informações.
É importante que da mesma forma que as informações forem extraídas dos métodos, as mesmas
sejam gravadas pelo cliente em bases locais, para que o WebService Linx Microvix não seja utilizado
para extrair informações retroativas, somente novas. Isso garante a performance da API e não
afeta as movimentações das lojas onde está sendo extraída a informação.
Os métodos trarão as seguintes informações :
• LinxMétodos: Retorna as informações atualizadas dos nomes e parâmetros dos métodos
do WebService Linx Microvix padrão.
• LinxGrupoLojas: Irá retornar todos os CNPJs do Grupo ou Rede.
• LinxLojas: Irá conter as informações de cada loja do Portal com o sistema Microvix;
• LinxClientes Fornec: Irá conter as informações dos clientes/fornecedores cadastrados nas
lojas;
• LinxCliente sFornecCamposAdicionais: Ira conter as informações gravadas nos campos
adicionais referente s a cada cliente.
• LinxClientes FornecClasses: Retorna todas as classes vinculadas a um cliente/fornecedor;
• LinxClientes FornecContatos: Irá conter as informações dos contatos dos
clientes/fornecedores cadastrados nas lojas;
• LinxClientesFornecCreditoAvulso: irá conter informações sobre os créditos gerados para
os clientes;
• LinxFidelidade: Retorna os dados da tabela fidelidade_parceiros_log cadastrados no
portal.
Página 4
• LinxMovimento: Irá conter as informações referente as notas fiscais e tickets de venda;
• LinxMovimentoCart oes: Retorna informações dos cartões utilizados na s movimentações
de venda de acordo com a loja pesquisada ;
• LinxMovimento Extensão: Retorna informações de operações realizada no Microvix que
envolvam o FCP (Fundo de Combate a Pobreza);
• LinxMovimentoTrocas: Irá conter as informações de valores das trocas utilizadas nas
vendas;
• LinxMotivoDevolu coes: Retornará os motivos das trocadas realizadas;
• LinxMovimentoTrocafone: Irá conter as informações de valores dos vouchers Trocafone
utilizados nas vendas;
• LinxMovimentoOrigemDevolucoes : Retorna os documentos de origem relacionados as
devoluções.
• LinxMovimentoSeria l: Irá conter as informações dos seriais movimentados;
• LinxPlanos: Irá retornar as informações do cadastro de Planos de Pagamento;
• LinxPlanosBandeiras: Irá retornar as informações das Bandeiras Cadastradas por planos
de pagamento.
• LinxMovimentoPlanos: Irá conter as informações dos planos de pagamentos utilizados
nas movimentações;
• LinxMovimentoDevolu coestens: irá conter informações dos itens da devolução;
• LinxSangriasSuprimentos: Irá retornar as informações de Sangrias ou Suprimentos
realizados no caixa;
• LinxMovimentoOrigemDevolu coes: Irá conter as informações de documentos de origem
das devoluções relacionadas.
• LinxMovimentoA coesPromocionais: Irá conter as informações das Ações Promocionais
utilizadas nas vendas;
• LinxListadaVez: Retorna os registros gerados na rotina de Lista da Vez;
• LinxVendedores: Irá conter as informações de vendedores;
• LinxMetasVendedores: Irá conter as informações de metas vendedores;
• LinxAcoesPromocionais: Irá retornar o cadastro das Ações Promocionais;
• LinxProdutos: Ira contar com informações de produtos;
• LinxProdutosDetalhes : Irá conter as informações de produtos por empresa, como saldo,
preços , custos e configuração tributária ;
• LinxProdutosPromocoes : Retorna informações das promoções dos produtos de acordo
com a loja pesquisada.
• LinxProdutosInvent ario: Irá fornecer as informações do saldo do produto na data
pesquisada;
• LinxProdutos Depositos: Irá fornecer as informações do cadastro de depósitos das lojas.
• LinxProdutosCamposAdicionais: Ira conter as informações gravadas nos campos
adicionais referente s a cada produto.
• LinxProdutosCodBar: Irá listar as informações de códigos de barras de produtos.
Página 5
• LinxProdutosTabelas : Irá listar as tabelas de preço cadastradas no MicrovixERP.
• linxProdutosTabela sPrecos: Irá listar o vínculo de produtos com as tabelas de preço.
• LinxConfigura coesTribut arias: Irá listar o cadastro de configurações tributárias;
• LinxConfigura coesTribut ariasDetalhes: Irá listar o detalhamento de cada configuração
tributária;
• LinxFaturas: Irá conter as informações de faturas a receber e a pagar;
• LinxLancContabil: Irá conte r as informações dos lançamentos contábeis por contas e
empresas.
• LinxPedidoCompra: Irá conter as informações dos pedidos de compra;
• LinxPedidovenda: Irá conter as informações dos pedidos de venda;
• LinxPlanosPedidoVenda : Retorna os Planos de Pagamentos realizados nos pedidos de
vendas.
• LinxRedu coesZ: Irá conter as informações das reduções Z, disponibilizadas pelas
impressoras fiscais.
• LinxServi cos: Irá conter as informações básicas do cadastro de serviços.
• LinxServi cosDetalhes: Contém as informações dos serviços que são feitas por empresa
(valores, configuração tributária...).
• LinxClientesFornecContatosParentesco : Retorna os graus de parentesco cadastrado no
portal.
• LinxAntecipacoesFinanceiras : Retorna informações das antecipações financeiras do
portal.
• LinxXMLDocumentos : Retorna o XML dos documentos emitidos pela loja.
• LinxProdutosOpticosTipoAro : Retorna os tipos de aros.
• LinxProdutosOpticosFormatoAro : Retorna os formatos de aros.
• LinxDadosOpticosDav : Retorna os dados ópticos dos produtos da DAV.
• LinxAntecipacoesFinanceirasPlanos : Retorna os dados da tabela
antecipações_financeiras e antecipações_financeiras_planos no portal.
• LinxSubClasses : Retorna as subclasses de CRM.
• LinxDevolu caoRemanejoF abrica: Rotina de remanejamento de mercadorias através de
web service de entrada. Para utilização desta rotina é necessário a parametrização conforme
demandas MODAJOI -1767 e MODAJOI -1768.
• LinxDevolu caoRemanejoF abricaItens: Rotina de remanejamento de mercadorias
através de web service de entrada. Para utilização desta rotina é necessário a
parametrização conforme demandas MODAJOI -1767 e MODAJOI -1768.
• LinxDevolu caoRemanejoF abricaTipo: Rotina de remanejamento de mercadorias através
de web service de entrada. Para utilização desta rotina é necessário a parametrização
conforme demandas MODAJOI -1767 e MODAJOI -1768.
• LinxDevoluçãoRemanejoF abricaStatus: Rotina de remanejamento de mercadorias
através de web service de entrada. Para utilização desta rotina é necessário a
parametrização conforme demandas MODAJOI -1767 e MODAJOI -1768.
Página 6
• LinxProdutosDetalhes Simplificado: Irá conter as informações de produtos por empresa,
como saldo, preços, custos e configuração tributária de forma simplificada
• LinxConfiguraçõesTribut ariasDetalhesSimplificado: Irá listar o detalhamento de cada
configuração tributária de forma simplificada;
• linxNaturezaOperação: irá conter informações das naturezas de operações;
• LinxClasseFiscal: irá conter informações referente ao cadastro da classe fiscal;
• LinxCSTICMSFiscal: irá conter informações do cadastro de CST (Código de Situação
Tributária) e ICMS (Imposto sobre Circulação de Mercadorias e Serviços) fiscal;
• LinxCSOSNFiscal: irá conter informações do cadastro de CSON (Código de Situação da
Operação do Simples Nacional) fiscal;
• LinxCFOPFiscal: irá conter informações do cadastro da CFOP ( Código Fiscal de Operações
e Prestações das entradas e saídas de mercadorias) ;
• LinxRotinaOrigem: Retorna as rotinas cadastradas no portal.
• LinxPedidosVendaChecklistEntregaLocal : Retorna os tipos de locais cadastrados no
checklist de entrega do pedido de venda.
• LinxPedidosVendaChecklistEntregaArmazenamento : Retorna os tipos de
armazenamentos cadastrados no checklist de entrega do pedido de venda.
• LinxPedidosVendaChecklistEntregaDificuldade : Retorna os tipos de dificuldades
cadastradas no checklist de entrega do pedido de venda.
• LinxSetores: Retorna os setores cadastrados no portal.
• LinxLinhas: Retorna as linhas cadastradas no portal.
• LinxMarcas: Retorna as marcas cadastradas no portal.
• LinxColecoes : Retorna as coleções cadastradas no portal .
• LinxTamanhos : Retorna os tamanhos cadastrados no portal.
• LinxCores: Retorna as cores cadastrad as no portal.
• LinxEspessuras : Retorna as espessuras cadastrad as no portal.
• LinxClassificacoes: Retorna as classificações cadastrad as no portal.
• LinxUnidades : Retorna as unidades cadastradas no portal.
• LinxRamosAtividade : Retorna os ramos de atividade cadastrados no portal.
• LinxECF : Retorna as ECFs cadastrados no portal.
• LinxECFFormasPagamento : Retorna as formas de pagamento de uma ECF.
• LinxMovimentoGiftCard : Retorna os dados de Gift Card.
• LinxProdutosOpticosTipo : Retorna os tipos de produtos opticos.
• LinxProdutosSerial : Retorna os seriais cadastrados no portal.
• LinxMovimentoRemessas : Retorna os dados da tabela remessas no portal.
• LinxMovimentoRemessasItens : Retorna os dados da tabela remessas_itens no portal.
• LinxMovimentoRemessasAcertos: Retorna os dados da tabela remessas_acertos no
portal.
• LinxMovimentoRemessasAcertosItens : Retorna os dados da tabela remessas_acertos_
itens no portal.
Página 7
• LinxRemessasRetornoTipos : Retorna os dados da tabela remessa_retorno_tipos no
portal.
• LinxRemessasOperacoes: Retorna os dados da tabela remessa_operacoes no portal.
• LinxLojasParametros: Retorna parâmetros do portal.
• LinxSeries: Retorna as séries cadastradas no portal.
• LinxNFeEvento: Retorna os dados de eventos de NFe.
• LinxMetasVendedoresDia : Retorna as metas dos vendedores por dia.
• LinxSpedTipoItem : Retorna o tipo de item de sped.
• LinxRemessasIdentificadores : Recebe o identificador da venda e retorna a relação com
os identificadores das notas dos itens da remessa.
• LinxTrocaUnificadaResumoVendas : Retorna as vendas do troca unificada.
• LinxTrocaUnificadaResumoVendasItens : Retorna os itens das vendas da troca
unificada.
• LinxMovimentoPrincipal : Retorna os dados do movimento principal.
• LinxCupomDesconto : Retorna os dados da tabela cupom_desconto cadastrados no portal.
• LinxCupomDescontoVendas: Retorna o id do cupom de desconto, o valor do cupom e o
identificador das vendas que utilizaram cupons de desconto.
• LinxTrocaUnificadaResumoBaixa : Retorna as vendas do troca unificada resumo baixa.
• LinxListagemBalanco : Retorna a listagem de balanços.
• LinxProdutosAssociados : Retorna a listagem de produtos associados.
• LinxMovimentoObservacaoCF: Retorna as observações do cupom fiscal.
• LinxMovimentoReshop : Retorna movimentação de campanhas do Reshop.
• LinxMovimentoReshopItens : Retorna os itens de movimentação de campanhas do
Reshop.
• LinxCentroCusto : Retorna as informações dos centros de custos cadastrados no portal.
• LinxPlanoContas : Retorna as informações do plano de contas cadastrado no portal.
• LinxPerguntaVenda: Retorna as perguntas no final da venda cadastradas no portal.
• LinxRespostaVenda : Retorna as respostas no final da venda cadastradas no portal.
• LinxConfiguracoesTributariasEmpresas: Retorna o conteúdo da tabela
config_tributaria_empresa.
• LinxCest: Retorna o conteúdo da tabela classificacao_cest_produt o.
• LinxCstCofinsFiscal : Retorna o conteúdo da tabela cst_cofins_fiscal.
• LinxCstIpiFiscal: Retorna o conteúdo da tabela cst_ipi_fiscal.
• LinxCstPisFiscal : Retorna o conteúdo da tabela cst_pis_fiscal.
• LinxEnquadramentoIpi : Retorna enquadramento IPI.
• LinxMotivosDesoneracaoIcms : Retorna o conteúdo da tabela
motivos_desoneracao_icms.
• LinxMovimentoObservacoes : Retorna o conteúdo da tabela movimento_observacoes.
• LinxNcm: Retorna o conteúdo da tabela classificacao_ncm_produto.
• LinxSpedTipoBaseCredito : Retorna o conteúdo da tabela sped_tipo_base_credito.
Página 8
• LinxNfceEstacao : Retorna cadastro de estações.
• LinxMovimentoIndicacoes: Retorna o cliente indicador da venda.
• LinxValesComprasEnviadosAPI : Retorna Vale Compras importado via API.
• LinxProdutosLotes : Retorna o saldo dos lotes de produtos.
• LinxMovimentoVendaConjugada : Retorna movimento da venda conjugada.
• LinxNfse: Retorna Nota Fiscal de Serviços Eletrônica.
• LinxMovimentoOrdemServicoExterna : Retorna a ordem de serviço externa da
movimentação.
• LinxTradeinParceiro : Retorna os registros cadastrados na tabela tradein_parceiro do
portal.
• LinxCategoriasFinanceiras : Retorna Categoria Financeira.
• LinxValeOrdemServicoExterna : Retorna os dados de vale ordem de serviço externa.
• LinxProdutosDetalhesDepositos: Retorna os saldos dos produtos por depósito.
• LinxSerialVenda : Retorna os registros da tabela serial_venda.
• LinxProdutosFornec : Retorna os dados de produtos x fornecedores.
• LinxComissoesVendedores : Retorna as comissões de vendedores.
• LinxFaturasOrigem : Retorna as faturas de origem do portal.
• LinxMotivoDesconto: Retorna os motivos de desconto cadastrados no portal.
• LinxPosicaoOsRamoOptico: Retorna o cadastro da posição da OS do Ramo Optico.
• LinxOrdensServico : Retorna as ordens de serviço.
• LinxOrdensServicoProdutos : Retorna os produtos das ordens de serviço.
• LinxOrdensServicoPosicaoOsRamoOpticoHistorico : Retorna o histórico das posições
das ordens de serviço do ramo optico.
• LinxPagamentoParcialDav : Retorna os pagamentos parciais da DAVs.
• LinxMovimentoCamposAdicionais : Retorna os campos adicionais da movimentação .
• LinxOrdemServicoExternaDav: Retorna as ordens de serviço externas das DAVs.
• LinxB2CPedidos: Retorna os pedidos de B2C.
• LinxB2CPedidosItens : Retorna os itens dos pedidos de B2C.
• LinxB2CStatus : Retorna o cadastro dos status de B2C.
• LinxB2CPedidosStatus : Retorna o status dos pedidos de B2C.
• LinxOticoPrismaDescricao : Retorna descrição de prismas óticos.
• LinxOticoReceitas: Retorna as receitas óticas importadas no sistema.
• LinxOrcamentoComponenteFormula: Retorna os componentes de fórmulas
relacionados ao orçamento.
• LinxLotesProdutos : Retorna os dados dos lotes dos produtos.
• LinxClientesRede : Retorna os registros da tabela clientes_rede no portal centralizador.
• LinxFechamentoCaixa :Retorna os dados do Fechamento de Caixa.
• LinxAcoesPromocionaisProdutosCortesia : Retorna os produtos de cortesia de ações
promocionais.
Página 9
• LinxAcoesPromocionaisCombinacaoProdutosItens : Retorna os itens da combinação
de produtos de ações promocionais.
• LinxProdutosInformacoes : Retorna informações dos produtos (características).
• LinxFreteTipos : irá retornar os tipos de fretes .
• LinxN FeIbgeMunicípio: irá retornar os dados do IBGE sobre os municípios;
• LinxConhecimentoFretes: irá retornar os dados dos conhecimentos de fretes;
• LinxPlanosParcelas : Retorna as parcelas vinculadas ao plano de pgto .
• LinxComponenteFormulaDav : Retorna os componentes de fórmulas relacionados ao
Dav.(Formula Certa) .
• LinxClientesEnderecosEntrega : Retorna endereço de entrega do cliente.
• LinxUsuarios: Retorna os usuários do Microvix.
• LinxProdutosImagensURL : Retorna as URLs das imagens dos produtos.
• LinxVendasPosAgrupamentoTmp : Retorna os registros da tabela
vendas_pos_agrupamento_tmp.
• LinxVendasPosTmp : Retorna os registros da tabela vendas_pos_tmp
• LinxRegistroProfissional : Retorna os registros da tabela tipo_registro_profissional.
• LinxClientesFornecVendedores : Retorna o código do vendedor associado ao cadastro
do cliente, conforme a tabela clientes_fornec_vendedores.
• LinxExtratoBancarioLancamentos : Retorna os top 10000 registros da tabela
extrato_bancario_lancamentos ordenados pelo campo timestamp.
• LinxExtratoBancarioConciliacoes : Retorna os top 10000 registros da tabela
extrato_bancario_lancamentos ordenados pelo campo timestamp.
• LinxHistoricosContabeis : Retorna os dados dos históricos contábeis .
• LinxPortadores : Retorna os dados dos portadores .
• LinxPedidosCompraStatus : Retorna os status de pedidos de compra .
• LinxDesfazimentosAntecipacoes : Retorna os registros da tabela
desfazimentos_antecipacoes.
• LinxDesfazimentosAntecipacoesItens : Retorna os registros da tabela
desfazimentos_antecipacoes_itens.
• LinxDesfazimentosAntecipacoesDocumento: Retorna os registros da tabela
desfazimentos_antecipacoes_documento.
3. Credenciais de acesso
Para acesso ao web service de saída padrão Linx Microvix é necessário possuir as credenciais de
acesso que disponibilizaremos abaixo:
Página 10
URLs:
Para (WS de saída) utilizamos a URL: https://webapi.microvix.com.br/1.0/api/integracao
Em caso que estejam usando portal de teste usar a URL: http://webapi -
aceitacao.microvix.com.br /api/integracao
Usuário: linx_export
Senha: linx_export
Chave: (A chave de acesso será disponibilizada no momento da ativação do serviço)
Grupo: (O nome do Grupo será disponibilizado no momento da ativação do serviço )
ATENÇÃO: Verificar item 10 sobre o prazo de homologação.
4. Orientações Gerais
4.1 - TIMESTAMPS:
Obs.: O consumo indevido de dados, fazendo requisições para retorno de toda a base, levará ao
alto volume de tráfego e poderá impactar na performance dos servidores Microvix. Este cenário,
consequentemente resultará na desativação da chave de integração pelo Ti me de Banco de Dados,
sem prévio aviso..
Faça a leitura abaixo, para entendimento sobre como seguir as boas práticas de consumo Microvix.
Nem todas a rotinas atualizam a data de update do registro, portanto a forma mais segura e rápida
para extrair os dados novos ou que sofreram alguma alteração é utilizar o campo timestamp.
Segue a forma correta do consumo dos dados do web service:
"Você pesquisa uma vez todo o passado da loja com o timestamp zero, popula o seu banco de
dados local, depois informa o último timestamp da consulta anterior e faz uma nova consulta. Essa
nova consulta só irá retornar resultados que tiverem timestamps maiores que o timestamp
pesquisado, ou seja, só irá retornar os registros alterados e adicionados. Assim você irá popular a
sua base local de forma incremental"
Portanto, podemos tomar como exemplo:
• produto_1 criado: timestamp 81465615 20
• produto_2 criado: timestamp 81465615 21
• produto_2 alterado: timestamp 81465615 22
• produto_1 alterado: timestamp 81465615 23
• produto_3 criado: timestamp 81465615 24
Página 11
Tendo o exemplo acima, se consultássemos o método LinxProdutos com timestamp 8146561522,
teríamos como reposta apenas o produto_1 e produto_3.
Para detectar quando algum registro foi modificado ou adicionado, salve o maior timestamp do
resultado. Dessa forma, caso nenhum evento tenha ocorrido, a resposta será vazia.
Os bancos de dados representam datas de diversas formas diferentes:
- O TIMESTAMP do MySQL armazena uma timestamp do unix de 32 bits com sinal, e por isso está
susceptível ao bug do ano 2038. O formato DATETIME do MySQL remedia o problema do formato
TIMESTAMP do mesmo, podendo armazenar de 01/01/1000 até 31/12/9999. Nenhum destes
formatos armazena frações de segundo, e portanto para armazená -los, você terá que colocá -los
em alguma coluna numérica para tal finalidade.
- No MariaDB (fork do MySQL), os tipos TIMESTAMP e DATETIME funcionam de forma parecida com
a do MySQL (inclusive com o bug do ano 2038 para o TIMESTAMP). Porém, diferentemente do
MySQL, o MariaDB aceita frações de segundo com uma precisão máxima de micros egundos.
- No Oracle, o tipo TIMESTAMP é capaz de armazenar datas de 4712 antes de Cristo até o ano
9999, com uma precisão que pode ser definida de 1 segundo até 1 nanosegundo (bilionésimos de
segundo), incluindo ou não o fuso horário. O tipo TIMESTAMP WITH TIME ZO NE armazena também
o fuso horário.
- No PostgreSQL, o tipo TIMESTAMP (ou TIMESTAMP WITHOUT TIME ZONE), com 8 bytes, é capaz
de armazenar datas de 4713 antes de Cristo até o ano 294276, com precisão de microsegundos
(milionésimos de segundo). É possível também reduzir -se a precisão para aumentar -se o intervalo
aceito. Há também o tipo TIMESTAMPTZ (ou TIMESTAMP WITH TIME ZONE) que também armazena
o fuso horário.
- No Firebird, o tipo TIMESTAMP utiliza 4 bytes para armazenar a data e 4 para armazenar a hora,
totalizando 8 bytes. A data pode variar de 01/01/0001 até 31/12/9999 e a hora tem precisão de
décimos de milésimos de segundos.
- No SQL Server, o tipo TIMESTAMP é uma equivalência deprecated para o tipo ROWVERSION, que
na verdade constitui -se de um campo que é alterado automaticamente sempre que um registro é
alterado e armazena um valor garantidamente único, não tendo relação com datas. No SQL Server,
o tipo DATETIME utiliza 8 bytes para armazenar datas de 01/01/1753 até 31/12/9999, com precisão
de cerca de 3 milisegundos. Também há o tipo SMALLDATETIME que utiliza 4 bytes para armazenar
datas de 01/01/1900 até 06/06/2079 com prec isão de 1 minuto, o tipo DATETIME2, que armazena
qualquer data e hora representável com um ano de quatro dígitos com uma precisão de décimos
de milionésimos de segundo. e um tipo DATETIMEOFFSET que armazena também o fuso horário.
Fonte: https://www.ramosdainformatica.com.br/banco_de_dados/como -fazer-o-calculo -do-
timestamp -e-iso/
Resumindo:
Página 12
Timestamps do formato UNIX representam o número de segundos desde 01/01/1970 até agora.
Os timestamps do Linx Microvix não são UNIX, são do SQL Server do tipo TIMESTAMP,
portanto são incrementais, que correspondem a um contador relativo à vida do banco de
dados SQL Server. Eles não representam tempo.
Cada timestamp é único no banco de dados. Cada operação adiciona uma unidade a ele, porém no
web service o timestamp é por método.
Nem todos os métodos pesquisam somente em uma tabela do banco de dados, portanto o
timestamp de cada método é o maior timestamp das tabelas relacionadas àquele método. Por
exemplo: O método LinxPedidosVenda faz a junção das tabelas empresa, clientes_fornec edores e
orcamento. Por exemplo:
1 - Você cadastra um cliente pelo método X e obtém na consulta do método que este timestamp é
o 81376259 72
2 - Você cadastra um orçamento/pedido pelo método Y e obtém na consulta que o timestamp é o
81376259 73
3 - Você altera o endereço do cliente no CRM e obtém na consulta que o timestamp é o 81376259 74
4 - Você faz uma pesquisa pelo orçamento/pedido enviado utilizando o timestamp 81376259 74,
mas consulta retorna vazia pois irão retornar somente os resultados maiores que este timestamp
informado, onde o cliente e o orçamento não existem. O correto seria fazer a consulta com o
timestamp 81376259 72.
4.2 – ACESSO AO ERP DA LOJA:
No momento que o integrador começa a desenvolver a integração entre o Linx Microvix e o sistema
terceiro é indispensável que o mesmo tenha acesso ao ERP, que é liberado pelo responsável pela
empresa. Sendo assim a Linx não se responsabiliza pelo envio de q ualquer informação presente no
ERP do cliente.
4.3 – BIT
Os campos com descrição/tipo “BIT”, em alguns métodos poderão retornar 0 e 1 ou False e True,
pois “BIT” é Boolean (Em ciência da computação, boolean, ou lógico, é um tipo de dado primitivo
que possui dois valores, que podem ser considerados como 0 ou 1, fals o ou verdadeiro).
4.4 - Microvix GO
Devido ao Microvix GO ser uma Versão Reduzida do Microvix Full, algumas funcionalidades do ERP
não estão disponíveis nesta Oferta.
Sendo assim, alguns métodos deste Webservice poderão não retornar dados, caso a Oferta
contratada seja Microvix GO.
Página 13
Por Exemplo : Método LinxPedidosVenda , pois a rotina de Orçamento/Pedido de Venda não é
disponibilizada no Microvix GO.
5. Layou t e descrição dos campos
Método LinxMetodos (Retorna as informações com o nome dos métodos e parâmetros de
pesquisa):
Campos Tipo Descrição
Retorno VARCHAR (MAX) Nome do Método – descrição (parâmetros)
Parâmetros de consulta do método LinxMetodos
(Não é necessário nenhum parâmetro para consulta do método LinxMetodos)
Método LinxGrupoLojas (Retorna todos os CNPJs e Nome da Empresa do Grupo ou Rede):
Campos Tipo Descrição
CNPJ VARCHAR (14) CNPJ da Loja
nome_empresa VARCHAR (50) Nome da Loja
id_empresas_rede INT Id da Rede no Microvix
rede VARCHAR (100) Nome da Rede no Microvix
portal INT Id do Portal no Microvix
nome_portal VARCHAR (50) Nome do Portal no Microvix
empresa INT Id da empresa no portal
lojas_proprias BIT Indica se é um portal de lojas próprias de
uma rede
classificacao_portal VARCHAR (50) Classificação do portal
Parâmetros de consulta do método LinxGrupoLojas :
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
Grupo Não VARCHAR (100) Nome do grupo de cadastro na ativação
do WebService. ( Nome a ser fornecido
pela Linx no momento da ativação )
id_empresas_rede Não INT Id da rede no Microvix
Portal Não INT Id do Portal no Microvix
Página 14
Método LinxL ojas (Retorna os dados de uma loja, conforme pesquisa):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
empresa INT Código da Empresa no Microvix
nome_emp VARCHAR (50) Nome Fantasia
razao_emp VARCHAR (200) Nome Razão Social
cnpj_emp VARCHAR (14) CNPJ da loja
inscricao_emp VARCHAR (20) Inscrição Estadual
endereco_emp VARCHAR (250) Endereço
num_emp INT Número Endereço
complement_emp VARCHAR (60) Complemento
bairro_emp VARCHAR (50) Bairro
cep_emp CHAR (9) CEP
cidade_emp VARCHAR (50) Cidade
estado_emp CHAR (2) UF
fone_emp VARCHAR (70) Telefone
email_emp VARCHAR (50) E-mail
cod_ibge_municipio INT Código do Município no IBGE
data_criacao_emp SMALLDATETIME Data de criação da Empresa no Microvix
data_criacao_portal SMALLDATETIME Data de criação do portal no Microvix
sistema_tributacao CHAR (1) Sistema de Tributação
regime_tributario TINYINT Regime Tributário
area_empresa FLOAT Área da empresa em m²
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
sigla_empresa VARCHAR (10) Sigla da empresa
id_classe_fiscal SMALLINT ID da classe fiscal atrelada a empresa
centro_distribuicao BIT Centro de distribuição
inscricao_municipal_emp VARCHAR ( 10) Número da inscrição municipal da empresa
cnae_emp VARCHAR (7) Número do CNAE da empresa
cod_cliente_linx VARCHAR(6) Código Linx ERP (clifor)
tabela_preco_preferencial INT Código da tabela de preços preferencial da
empresa no Microvix
Parâmetros de consulta do método LinxL ojas:
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Não BIGINT Último Timestamp consultado
Página 15
Método LinxC lientes Fornec (Retorna os Clientes/Fornecedores cadastrados n o portal e data
pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_cliente INT Código do cliente/fornecedor no Microvix
razao_cliente VARCHAR (60) Razão Social
nome_cliente VARCHAR (60) Nome
doc_cliente VARCHAR (14) CPF/CNPJ
tipo_cliente CHAR (1) Física ou Jurídica
endereco_cliente VARCHAR (250) Endereço
numero_rua_cliente VARCHAR (20) Número Endereço
complement_end_cli VARCHAR (60) Complemento
bairro_cliente VARCHAR (60) Bairro
cep_cliente CHAR (9) CEP
cidade_cliente VARCHAR (40) Cidade
uf_cliente VARCHAR (20) UF
Pais VARCHAR (80) País
fone_cliente VARCHAR (20) Telefone
email_cliente VARCHAR (50) E-mail
Sexo CHAR (1) Sexo
data_cadastro SMALLDATETIME Data do Cadastro
data_nascimento SMALLDATETIME Data do Nascimento
cel_cliente VARCHAR (20) Celular
Ativo CHAR (1) Informa se o cliente está ativo (S) ou não (N)
dt_update SMALLDATETIME Data Alteração
inscricao_estadual VARCHAR (20) Inscrição Estadual
incricao_municipal VARCHAR (20) Inscrição Municipal
identidade_cliente VARCHAR (20) RG do cliente
cartao_fidelidade VARCHAR (20) Número do Cartão Fidelidade no Microvix. Caso
utilize o módulo de fidelidade
cod_ibge_municipio INT Código do Município no IBGE
classe_cliente VARCHAR ( 83) Código e nome da classe vinculada ao cliente.
Será retornado somente uma classe.
matricula_conveniado VARCHAR (20) Código do conveniado
tipo_cadastro CHAR (1) Tipo de cadastro:
“C” = Clientes
“F” = Fornecedores
“A” = Ambos (Cliente e Fornecedor)
“T” = Trasportadora
empresa_cadastro INT Empresa de cadastro
id_estado_civil SMALLINT Id do estado civil:
1 = Não informado
2 = Casado
3 = Solteiro
4 = Divorciado
5 = Viúvo
6 = Outros
Página 16
fax_cliente VARCHAR (50) Fax do cliente
site_cliente VARCHAR (50) Site do cliente
Timestamp BIGINT Timestamp da tabela. Ex: “185318313”.
cliente_anonimo BIT Cliente anônimo
0 = False
1 = True
limite_compras FLOAT Informa o valor do limite de compra registrado
no campo Limite de Crédito (Crediário) no
cadastro de clientes e fornecedores.
codigo_ws VARCHAR(100) Esse campo exporta o código enviado na
integração via ws de entrada
limite_credito_compra FLOAT Informa o valor do limite de compra registrado
no campo Limite de Crédito (Dinheiro/Cartão) no
cadastro de clientes e fornecedores.
id_classe_fiscal INT Id da classe fiscal atríbuída ao cadastro do
cliente
Obs VARCHAR (MAX) Observação
Mae VARCHAR (60) Nome da mãe
cliente_contribuinte BIT Indica se o cliente é contribuinte
id_tipo_registro_profissional INT ID na tabela tipo_registro_profissional.
registro_profissional VARCHAR(50) Descrição registro profissional
recebe_newsletter BIT Indica se o cliente recebe newsletter.
diferencial_icms_fornec BIT Indica se possui diferencial de ICMS
perc_diferencial_icms_fornec FLOAT Percentual de diferencial de ICMS
id_classe_preferencial SMALLINT Código da classe preferencial vinculada ao
cliente
id_subclasse_preferencial SMALLINT Código da subclasse preferencial vinculada ao
cliente.
Parâmetros de consulta do método LinxC lientes Fornec
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Não BIGINT Último Timestamp consultado
data_inicial Sim DATE Data Inicial de Cadastro. Só pode ser
“NULL” quando informado cod_cliente.
data_fim Sim DATE Data Final de Cadastro. Só pode ser
“NULL” quando informado cod_cliente.
cod_cliente Não INT Código do cliente/fornecedor no
Microvix. Se informar o código, todas
as datas devem ser “NULL”
dt_update_inicial Não DATE Data Inicial de alteração do registro.
dt_update_fim Não DATE Data Final de alteração do registro.
doc_cliente Não VARCHAR (14) CPF ou CNPJ do cliente ou fornecedor.
matricula_conveniado Não VARCHAR (20) Código do conveniado
tipo_cadastro Não VARCHAR (1 0) Tipo de cadastro. Pode ser informado
mais de um tipo separado por vírgula.
Exemplo: "C,A,T".
Página 17
Método LinxClientesFornecCamposAdicionais (Retorna os campos adicionais preenchidos dos
Clientes/Fornecedores cadastrados no portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_cliente INT Código do cliente/fornecedor no Microvix
campo VARCHAR (50) Nome do campo adicional.
valor VARCHAR (100) Valor do campo adicional
Parâmetros de consulta do método LinxClientesFornecCamposAdicionais :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
data_inicial Sim DATE Data Inicial de Cadastro.
data_fim Sim DATE Data Final de Cadastro.
cod_cliente Não INT Código do cliente/fornecedor no Microvix.
Método LinxClientesFornecClasses (Retorna todas as classes vinculadas a um
cliente/fornecedor):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
cod_cliente INT Código do cliente/fornecedor no Microvix
cod_classe SMALLINT Código da classe vinculada ao cliente.
nome_classe VARCHAR (50) Nome da classe vinculada ao cliente.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxClientesFornecClasses :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
cod_classe Não SMALLINT Código da classe vinculada ao cliente.
cod_cliente Não INT Código do cliente/fornecedor no Microvix
Método LinxClientesFornecContatos (Retorna os campos referentes ao contato do cadastro dos
Clientes/Fornecedores cadastrados no portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_cliente INT Código do cliente/fornecedor no Microvix
nome_contato VARCHAR (50) Nome Contato
sexo_contato CHAR (1) Sexo Contato:
‘F’ = Feminino
‘M’ = Masculino
contatos_clientes_parentesco TINYINT ID do parentesco do contato
fone1_contato VARCHAR (20) Telefone principal Contato
fone2_contato VARCHAR (20) Telefone secundário Contato
Página 18
celular_contato VARCHAR (20) Celular do Contato
email_contato VARCHAR (50) E-Mail do contato
data_nasc_contato SMALLDATETIME Data de Nascimento do Contato
tipo_contato VARCHAR (20) Tipo de Contato
Parâmetros de consulta do método LinxClientesFornecContatos :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
data_inicial Sim DATE Data Inicial de Cadastro de clientes.
data_fim Sim DATE Data Final de Cadastro de clientes.
cod_cliente Não INT Código do cliente/fornecedor no Microvix.
Se informar o código, todas as datas
devem ser “NULL”
doc_cliente Não VARCHAR ( 14) CPF ou CNPJ do cliente ou fornecedor.
Método LinxClientesFornecCreditoAvulso (Retorna informação dos créditos avulso gerado para
determinados clientes de acordo com a loja e data pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
empresa INT Código da Empresa no Microvix
cod_cliente INT Código do cliente/fornecedor no Microvix
controle INT Número de controle do vale
data DATE Data da geração do vale
cd CHAR (1) C = Crédito e D = Débito
valor MONEY Saldo do vale
motivo VARCHAR (MAX) Motivo da geração do vale
timestamp BIGINT Timestamp da tabela. Ex: “185318313”.
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as informações
do documento fiscal.
cnpj_emp VARCHAR(14) CNPJ da Empresa.
Parâmetros de consulta do método LinxClientesFornecCreditoAvulso (Retorna informação dos
créditos avulso gerado para determinados clientes de acordo com a loja e data pesquisada):
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
cod_cliente Não INT Código do cliente/fornecedor no Microvix.
data_inicial Não DATE Data Inicial de Cadastro do crédito.
data_fim Não DATE Data Fi nal de Cadastro do crédito.
Página 19
Método LinxFidelidade (Retorna os dados da tabela fidelidade_parceiros_log cadastrados no
portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
id_fidelidade_parceiro_log INT ID fidelidade do parceiro
data_transacao SMALLDATETIME Data da transação
operacao TINYINT Tipo de Operação:
2 = Venda
3 = Consulta Pontos
4 = Sem json de retorno
5 = Cancelamento Transação
6 = Funcionalidade não implementada
aprovado_barramento VARCHAR (4) Tipos de erros e exceções:
0 = Venda Normal
1 = Ocorreu uma exceção ao processar a
requisição
-1 = funcionalidade não implementada
404 = erro na emissão
10 = erro de cliente não existente/erro
inesperado
NULL = transação sem retorno
valor_monetario MONEY Valor da transação
numero_cartao VARCHAR (100) Número do cartão fidelidade
identificador_movimento UNIQUEIDENTIFIER Identificador correspondente a transação
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxFidelidade :
Campos Obrigatório Tipo Observações
chave SIM UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp SIM VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp SIM BIGINT Último Timestamp consultado
data_inicial Não DATE Data de lançamento inicial de
pesquisa da movimentação.
data_fim Não DATE Data de lançamento final de pesquisa
da movimentação.
numero_cartao Não VARCHAR (100) Número do cartão fidelidade
Método LinxM ovimento (Retorna as movimentações de entradas e saídas de acordo com a
loja e data pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
transacao INT Código interno do Microvix
Página 20
usuario INT Usuário que realizou a
movimentação.
documento INT Número do documento fiscal
chave_nf VARCHAR (44) Chave da Nota fiscal
ecf INT Número do ECF
numero_serie_ecf VARCHAR (30) Número de série do ECF
modelo_nf INT Código do Modelo da NF
data_documento SMALLDATETIME Data de geração do registro no
Microvix
data_lancamento SMALLDATETIME Data de lançamento do documento
fiscal
codigo_cliente INT Código do cliente no Microvix
serie VARCHAR (10) Série do documento
desc_cfop VARCHAR (300) Descrição da CFOP fiscal
id_cfop VARCHAR (5) Código da CFOP Fiscal
cod_vendedor INT Código do Vendedor no Microvix
quantidade FLOAT Quantidade do produto
preco_custo MONEY Custo do produto
valor_liquido MONEY Valor Líquido do produto
desconto MONEY Desconto na venda
cst_icms VARCHAR (4) CST fiscal de ICMS
cst_pis VARCHAR (4) CST fiscal de PIS
cst_cofins VARCHAR (4) CST fiscal de COFINS
cst_ipi VARCHAR (4) CST fiscal de IPI
valor_icms MONEY Valor ICMS
aliquota_icms MONEY Aliquota do ICMS
base_icms MONEY Base do ICMS
valor_pis MONEY Valor PIS
aliquota_pis MONEY Aliquota do PIS
base_pis MONEY Base do PIS
valor_cofins MONEY Valor Cofins
aliquota_cofins MONEY Aliquota do Cofins
base_cofins MONEY Base do Cofins
valor_icms_st MONEY Valor ICMS ST
aliquota_icms_st MONEY Aliquota do ICMS ST
base_icms_st MONEY Base do ICMS ST
valor_ipi MONEY Valor IPI
aliquota_ipi MONEY Aliquota do IPI
base_ipi MONEY Base do IPI
valor_total MONEY Valor Total do Item
forma_dinheiro BIT Pagamento em dinheiro (0 ou 1)
total_dinheiro MONEY Total de pagamento da forma
Dinheiro
forma_cheque BIT Pagamento em cheque (0 ou 1)
total_cheque MONEY Total de pagamento da forma
cheque
Página 21
forma_cartao BIT Pagamento em cartão (0 ou 1)
total_cartao MONEY Total de pagamento da forma
Cartão
forma_crediario BIT Pagamento em crediário (0 ou 1)
total_crediario MONEY Total de pagamento da forma
Crediário
forma_convenio BIT Pagamento em convênio (0 ou 1)
total_convenio MONEY Total de pagamento da forma
Convenio.
frete MONEY Valor Frete
operacao CHAR (2) Operação:
E = Entrada
S = Saída
DE = Devolução de Entrada
DS = Devolução de Saída
N = Neutro
C = Nota Subst utiva de CF
tipo_transacao CHAR (1) Detalhamento da operação
utilizada:
J = Ajuste de Estoque
P = Faturamento de Pedido
S ou Vazio = Normal
E = Entrada
D = Transferência entre Depósitos
T = Transferência entre Filiais
R = Reserva de Estoque
V = Venda
C = Nota Subst utiva de CF
I = Complemento ICMS
M = Manufatura
A = Faturamento de OS
O = Baixa de Consumo de OS
VAZIO = Considerar apenas a
operação
cod_produto BIGINT Código do produto no Microvix
cod_barra VARCHAR (20) Código de Barras
cancelado CHAR (1) S ou N (indica que o Documento
foi cancelado ou está valido)
excluido CHAR (1) S ou N (indica que o Documento
foi excluído ou está valido)
soma_relatorio CHAR (1) S ou N (Indica se a movimentação
utiliza uma natureza de operação
que não soma em relatórios)
identificador UNIQUEIDENTIFI
ER Código para identificar e agrupar
as informações do documento
fiscal.
deposito VARCHAR (100) Nome do depósito
obs VARCHAR (MAX) Observação do documento
preco_unitario MONEY Valor unitário do item no momento
da venda.
hora_lancamento CHAR (5) Hora do lançamento. Time (00:00)
natureza_operacao VARCHAR (60) Exibe a descrição da Natureza da
Operação.
Página 22
tabela_preco INT Código Tabela de Preço
nome_tabela_preco VARCHAR (50) Descrição Tabela Preço
cod_sefaz_situacao TINYINT Código da situação no SEFAZ
desc_sefaz_situacao VARCHAR (30) Descrição da situação no SEFAZ
protocolo_aut_nfe VARCHAR (15) Protocolo de NF para saídas.
dt_update SMALLDATETIME Última atualização do registro no
Banco de dados. Ex:
cancelamentos
forma_cheque_prazo BIT Forma de pagamento cheque a
prazo
total_cheque_prazo MONEY Total de pagamento da forma
cheque a prazo.
cod_natureza_operacao CHAR (10) Código da Natureza de Operação
preco_tabela_epoca MONEY Valor do produto no momento da
venda mas utilizando a tabela
Padrão.
desconto_total_item MONEY Valor do desconto no item.
conferido CHAR (1) Indica se a nota de transferência
foi conferida S ou N
transacao_pedido_venda INT Indica o número de transação
referente ao pedido de venda
codigo_modelo_nf VARCHAR (5) Código do modelo NF
acrescimo MONEY Acréscimo na venda
mob_checkout BIT Venda mobile
aliquota_iss MONEY Alíquota do ISS
base_iss MONEY Base do ISS
ordem SMALLINT Ordem em que o campo aparece
no ERP
codigo_rotina_origem TINYINT Código da rotina origem
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
troco MONEY Troco da forma de pagamento
dinheiro . Exemplo: 0.0000
transportador INT Código do transportador
cadastrado no Microvix
icms_aliquota_desonerado MONEY Alíquota de desoneração do ICMS
icms_valor_desonerado_item MONEY Valor da desoneração do ICMS no
item
empresa INT Id da empresa no portal
desconto_item MONEY Desconto do item
aliq_iss MONEY Valor da alíquota de ISS
iss_base_item MONEY Valor base do item
despesas MONEY Valor da despesa
seguro_total_item MONEY Seguro total do item
acrescimo_total_item MONEY Acréscimo total do item
despesas_total_item MONEY Despesa total do item
forma_pix BIT Pagamento em pix (0 ou 1)
total_pix MONEY Total de pagamento da forma pix
forma_deposito_bancario BIT Pagamento em depósito bancário
(0 ou 1)
Página 23
total_deposito_bancario MONEY Total de pagamento da forma
depósito bancário
id_venda_produto_b2c INT ID da venda do produto no B2C
item_promocional BIT Item promocional
acrescimo_item BIT Acréscimo do item
icms_st_antecipado_aliquota MONEY Alíquota de ICMS ST antecipado
icms_st_antecipado_margem MONEY Margem de ICMS ST antecipado
icms_st_antecipado_percentual_reducao MONEY Percentual de reducao de ICMS ST
antecipado
icms_st_antecipado_valor_item MONEY Valor de ICMS ST antecipado no
item
icms_base_desonerado_item MONEY Base da desoneração do ICMS no
item
codigo_status_nfe VARCHAR (5) Código de status da nfe
preco_produto_epoca MONEY Informação do preço do produto
antes de receber um desconto de
promoção
ficha INT Número da ficha
numero_sequencial_pos INT Número do sequencial POS
dt_insert SMALLDATETIME Data de inserção do registro na
base de dados do ERP.
custo_medio_epoca FLOAT Custo médio do produto na época
do lançamento
OBS1: A operação N (Neutro) irá retornar quando a movimentação não atualiza estoque.
Neste caso, a identificação sobre a movimentação ser de entrada ou saída, vai ficar na coluna
tipo_transacao .
OBS2: explicação sobre os diferentes campos de desconto aprese ntados no método
LinxMovimento :
Desconto: É o total de desconto aplicado na venda, seja desconto manual, desconto reshop,
desconto Marka, etc, é o total de desconto aplicado na Venda apenas.
Ex.: Uma venda com 2 produtos, um custa 80,00 e o outro 20,00, total, 100,00, desconto na venda
de 20,00, total a pagar 80,00, total desconto (que o campo desconto ) será 20,00 . Dessa forma
se o desconto for aplicado no valor total da venda, alimentará o campo "desconto" com o desconto
total da venda e o campo "desconto_total_item" com o mesmo percentual do desconto aplicado
nos itens.
Desconto_item: É o desconto que foi aplicado apenas no item ao adicionar o item na venda.
Ex.: Produto custa 100,00 e foi vendido por 90,00, o desconto_item será 10,00 . Dessa forma s e
o modelo do documento for NFC e/SAT, o desconto aparecerá no campo: desconto_item ;
Se o modelo do documento for NF -e, não alimentará o campo: desconto_item . Para esse caso,
poderá verificar a diferença, subtraindo os campos: " preco _tabela_epoca - preco_unitario”.
desconto_total_item : É o rateio proporcional aplicado a cada item com base no desconto da
venda e o valor de cada item. O desconto em cada item é de acordo com a importância dele na
venda quanto mais caro o item, ma ior será o valor do desconto n o desconto_total_item . É um
cálculo com base no valor total da venda, o valo r do item e o total de desconto .
Página 24
Ex.: Uma venda com 2 produtos, um custa R$ 95,90 e o outro R$ 115,50 , total R$ 211,40 ,
desconto na venda de R$ 31,71 (15%) , total a pagar R$ 179,69.
O desconto_total_item item do item item 1 (item que custa R$ 95,90 ) será: R$ 14,39
O desconto_total_item item do item item 2 (item que custa R$ 115,50 ) será: R$ 17,32
Cálculo realizado:
importanciaItem = ((precoUnitario * qtde)) / totalVenda
desconto_total_item = descontoTotal * importanciaItem
ITEM 1
importanciaItem = ((95,9 * 1)) / 211,40
desconto_total_item = 31,7 * 0,4536423841059603
desconto_total_item = 14,385 >> 14,39
ITEM 2
importanciaItem = ((115,50* 1)) / 179,69
desconto_total_item = 31,7 * 0,5463576158940397
desconto_total_item = 17,319 >> 17,32
Total Desconto: 14,39 + 17,32 = 31,71
OBS3: Tipos de transação de saída por venda “S”, “P”, “A” e “M”.
Parâmetros de consulta do método LinxM ovimento :
Campos Obrigatório Tipo Observações
chave SIM UNIQUEIDENTIFIER Chave de acesso ao
Webservice
cnpjEmp SIM VARCHAR (14) Deverá ser informado
o CNPJ da loja a ser
consultado
timestamp SIM BIGINT Último Timestamp
consultado
data_inicial Sim DATE Data de lançamento
inicial de pesquisa da
movimentação.
data_fim Sim DATE Data de lançamento
final de pesquisa da
movimentação.
hora_inicial Não CHAR (5) Hora de lançamento
inicial de pesquisa da
movimentação. Time
(00:00)
hora_fim Não CHAR (5) Hora de lançamento
final de pesquisa da
Página 25
movimentação. Time
(00:00)
operacao Não CHAR (2) Operação
tipo_transacao Não CHAR (1) Detalhamento da
operação utilizada
dt_update_inicial Não SMALL DATE TIME Data Alteração Inicial
de pesquisa da
movimentação.
dt_update_fim Não SMALLDATETIME Data Alteração final de
pesquisa da
movimentação.
identificador Não UNIQUEIDENTIFIER Identificador de
movimento.
cod_cliente Não INT Código do cliente.
cod_produto Não BIGINT Código do Produto.
documento Não INT Número do documento
fiscal.
empresa Não INT Id da empresa no
portal
cancelado Não CHAR(1) Indica se o documento
está ou não cancelado.
Valores aceitáveis: S -
Sim e N - Não.
filtra_somente_timestamp Não BIT Quando informado o
valor 1, ignora todos
os demais filtros,
mesmo obrigatórios e
filtra apenas por
timestamp com
retorno paginado.
Ignora até o CNPJ,
retornando dados de
todas as empresas do
portal.
Neste caso, é
imprescindível
informar o parâmetro
timestamp em
conjunto, caso
contrário, não
retornará registros.
Método LinxMovimentoCartoes (Retorna informações dos cartões utilizados na s
movimentações de venda de a cordo com a loja pesquisada ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
codlojasitef VARCHAR (10) Código de loja Sitef
data_lancamento SMALLDATETIME Data de lançamento do documento
identificador UNIQUEIDENTIFIER Identificador de movimento
cupomfiscal VARCHAR (20) Número de cupom fiscal
credito_debito CHAR (1) “C” = Crédito
“D” = Débito
Página 26
id_cartao_bandeira INT Id de cadastro bandeira do cartão
descricao_bandeira VARCHAR (100) Descrição da bandeira do cartão utilizado
valor MONEY Valor utilizado no cartão
ordem_cartao TINYINT Número de ordem do cartão, quando
múltiplos cartões
nsu_host VARCHAR ( 50) NSU Host
nsu_sitef VARCHAR ( 50) NSU Sitef
cod_autorizacao VARCHAR ( 50) Código de autorização da transação
id_antecipacoes_financeiras INT ID da antecipação financeira, caso haja
transacao_servico_terceiro BIT Indica se a transação de venda é de serviço
terceiro
texto_comprovante VARCHAR (MAX) Texto Comprovante
id_maquineta_pos INT ID cadastro da maquineta de cartão (Não tef)
descricao_maquineta VARCHAR (50) Descrição dada a Maquineta
serie_maquineta VARCHAR (50) Serie Maquineta
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
cartao_prepago VARCHAR(1) Indica a utilização de cartão pré -pago
Parâmetros de consulta do método LinxMovimentoCart oes:
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ
da loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
data_inicial Não DATE Data de lançamento inicial de
pesquisa da movimentação.
data_fim Não DATE Data de lançamento final de
pesquisa da movimentação.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
id_antecipacoes_financeiras Não INT Id antecipações financeiras
apenas_com_faturas Não BIT 1 ou não informado – retorna
apenas registros que possuem
faturas.
0 – retorna todos os registros .
Método LinxMovimentoExtensao (Retorna informações complementares da movimentação ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
transacao INT Código interno do Microvix
identificador UNIQUEIDENTIFIER Código para identificar e agrupar
as informações do documento
fiscal.
base_fcp_st MONEY Base FCP ST
valor_fcp_st MONEY Valor FCP ST
aliq_fcp_st MONEY Alíquota FCP ST
base_icms_fcp_st MONEY Base ICMS FCP ST
Página 27
valor_icms_fcp_st MONEY Valor ICMS FCP ST
base_icms_fcp_st_retido MONEY Base ICMS FCP ST retido
valor_icms_fcp_st_retido MONEY Valor do ICMS ST FCP retido
base_icms_fcp_st_antecipado MONEY Base ICMS FCP ST antecipado
valor_icms_fcp_st_antecipado MONEY Valor do ICMS ST FCP antecipado
aliquota_icms_fcp_st_antecipado MONEY Alíquota FCP ST antecipado
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
valor_iss FLOAT Valor do ISS
tipo_tributacao_iss SMALLINT 0 = Isento
1 = Não Tributado
2 = Substituição Tributária
3 = Tributado
4 = Retido
icms_fcp_aliquota MONEY Alíquota do ICMS FCP
icms_fcp_base_item MONEY Base do ICMS FCP do item
icms_fcp_valor_item MONEY Valor do ICMS FCP do item
icms_base_partilha MONEY Valor correspondente ao
apresentado na tag <vBCUFDest>
do XML da NFe
aliq_difal_interna_uf_destinatario MONEY Valor correspondente ao
apresentado na tag
<pICMSUFDest> do XML da NFe.
aliq_difal_interestadual_uf_envolvidas MONEY Valor correspondente ao
apresentado na tag <pICMSInter>
do XML da NFe
icms_item_perc_partilha_destino MONEY Valor correspondente ao
apresentado na tag
<vICMSUFDest> do XML da NFe
icms_item_perc_partilha_origem MONEY Valor correspondente ao
apresentado na tag
<vICMSUFRemet> do XML da NFe
codigo_pacote BIGINT Código do pacote
codigo_itens_associados
BIGINT Código dos itens associados
codigo_kit BIGINT Código do kit
id_motivo_desconto INT ID do motivo de desconto no item
icms_st_antecipado_base_item MONEY Base de ICMS ST antecipado no
item
icms_suportado_valor_item MONEY Valor de ICMS suportado no item
icms_suportado_valor_unitario MONEY Valor unitário de ICMS suportado
icms_st_pago_base MONEY Base de ICMS ST pago
icms_st_pago_valor MONEY Valor de ICMS ST pago
icms_st_pago_aliq MONEY Alíquota de ICMS ST pago
icms_para_st_pago_valor MONEY Valor de ICMS para ST pago
cod_cliente_indicador INT Código do cliente indicador
motivo_desconto_observacao VARCHAR ( 500) Observação do motivo de
desconto
Página 28
Parâmetros de consulta do método LinxMovimentoExtensao :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
data_inicial Não DATE Data de lançamento inicial de pesquisa da
movimentação.
data_fim Não DATE Data de lançamento final de pesquisa da
movimentação.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
Método LinxMovimentoTrocas (Retorna os valores e números das trocas realizadas nas vendas ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as
informações do documento fiscal.
num_vale BIGINT Número do vale troca
valor_vale MONEY Valor do vale troca
motivo VARCHAR (50) Descrição do motivo da Troca
doc_origem INT Número do documento de origem
relacionado a devolução
serie_origem CHAR (10) Número da serie de origem relacionado
a devolução.
doc_venda INT Número do documento relacionado a
venda
serie_venda CHAR (10) Número da serie relacionad a a venda.
excluido BIT Se troca está excluída
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
desfazimento BIT 1 quando a troca tiver identificador nulo,
saldo negativo e doc_venda 0
empresa INT Id da empresa no portal
vale_cod_cliente INT Código do cliente vinculado na venda
onde o vale compra avulso foi utilizado
como pagamento
vale_codigoproduto BIGINT Código do produto no vale troca
id_vale_ordem_servico_externa INT Id do vale de ordem de serviço externa
doc_venda_origem INT Apresenta Documento de Origem da
Venda para operação de Troca Nacional
serie_venda_origem CHAR(10) Apresenta Série de Origem da Venda
para operação de Troca Nacional
cod_cliente INT Código do cliente selecionado na criação
do vale compra avulso
data_vencimento SMALLDATETIME Data de vencimento do vale troca
valor_original MONEY Valor original do vale troca (negativo
quando abatimento de saldo)
id_antecipacoes_financeiras INT ID da antecipação financeira na tabela
antecipacoes_financeiras
Página 29
Obs: Os registros que estiverem com os campos doc_venda = 0 e serie_venda = 0 são as
transações de Devolução , que só gerou o vale. Já os registros que estiverem com os campos
identificador preenchido, doc_venda e serie_venda <> 0 são as transações de Venda que
utilizaram o valor do vale como pagamento.
Parâmetros de consulta do método LinxMovimentoTrocas :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Não BIGINT Último Timestamp consultado
data_inicial Não DATE Data de lançamento inicial para consulta.
data_fim Não DATE Data de lançamento final para consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
doc_origem Não INT Número do documento de origem
relacionado a devolução.
serie_origem Não VARCHAR (10) Série documento de origem relacionado a
devolução
exibir_excluidos Não BIT Quando informado 1 retornará todas trocas
(válidas e excluídas), quando informado 0 ou
não informado retornará apenas as válidas
como está hoje.
empresa Não INT Id da empresa no portal
Método LinxMotivoDevolucao (Retorna os motivos de devoluções cadastrados no ERP):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
cod_motivo INT Código motivo
descricao_motivo VARCHAR (50) Descrição do motivo
cod_deposito INT Código do depósito
ativo BIT Informa se o motivo está 1 = Sim e 0 = Não
timestamp BIGINT Timestamp da tabela. Ex: “185318313”.
Parâmetros de consulta do método LinxMotivoDevolucao :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Página 30
Método LinxMovimentoTrocafone (Retorna os valores e números dos voucher s Trocafone
realizadas nas vendas):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as informações do
documento fiscal.
num_vale BIGINT Número do vale troca Microvix
valor_vale MONEY Valor do vale troca
voucher VARCHAR (100) Código do Voucher Trocafone
nome_produto VARCHAR (250) Nome do trocado no Trocafone
condicao VARCHAR (250) Condição do produto trocado no Trocafone
id_tradein_parceiro TINYINT Informa o código ID do parceiro no Microvix
Parâmetros de consulta do método LinxMovimentoTrocafone :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
data_inicial Não DATE Data de lançamento inicial para
consulta.
data_fim Não DATE Data de lançamento final para
consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
id_tradein_parceiro Não TINYINT Informa o código ID do parceiro no
Microvix
Método LinxMovimentoOrigemDe volucoes (Retorna os documentos de origem relacionados as
devoluções):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as informações do
documento fiscal.
nota_origem INT Número da NF de Origem
ecf_origem INT Número da ECF de origem
data_origem SMALLDATETIME Data lançamento da NF origem
serie_origem VARCHAR (10) Serie da NF de origem
empresa INT Id da empresa no portal
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoOrigemDevolucoes :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
Página 31
data_inicial Sim DATE Data de lançamento inicial para consulta.
data_fim Sim DATE Data de lançamento final para consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
hora_inicial Não CHAR (5) Hora de lançamento inicial de pesquisa da
movimentação. Time (00:00)
hora_fim Não CHAR (5) Hora de lançamento final de pesquisa da
movimentação. Time (00:00)
nota_origem Não INT Número da NF de Origem.
empresa Não INT Id da empresa no portal
timestamp Não BIGINT Último Timestamp consultado
Método LinxMovimentoSerial (Retorna os Código de Seriais realizadas nas movimentações):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as informações do
documento fiscal.
transacao INT Código interno do Microvix
serial VARCHAR (50) Código do Serial
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoSerial :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a
ser consultado
data_inicial Não DATE Data de lançamento inicial para
consulta.
data_fim Não DATE Data de lançamento final para
consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
hora_inicial Não CHAR (5) Hora de lançamento inicial de
pesquisa da movimentação. Time
(00:00)
hora_fim Não CHAR (5) Hora de lançamento final de pesquisa
da movimentação. Time (00:00)
timestamp Não BIGINT Último Timestamp consultado
Método LinxPlanos (Retorna o cadastro dos Planos de Pagamentos do portal ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
plano INT Código interno do plano de pagamento no Microvix
desc_plano VARCHAR ( 100) Descrição do plano de pagamento
qtde_parcelas INT Quantidade de parcelas
prazo_entre_parcelas INT Prazo em dias entre as parcelas
tipo_plano CHAR (1) Compra = “C”, Venda = “V”
Página 32
indice_plano MONEY Índice do plano de pagamento.
cod_forma_pgto INT Código da forma de pagamento
forma_pgto VARCHAR (50) Nome da forma de pagamento
conta_central INT Código da Conta Central vinculado ao cadastro de
Clientes/Fornecedores
tipo_transacao CHAR (1) Para forma de pagamento cartão. “D” = Débito e “C” =
Crédito
taxa_financeira MONEY Percentual da taxa financeira das administradoras de
cartões
dt_upd SMALLDATETIME Data de Alteração
Desativado CHAR (1) Desativado = “S” ou “N”.
usa_tef CHAR (1) Usa Tef = “S” ou “N”
Timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_ws VARCHAR(50) Código recebido da integração via Webservice
valor_minimo_parcela MONEY
Valor mínimo da parcela
Parâmetros de consulta do método LinxPlanos :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_upd_inicial Sim DATE Data Alteração inicial.
data_upd_fim Sim DATE Data Alteração final.
timestamp Não BIGINT Último Timestamp consultado
plano Não INT Código interno do plano de pagamento no
Microvix.
Método LinxPlanosBandeiras (Retorna o cadastro de bandeiras de cartões vinculadas aos Planos
de Pagamento do Portal ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
plano INT Código interno do plano de pagamento no Microvix
bandeira VARCHAR (30) Descrição da Bandeira no Microvix
tipo_bandeira VARCHAR (100) Descrição do Tipo de Bandeira vinculada.
adquirente INT Código da Adquirente/Operadora vinculado ao cadastro
de Clientes/Fornecedores
nome_adquirente VARCHAR (60) Nome da Adquirente/Operadora vinculado ao cadastro de
Clientes/Fornecedores
codigo_bandeira_sitef VARCHAR(10) Código da bandeira Sitef
Parâmetros de consulta do método LinxPlanos Bandeiras :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_upd_inicial Não DATE Data Alteração inicial.
data_upd_fim Não DATE Data Alteração final.
Página 33
Método LinxMovimentoPlanos (Retorna os Planos de Pagamentos realizados nas
movimentações):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as informações do
documento fiscal.
plano INT Código interno do plano de pagamento no Microvix
desc_plano VARCHAR ( 100) Descrição do plano de pagamento
total MONEY Total pago no plano
qtde_parcelas INT Quantidade de parcelas
indice_plano MONEY Índice do plano de pagamento definido na
movimentação
cod_forma_pgto INT Código da forma de pagamento
forma_pgto VARCHAR (50) Nome da forma de pagamento
tipo_transacao CHAR (1) Para forma de pagamento cartão. “D” = Débito e “C” =
Crédito
taxa_financeira MONEY Percentual da taxa financeira das administradoras de
cartões
ordem_cartao INT Ordem do cartão. Ex: 1,2,3, etc. Somente para planos
da forma Cartão
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
empresa INT Id da empresa no portal
Parâmetros de consulta do método LinxMovimentoPlanos :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial Não DATE Data de lançamento inicial para consulta.
data_fim Não DATE Data de lançamento final para consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
hora_inicial Não CHAR (5) Hora de lançamento inicial de pesquisa da
movimentação. Time (00:00)
hora_fim Não CHAR (5) Hora de lançamento final de pesquisa da
movimentação. Time (00:00)
timestamp Não BIGINT Último Timestamp consultado
empresa Não INT Id da empresa no portal
diferenciar_avista Não BIT Indica se será feita a diferenciação das formas
de pagamento a vista
Método LinxMovimentoDevolucoesItens (Retorna os dados da tabela
movimento_devolucoes_itens cadastrados no portal):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador_venda UNIQUEIDENTIFIER Identificador da tabela movimento
identificador_devolucao UNIQUEIDENTIFIER Identificador da tabela movimento
Página 34
codigoproduto BIGINT Código de produto no Microvix
id_movimento_devolucoes_itens INT Código interno das devoluções
transacao_origem INT Transação do documento de origem da
devolução
transacao_devolucao INT Transação da devolução
qtde_devolvida FLOAT Quantidade devolvida
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoDevolucoesItens :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
transacao_devolucao Não CHAR (5) Transação da devolução
Método LinxSangriaSuprimentos (Retorna as informações das Sangrias ou Suprimentos feitos
no caixa):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
usuario INT Usuário que realizou a movimentação.
data Date Data do registro
valor MONEY Valor de Sangria ou Suprimento
obs TEXT Descrição da Sangria ou Suprimento
cancelado CHAR (1) S ou N (indica que o registro foi cancelado ou
está valido)
conferido BIT 1 ou 0 (indica que o Documento foi conferido
ou não)
cod_historico BIGINT Código do Histórico no Microvix
desc_historico VARCHAR (50) Descrição do Histórico
id_sangria_suprimentos INT ID das sangria e suprimentos
Obs: Os valores negativos são referentes a Sangrias e os valores positivos são referentes aos
Suprimentos.
Parâmetros de consulta do método LinxSangriaSuprimentos :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial Sim DATE Data de lançamento inicial para consulta.
data_fim Sim DATE Data de lançamento final para consulta.
Página 35
Método LinxMovimentoAcoesPromocionais (Retorna as Ações Promocionais realizadas nas
movimentações):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as
informações do documento fiscal.
transacao INT Código interno do Microvix
id_acoes_promocionais INT Código Ação Promocional
desconto_item MONEY Valor Desconto Ação
quantidade INT Quantidade de ações na venda
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoAcoesPromocionais :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial Não DATE Data de lançamento inicial para consulta.
data_fim Não DATE Data de lançamento final para consulta.
identificador Não UNIQUEIDENTIFIER Identificador de movimento.
hora_inicial Não CHAR (5) Hora de lançamento inicial de pesquisa da
movimentação. Time (00:00)
hora_fim Não CHAR (5) Hora de lançamento final de pesquisa da
movimentação. Time (00:00)
timestamp Não BIGINT Último Timestamp consultado
Método LinxAcoesPromocionais (Retorna as Ações Promocionais cadastradas no Microvix):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
id_acoes_promocionais INT Código Ação Promocional
descricao VARCHAR (100) Descrição da Ação Promocional
vigencia_inicio SMALLDATETIME Data de início da vigência
vigencia_fim SMALLDATETIME Data final da vigência
observacao VARCHAR (MAX) Observação da Ação promocional
ativa BIT Ativa: True = Sim, False = Não
excluida BIT Excluida: True = Sim, False = Não
integrada BIT Integrada: 1 = Sim, 0 = Não
qtde_integrada INT Quantidade máxima integrada pela
franqueadora
valor_pago_franqueadora MONEY Valor pago pela Franqueadora
id_acoes_promocionais_origem INT ID ação promocional origem
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Página 36
Parâmetros de consulta do método LinxAcoesPromocionais :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
ativa Não BIT Ativa: 1 = Sim, 0 = Não
data_inicial Não DATE Data de lançamento inicial para consulta.
data_fim Não DATE Data de lançamento final para consulta.
integrada Não INT Integrada: 1 = Sim, 0 = Não
timestamp Não BIGINT Último Timestamp consultado
Método LinxListaDaVez (Retorna os registros gerados na rotina de Lista da Vez):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_vendedor INT Código do vendedor no Microvix
data SMALLDATETIME Data da Lista
motivo_nao_venda VARCHAR (103) Descrição do motivo da não venda
qtde_ocorrencias INT Quantidade de ocorrências
data_hora_ini_atend SMALLDATETIME Data/Hora do início do atendimento.
data_hora_fim_atend SMALLDATETIME Data/Hora do fim do atendimento.
obs VARCHAR (MAX) Observação
desc_produto_neg VARCHAR (50) Descrição do produto negociado
valor_produto_neg MONEY Valor do produto negociado
Parâmetros de consulta do método LinxListaDaVez :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial Sim DATE Data de lançamento inicial para consulta.
data_fim Sim DATE Data de lançamento final para consulta.
cod_vendedor Não INT Código do vendedor para pesquisa.
Método LinxVendedores (Retorna os Vendedores cadastrados na loja):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_vendedor INT Código do vendedor no Microvix
nome_vendedor VARCHAR (50) Nome
tipo_vendedor CHAR (1) Tipo: V=Vendedor, C=Comprados ou
A=Ambos
end_vend_rua VARCHAR (250) Endereço
end_vend_numero INT Número Endereço
end_vend_complemento VARCHAR (60) Complemento
end_vend_bairro CHAR (60) Bairro
end_vend_cep CHAR (9) CEP
Página 37
end_vend_cidade VARCHAR (60) Cidade
end_vend_uf CHAR (2) UF
fone_vendedor VARCHAR (30) Telefone
mail_vendedor VARCHAR (50) E-mail
dt_upd SMALLDATETIME Data de Alteração
cpf_vendedor VARCHAR (11) CPF
ativo CHAR (1) Informa se o vendedor está ativo (S) ou não
(N)
data_admissao SMALLDATETIME Data de admissão
data_saida SMALLDATETIME Data de desligamento
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
matricula VARCHAR (30) Matrícula
id_tipo_venda SMALLINT ID do tipo da venda
descricao_tipo_venda VARCHAR (100) Descrição do tipo da venda
cargo VARCHAR(20) Cargo do vendedor
nome_exibicao VARCHAR(15) Nome de exibição do vendedor no Microvix.
funcao VARCHAR(100) Nome de função.
Parâmetros de consulta do método LinxVendedores :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_upd_inicial Não DATE Data de atualização inicial.
data_upd_fim Não DATE Data de atualização final.
cod_vendedor Não INT Código do vendedor para pesquisa.
timestamp Não BIGINT Último Timestamp consultado
Método LinxMetasVendedores (Retorna as Metas de Vendedores das lojas):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
id_meta INT Código da Meta no Microvix
descricao_meta VARCHAR (50) Descrição da Meta
data_inicial_meta SMALLDATETIME Data Inicial da Meta
data_final_meta SMALLDATETIME Data final da Meta
valor_meta_loja MONEY Valor da Meta da Loja
valor_meta_vendedor MONEY Valor da Meta do Vendedor
cod_vendedor INT Código do vendedor no Microvix
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Página 38
Parâmetros de consulta do método LinxMetasVendedores:
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial_meta Sim SMALLDATETIME Data Inicial da Meta.
data_fim_meta Sim SMALLDATETIME Data Final da Meta.
id_meta Não INT ID da meta.
cod_vendedor Não INT Código do vendedor para pesquisa.
timestamp Não BIGINT Último Timestamp consultado
Método LinxProdutosDepositos (Retorna informações do cadastro de depósitos no Microvix):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_deposito INT Código do depósito
nome_deposito VARCHAR (50) Nome do depósito
disponivel BIT Disponível para venda
disponivel_transferencia BIT Disponível para transferência entre filiais.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
outlet
Parâmetros de consulta do método LinxProdutos Depositos :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
cod_deposito Não INT Código do depósito
timestamp Não BIGINT Último Timestamp consultado
Método LinxProdutosInventario (Retorna informações do saldo do produto na data pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_produto BIGINT Código do produto no Microvix
cod_barra VARCHAR (20) Código de Barras do produto
quantidade FLOAT Posição do estoque na data informada
cod_deposito INT Código do depósito
Obs: Esta linha só irá aparecer caso se
informado pelo menos um deposito.
Empresa INT Id da empresa no portal
Página 39
Parâmetros de consulta do método LinxProdutosInventario :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_inventario Sim SMALLDATETIME Data de pesquisa do inventário.
cod_produto Não BIGINT Último Timestamp consultado
referencia Não VARCHAR (20) Referência do produto
cod_deposito Não VARCHAR (MAX) Códigos dos depósitos, separados por
vírgula.
empresa Não INT Id da empresa no portal
Método LinxP rodutos Detalhes (Retorna informações dos produtos de acordo com a loja
pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_produto BIGINT Código do produto no Microvix
cod_barra VARCHAR (20) Código de Barras do produto
quantidade MONEY Posição do estoque atual do produto
preco_custo MONEY Preço de custo ICMS
preco_venda MONEY Preço de venda do item na tabela padrão
custo_medio MONEY Custo médio do produto
id_config_tributaria INT Código da Configuração Tributária atrelada ao
produto
desc_config_tributaria VARCHAR (100) Descrição da Configuração Tributária atrelada
ao produto
despesas1 FLOAT Valor do campo de despesas.
qtde_minima FLOAT Quantidade mínima
qtde_maxima FLOAT Quantidade máxima
ipi FLOAT Alíquota de IPI
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
custototal FLOAT Custo total do produto
empresa INT Id da empresa no portal
id_produtos_status_compra TINYINT ID do status na tabela
produtos_status_compra
Parâmetros de consulta do método LinxP rodutos Detalhes :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_mov_ini Sim DATE Data inicial que o produto teve movimentação.
data_mov_fim Sim DATE Data final que o produto teve movimentação
Página 40
cod_produto Não BIGINT Código do produto
Obs1: Quando informado , deixar NULL nos campos
de datas
Obs2: Retorna o produto mesmo com saldo zerado
referencia Não VARCHAR (20) Referência do produto
timestamp Não BIGINT Último Timestamp consultado
empresa Não INT Id da empresa no portal
retornar_saldo_zero Não BIT Quando informado 1 todos os demais filtros serão
desconsiderados, com exceção do timestamp e
cnpjEmp, com isso o retorno será paginado
limitando o retorno em 10000 registros.
Obs1: As datas informadas na chamada do método, servirá como base para filtrar somente
produtos que tiveram movimentação no período, mas o saldo do produto retornado é sempre o
atual.
Obs2: O método LinxProdutosDetalhes retornará somente produtos com saldo dentro do período
informado, a não ser que seja indicado o código do produto no campo "cod_produto", neste caso
retornará o saldo do produto inclusive quando este tiver valor 0
Método LinxProdutosPromocoes (Retorna informações das promoções dos produtos de acordo
com a loja pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_produto BIGINT Código do produto em promoção no Microvix
preco_promocao MONEY Preço da promoção no produto
data_inicio_promocao SMALLDATETIME Data do início da Promoção
data_termino_promocao SMALLDATETIME Data do término da Promoção
data_cadastro_promocao DATETIME Data de cadastro da Promoção
promocao_ativa CHAR (1) Define se a promoção está ativa “S” ou “N”
id_campanha BIGINT Código da Campanha
nome_campanha VARCHAR (60) Nome da Campanha
promocao_opcional BIT Promoção opcional: “1” = Sim, “0” = Não
custo_total_campanha MONEY Custo total da campanha.
Parâmetros de consulta do método LinxProdutosPromocoes :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
data_cad_inicial Sim DATE Data Inicial de Cadastro da Promoção.
data_cad_fim Sim DATE Data Final de Cadastro da Promoção.
Página 41
data_vig_inicial Sim DATE Data Inicial de Vigência da Promoção.
data_vig_fim Sim DATE Data Final de Vigência da Promoção.
promocao_ativa Sim CHAR ( 1) Apenas p romoções ativas: S ou N
Método LinxP rodutos (Retorna o cadastro de produtos de acordo com a loja pesquisada ou dados
da estrutura mercadológica):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_produto BIGINT Código do produto no Microvix
cod_barra VARCHAR (20) Código de Barras do produto
nome VARCHAR (250) Nome do Produto
ncm VARCHAR (20) NCM do Produto
cest VARCHAR (10) CEST do Produto
referencia VARCHAR (20) Referência do produto
cod_auxiliar VARCHAR (40) Código Auxiliar do Produto
unidade VARCHAR (50) Unidade que o produto está cadastrado
desc_cor VARCHAR (30) Descrição da Grade 2 do produto no
Microvix
desc_tamanho VARCHAR (50) Descrição da Grade 1 do produto no
Microvix
desc_setor VARCHAR (30) Descrição do Setor do produto no Microvix
desc_linha VARCHAR (30) Descrição da Linha do produto no Microvix
desc_marca VARCHAR (30) Descrição da Marca do produto no Microvix
desc_colecao VARCHAR (50) Descrição da Coleção do produto no Microvix
dt_update SMALLDATETIME Data de alteração do produto
cod_fornecedor INT Código interno do Microvix do fornecedor
vinculado ao produto
desativado CHAR (1) Indica se o produto está desativado ou não.
desc_espessura VARCHAR (50) Descrição da Espessura do produto no
Microvix
id_espessura INT Código da Espessura do produto no Microvix
desc_classificacao VARCHAR (50) Descrição da Classificação do produto no
Microvix
id_classificacao INT Código da Classificação do produto no
Microvix
origem_mercadoria TINYINT Código da Origem da Mercadoria no Microvix
peso_liquido FLOAT Peso Liquido do Produto no Microvix
peso_bruto FLOAT Peso Bruto do Produto no Microvix
id_cor INT Código da Grade 2 do produto no Microvix
id_tamanho VARCHAR (5) Código da Grade 1 do produto no Microvix
id_setor INT Código do Setor do produto no Microvix
id_linha INT Código da Linha do produto no Microvix
id_marca INT Código da Marca do produto no Microvix
id_colecao INT Código da Coleção do produto no Microvix
dt_inclusao SMALLDATETIME Data de inclusão do produto
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Página 42
fator_conversao FLOAT Fator de conversão
codigo_integracao_ws VARCHAR (50) Para clientes com integração via Webservice
de Entrada: Código enviado na integração
codigo_integracao_reshop VARCHAR (50) Para clientes com integração via Webservice
de Entrada: campo Código enviado na
integração
id_produtos_opticos_tipo INT Código do produto optico tipo
id_sped_tipo_item INT ID sped tipo item
componente VARCHAR (1) S = Sim ou N = Não. Indica se o produto é
ou não um componente
altura_para_frete MONEY Altura do produto considerada para o frete
largura_para_frete MONEY Largura do produto considerada para o
frete.
comprimento_para_frete MONEY Comprimento do produto considerado para o
frete
loja_virtual CHAR Informa se o produto será enviado para a
loja virtual. Valores fixos de “N” ou “S”
codigoproduto_io VARCHAR(50) Código produto Linx IO
cod_comprador INT Código do comprador
codigo_integracao_oms VARCHAR(50) Código produto para OMS
obrigatorio_identificacao_cliente BIT Indica obrigatoriedade de identificação do
cliente em vendas
descricao_basica VARCHAR(100) Descrição básica do produto
curva CHAR(1) Curva ABC utilizada
tributa_fcp BIT Indica se o produto está sujeito à tributação
do fundo de combate a pobreza (FCP). Se 0
= Não, e 1 = Sim
observacao VARCHAR (1000) Observação do produto, limitado a 1000
caracteres. Só é exibido o valor quando o
parâmetro exibe_observacao for 1, senão
retorna NULL
codigo_adicional_reshop VARCHAR(100) Codigo Adicional do cadastro de produto no
ERP destinado ao Reshop
brinde BIT Indica brinde
Parâmetros de consulta do método LinxP rodutos :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
dt_update_inicio Sim SMALLDATETIME Data inicial de alteração do produto.
dt_update_fim Sim SMALLDATETIME Data final de alteração do produto.
id_setor Não INT Código do Setor do produto no
Microvix.
id_linha Não INT Código da Linha do produto no
Microvix.
id_marca Não INT Código da Marca do produto no
Microvix.
id_colecao Não INT Código da Coleção do produto no
Microvix.
cod_produto Não BIGINT Código do produto no Microvix.
referencia Não VARCHAR (20) Referência do produto no Microvix.
Página 43
filtrar_empresa Não BIT Filtrar apenas produtos disponíveis
para o CNPJ informado.
codigo_integracao_ws Não VARCHAR ( 50) Código de integração do Webservice de
entrada
timestamp Não BIGINT Último Timestamp consultado
exibe_observacao Não BIT Quando informado 1 irá retornar o
valor da observação, se não informado
ou informado 0, irá retornar NULL no
campo observação.
Método LinxProdutosCodBar (Retorna o cadastro de códigos de barras dos produtos):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_produto BIGINT Código do produto no Microvix
cod_barra VARCHAR (20) Código de Barras do produto
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxProdutosCodBar :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
id_setor Não INT Código do Setor do produto no
Microvix.
id_linha Não INT Código da Linha do produto no
Microvix.
id_marca Não INT Código da Marca do produto no
Microvix.
id_colecao Não INT Código da Coleção do produto no
Microvix.
cod_produto Não BIGINT Código do produto no Microvix.
limite Não BIGINT Limitar a quantidade de registros
retornados.
timestamp Não BIGINT Último Timestamp consultado
Método LinxProdutosCamposAdicionais (Retorna os campos adicionais preenchidos dos
Produtos cadastrados no portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_produto BIGINT Código do Produto no Microvix
campo VARCHAR (30) Nome do campo adicional.
valor VARCHAR (30) Valor do campo adicional
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
id_campo_valor INT Id do registro do valor do campo adicional
do produto
Página 44
Parâmetros de consulta do método LinxProdutosCamposAdicionais :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
data_mov_ini Sim DATE Data inicial de movimentação do
produto
data_mov_fim Sim DATE Data final de movimentação do produto
cod_produto Não BIGINT Código do produto
referencia Não VARCHAR (20) Referência do produto
timestamp Não BIGINT Último Timestamp consultado
Obs: As datas informadas na chamada do método, servirá como base para filtrar somente produtos
que tiveram movimentação no período, mas o saldo do produto retornado é sempre o atual.
Método LinxProdutosTabelas (Retorna o cadastro de Tabelas de Preços):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
id_tabela INT Código interno da tabela de preço
nome_tabela VARCHAR (50) Nome da tabela de preço
ativa CHAR (1) Indica se a tabela está ativa = “S” ou inativa
= “N”
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
tipo_tabela CHAR (1) Tipo de tabela:
I – Indice
L – Linha
P – Produto
M – Markup
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
Parâmetros de consulta do método LinxProdutosTabelas :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
id_tabela Não INT Id da tabela de preço
timestamp Não BIGINT Último Timestamp consultado
Método LinxProdutosTabelasPre cos (Retorna a relação dos produtos por tabela de preço):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
id_tabela INT Código interno da tabela de preço
cod_produto BIGINT Código do Produto no Microvix
Página 45
precovenda MONEY Valor do item na tabela
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxProdutosTabelas Precos :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_tabela Sim INT Id da tabela de preço
cod_produto Não BIGINT Código do produto
Método LinxConfiguracoesTributarias (Retorna o cadastro de configurações tributárias da
empresa):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da loja
id_config_tributaria INT Código da Configuração Tributária no Microvix
desc_config_tributaria VARCHAR (100) Descrição da Configuração Tributária
sigla_config_tributaria VARCHAR (50) Sigla da Configuração Tributária
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Ativa BIT Determina se a configuração tributária está
ativa
Uf VARCHAR (2) Campo chave que indica a qual Estado (UF) a
configuração tributária se refere. Esta opção
possibilitará que o ID seja sugerido ou atrelado
automaticamente a um produto na empresa
que possuir o mesmo estado que o ID em
questão. Opções: UFs do Brasil e o termo 'EX'
para representar o exterior.
sistema_tributacao CHAR (1) Campo chave que indica o sistema de
tributação ao qual a configuração tributária se
refere. Deverá ser preenchido com ‘R’ para
Lucro Real, ‘P’ para Lucro Presumido e ‘S’ para
Simples. Esta opção possibilitará que o ID seja
sugerido ou atrelado automaticame nte a um
produto na empresa que possuir o mesmo
sistema de tributação que o ID em questão.
tipo_atividade INT Campo chave que indica o tipo de atividade ao
qual configuração tributária se refere. 0
indicará a atividade Industrial ou Equiparada e
1 a atividade outros. Esta opção possibilitará
que o ID seja sugerido ou atrelado
automaticamente a um produto na empres a
que possuir o mesmo tipo de atividade que o
ID em questão.
id_origem_mercadoria INT Campo chave que indica a origem da
mercadoria ao qual a config se refere. Deve ser
enviado o ID que representa o código da
origem, podendo ser:
0 - Nacional, exceto as indicadas nos códigos
3, 4, 5 e 8
Página 46
1 - Estrangeira - Importação direta, exceto a
indicada no código 6
2 - Estrangeira - Adquirida no mercado
interno, exceto a indicada no código 7
3 - Nacional, mercadoria ou bem com
Conteúdo de Importação superior a 40%
(quarenta por cento) e inferior ou igual a 70%
(setenta por cento)
4 - Nacional, cuja produção tenha sido feita em
conformidade com os processos produtivos
básicos de que tratam o Decreto -Lei no
288/67, e as Leis nos 8.248/91, 8.387/91,
10.176/01 e 11.484/07
5 - Nacional, mercadoria ou bem com
Conteúdo de Importação inferior ou igual a
40% (quarenta por cento)
6 - Estrangeira - Importação direta, sem
similar nacional, constante em lista de
Resolução CAMEX e gás natural
7 - Estrangeira - Adquirida no mercado
interno, sem similar nacional, constante em
lista de Resolução CAMEX e gás natural
8 - Nacional, mercadoria ou bem com
Conteúdo de Importação superior a 70%
(setenta por cento)
Esta opção possibilitará que o ID seja sugerido
ou atrelado automaticamente a um produto
que possua a mesma origem que o ID em
questão.
utiliza_uso_consumo BIT Campo chave que indica que o ID representa
produtos de uso e consumo. Está opção
possibilitará que o ID seja sugerido ou atrelado
automaticamente aos produtos configurados
com o tipo de item 7 - Material de uso e
consumo.
id_classificacao_cest_produto INT Campo chave que indica a qual CEST (Código
Especificador da Substituição Tributária) o ID
representa. Só deve ser enviado se o ID
representar produtos sujeitos a substituição
tributária.
Esta opção possibilitará que o ID seja sugerido
ou atrelado automaticamente a um produto
que possua o mesmo CEST que o ID em
questão (além dos demais campos chaves).
Aqui deve ser enviado um ID previamente
cadastrado na tabela
classificacao_cest_produto (S uprimentos >
Estoque > Cadastros Auxiliares > NCM/CEST >
CEST).
codigo_ws VARCHAR (50) Esse campo exporta o código enviado na
integração via ws de entrada pelo método
LinxCadastraConfiguracoesTributarias.
Página 47
Parâmetros de consulta do método LinxConfiguracoesTributarias :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Não BIGINT Último Timestamp consultado
sigla_config_tributaria Não VARCHAR (50) Sigla da Configuração Tributária.
somente_ativa Não BIT 0 – Retorna todas as configurações
tributarias
1 – Retorna apenas as configurações
tributárias ativas
OBS: Quando não informado o
padrão é 1 .
filtrar_empresa Não BIT 0 - Retorna todas as configurações
tributárias sem considerar o CNPJ
informado no parâmetro cnpjEmp, e 1
- Retorna as configurações tributárias
disponíveis para a empresa conforme o
CNPJ informado no parâmetro
cnpjEmp. OBS: Quando não
informado o padrão é 1.
Método LinxConfiguracoesTributariasDetalhes (Retorna o detalhamento das configurações
tributárias da empresa)
Campos Tipo Descrição
portal INT Código do portal no
Microvix
cnpj_emp VARCHAR (14) CNPJ da loja
id_config_tributaria INT Código da Configuração
Tributária no Microvix
desc_classe_fiscal VARCHAR (150) Descrição da Classe Fiscal
cod_natureza_operacao CHAR (10) Código da Natureza de
Operação
desc_natureza_operacao VARCHAR (60) Descrição da Natureza de
Operação
cfop_fiscal VARCHAR (5) Código da CFOP Fiscal
desc_cfop_fiscal VARCHAR (300) Descrição da CFOP Fiscal
aliq_icms MONEY Alíquota do ICMS
valor_tributado_icms MONEY Valor Tributado de ICMS
aliq_pis MONEY Alíquota do PIS
aliq_cofins MONEY Alíquota do Cofins
perc_reducao_icms MONEY Percentual de redução de
ICMS
perc_reducao_icms_st MONEY Percentual de redução de
ICMS ST
margem_st MONEY Margem ST
aliquota_st MONEY Alíquota ST
margem_st_simulador MONEY Margem ST Simulador
aliquota_st_simulador MONEY Alíquota ST Simulador
desconto_icms MONEY Valor desconto ICMS
cst_icms_fiscal VARCHAR (4) CST Fiscal de ICMS
Página 48
desc_cst_icms_fiscal VARCHAR (150) Descrição da CST Fiscal
de ICMS
cst_ipi_fiscal VARCHAR (4) CST Fiscal de IPI
desc_cst_ipi_fiscal VARCHAR (150) Descrição da CST Fiscal
de IPI
cst_pis_fiscal VARCHAR (4) CST Fiscal de PIS
desc_cst_pis_fiscal VARCHAR (150) Descrição da CST Fiscal
de PIS
cst_cofins_fiscal
VARCHAR (4) CST Fiscal de Cofins
desc_cst_cofins_fiscal
VARCHAR (150) Descrição da CST Fiscal
de Cofins
desc_obs_padrao VARCHAR (250) Descrição Padrão
icms_credito BIT True = Sim, False = Não
ipi_credito
BIT True = Sim, False = Não
cod_enquadramento_ipi CHAR (3) Enquadramento IPI
desc_enquadramento_ipi VARCHAR (600) Descrição do
Enquadramento IPI
perc_aliquota_interna_uf_destinatario MONEY Percentual de alíquota
interna
perc_aliquota_interestadual_uf_envolvidas MONEY Percentual de alíquota
interestadual
csosn_fiscal VARCHAR (5) CSOSN Fiscal
desc_csosn_fiscal VARCHAR (200) Descrição da CSOSN
Fiscal
forma_tributacao_pis VARCHAR (10) True = ‘Valor’ e False ou
NULL = ‘Percentual’
forma_tributacao_cofins VARCHAR (10) True = ‘Valor’ e False ou
NULL = ‘Percentual’
id_ramo_atividade SMALLINT Código do ramo de
atividade
empresa INT Código da empresa no
portal Microvix
usa_base_icms_para_calculo_st BIT Determina se no cálculo
da base do ICMS de
substituição tributária
será utilizado o total de
produtos (0) ou a base
de ICMS (1).
id_classe_fiscal INT ID relacionado a Classe
Fiscal cadastrada em
CRM > Cadastros
Auxiliares > Classe Fiscal.
A Classe Fiscal que
representa o estado na
qual a config tributária
está associada.
id_cfop_fiscal SMALLINT ID que representa a
CFOP (Código Fiscal da
Operação Fiscal) da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela cfop_fiscal
Página 49
id_cst_icms_fiscal SMALLINT ID que representa a CST
(Código da Situação
Tributária) do ICMS da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela cst_icms_fiscal
id_cst_ipi_fiscal SMALLINT ID que representa a CST
(Código da Situação
Tributária) do IPI da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela cst_ipi_fiscal
id_cst_pis_fiscal
SMALLINT ID que representa a CST
(Código da Situação
Tributária) do PIS da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela cst_pis_fiscal
id_cst_cofins_fiscal
SMALLINT ID que representa a CST
(Código da Situação
Tributária) do COFINS da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela
cst_cofins_fiscal
id_obs INT Indica o código da
Observação Padrão que
deverá ser relacionada ao
detalhamento fiscal. O ID
deverá estar previamente
cadastrado em:
Faturamento > Cadastros
Auxiliares > Observações
Padrões (tabela
movimento_observacoes)
tributado BIT Indica se o ISS é
tributado (pago pelo
prestador do serviço)
retido BIT Indica se o ISS é retido
(pago pelo tomador do
serviço)
icms_base_naotributado SMALLINT Indica como deve ser
escriturado o valor da
nota caso não haja débito
ou crédito de ICMS,
sendo as opções:
2 - Operações sem
Crédito de Imposto -
Isentas ou não
Tributadas
3 - Operações sem
Crédito de Imposto -
Outras
ipi_base_naotributado SMALLINT Indica como deve ser
escriturado o valor da
Página 50
nota caso não haja débito
ou crédito de IPI, sendo
as opções:
2 - Operações sem
Crédito de Imposto -
Isentas ou não
Tributadas
3 - Operações sem
Crédito de Imposto -
Outras
id_csosn_fiscal SMALLINT ID que representa o
CSOSN (Código de
Situação da Operação no
Simples Nacional) da
operação a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela csosn_fiscal
somar_icms_st BIT Indica se o valor de ICMS
ST compõe o cálculo do
Custo Médio dos produtos
nas Entradas, sendo
somado ao custo de
aquisição do produto
id_sped_tipo_base_credito INT Indica o código da base
de cálculo do crédito
PIS/COFINS, no caso de
Entrada e Devolução de
Saída. Informação
necessária para o SPED
Contribuições. O ID deve
existir na tabela
sped_tipo_base_credito
aliq_pis_servico
MONEY Indica a
alíquota(percentual) de
PIS, utilizado no cálculo
do imposto PIS relativo a
serviço
aliq_cofins_servico MONEY Indica a
alíquota(percentual) de
COFINS, utilizado no
cálculo do imposto
COFINS relativo a serviço
id_cst_pis_fiscal_servico SMALLINT ID que representa o CST
(Código da Situação
Tributária) do PIS do
serviço a qual o
detalhamento fiscal se
refere. ID precisa existir
na tabela cst_pis_fiscal.
Necessário apenas para
detalhamento relativo a
serviço
id_cst_cofins_fiscal_servico SMALLINT ID que representa o CST
(Código da Situação
Tributária) do COFINS do
serviço a qual o
detalhamento fiscal se
refere. ID precisa existir
Página 51
na tabela cst_pis_fiscal.
Necessário apenas para
detalhamento relativo a
serviço
csrf BIT Indica se no caso
contratação de serviços
haverá retenção na fonte
de Pis, Cofins e CSLL
codigo_retencao_csrf VARCHAR (4) Indica o código relativo a
retenção na fonte de Pis,
Cofins e CSLL. Necessário
apenas para
detalhamento relativo a
serviço
aliq_pis_csrf MONEY Alíquota(percentual)
relativa a retenção na
fonte de Pis. Necessário
apenas para
detalhamento relativo a
serviço
aliq_cofins_csrf MONEY Alíquota(percentual)
relativa a retenção na
fonte de Cofins.
Necessário apenas para
detalhamento relativo a
serviço
aliq_csll_csrf MONEY Alíquota(percentual)
relativa a retenção na
fonte de CSLL.
Necessário apenas para
detalhamento relativo a
serviço
id_sped_tipo_base_credito_servico INT Indica o código da base
de cálculo do crédito
PIS/COFINS relativo a
serviços tomados.
Informação necessária
para o SPED
Contribuições. O ID deve
existir na tabela
sped_tipo_base_credito
receita BIT Indica se a operação
representa um Receita, a
fim de definir se a Nota
Fiscal deverá ser enviada
no SPED Contribuições
fci_informa_parcela_importada BIT Indica que ao emitir uma
NF-e na qual exista uma
FCI (Ficha de Conteúdo
de Importação)
cadastrada para o
produto o sistema irá
enviar o valor da parcela
importada na nota
fci_informa_numero BIT Indica que ao emitir uma
NF-e na qual exista uma
FCI (Ficha de Conteúdo
de Importação)
cadastrada para o
Página 52
produto o sistema irá
enviar o número dessa
FCI na nota
fci_informa_conteudo_importacao BIT Indica que ao emitir uma
NF-e na qual exista uma
FCI (Ficha de Conteúdo
de Importação)
cadastrada para o
produto o sistema irá
enviar o percentual do
conteúdo de importação
na nota
fci_informa_valor_importacao BIT Indica que ao emitir uma
NF-e na qual exista uma
FCI (Ficha de Conteúdo
de Importação)
cadastrada para o
produto o sistema irá
enviar o valor da parcela
importada do exterior na
nota
iss_tipo_tributacao SMALLINT Indica o tipo de ISS
(Imposto sobre Serviço)
que haverá na operação
que envolva serviço. As
opções são:
0 - Isento
1 - Não tributado
2 - Substituição
Tributária
3 - Tributado
4 - Retido
icms_st_antecipado_margem MONEY Indica a margem (MVA)
de ICMS ST Antecipado,
utilizado no cálculo do
ICMS Substituição
Tributária Antecipado nas
Entradas de Compra. O
ICMS ST Antecipado é o
ICMS ST pago pela
empresa em guia (não
vem destacado na nota
do fornecedor)
icms_st_antecipado_aliquota MONEY Indica a
alíquota(percentual) de
ICMS ST Antecipado
(alíquota interna do
destino), utilizado no
cálculo do ICMS
Substituição Tributária
Antecipado nas Entradas
de Compra. O ICMS ST
Antecipado é o ICMS ST
pago pela empresa em
guia (não vem destacado
na nota do fornecedor)
icms_st_antecipado_percentual_reducao MONEY Indica o percentual de
redução de base de
cálculo de ICMS ST
Página 53
Antecipado, utilizado no
cálculo do ICMS
Substituição Tributária
Antecipado nas Entradas
de Compra. O ICMS ST
Antecipado é o ICMS ST
pago pela empresa em
guia (não vem destacado
na nota do fornecedor)
icms_st_antecipado_valor_integra_custo_medio BIT Indica se o valor de ICMS
ST Antecipado compõe o
cálculo do Custo Médio do
produtos nas Entradas, ,
sendo somado ao custo
de aquisição do produto
id_enquadramento_ipi SMALLINT Indica o Código de
enquadramento legal do
IPI, utilizado para envio
na NF -e e SPED Fiscal.
Necessário apenas em
operações com IPI
usa_regime_estimativa_simplifica BIT Indica se deverá ser
utilizado o cálculo do
ICMS ST através do
Regime de Estimativa
Simplificado
aliq_carga_tributaria_media MONEY Indica o Percentual de
Carga Tributária Média
%' a ser utilizado quando
o parâmetro
usa_regime_estimativa_s
implificada está ativo
fcp_integra_custo_medio BIT Indica se o valor de FCP
compõe o cálculo do
Custo Médio dos produtos
nas Entradas, sendo
somado ao custo de
aquisição do produto
aliq_fcp MONEY Indica a
alíquota(percentual)
relativa ao FCP (Fundo de
Combate a Pobreza),
utilizado para calcular o
valor do imposto FCP
fcp_credito BIT Indica se o FCP será
debitado ou creditado na
escrituração fiscal.
fcp_reducao_icms BIT Indica que o percentual
de redução de base de
cálculo configurado para
o ICMS será utilizado
também para o cálculo do
FCP.
aliq_icms_efetivo MONEY Indica a
alíquota(percentual)
relativa ao ICMS Efetivo
da operação, utilizado
nos casos de operação
com CST 60 ou CSOSN
Página 54
500. Este percentual é
usado para calcular o
valor de ICMS que
existiria na operação se
ela não fosse tributada
por substituição
tributária.
perc_reducao_icms_efetivo MONEY Indica o percentual de
redução de base de
cálculo relativa ao ICMS
Efetivo da operação,
utilizado nos casos de
operação com CST 60 ou
CSOSN 500.
icms_fcp_st_antecipado_aliquota MONEY Indica a
alíquota(percentual)
relativa ao FCP (Fundo de
Combate a Pobreza)
referente ao ICMS ST
Antecipado
difal_base_dupla BIT Indica se no cálculo do
Diferencial de Alíquota
deverá ser utilizando a
base dupla (indicar a
fórmula através do
campo tipo_base_dupla)
Se este parâmetro estiver
falso será utilizada a
fórmula:(Valor da
Operação * (Alíquota
Interna – Alíquota
Interestadual))
aliq_desoneracao_icms MONEY Indica a alíquota de ICMS
relativa a desoneração do
imposto. Esta alíquota é
utilizada para calcular o
valor de ICMS que está
sendo beneficiado na
operação, seja com
isenção, redução, etc.
aliq_desoneracao_fcp MONEY Indica a alíquota de FCP
(Fundo de Combate a
Pobreza) relativa a
desoneração do imposto.
Esta alíquota é utilizada
para calcular o valor de
FCP que está sendo
beneficiado na operação,
seja com isenção,
redução etc.
cod_beneficio_fiscal VARCHAR (10) Indica o Código do
Benefício Fiscal da
operação que possui
desoneração de ICMS.
Necessário somente
quando a CST de ICMS
for terminada em: 20,
30, 40, 41, 50, 70 ou 90.
Página 55
id_motivo_desoneracao_icms SMALLINT Indica o ID do motivo da
desoneração do ICMS
quando a operação
possuir algum benefício
de isenção, redução de
base, etc. Necessário
somente quando a CST
de ICMS for terminada
em: 20, 30, 40, 41, 50,
70 ou 90. As opções são:
1 - Táxi
3 - Produtor agropecuár io
4 - Frotista/Locadora
5 - Diplomático/Consular
6 - Utilitários e
motocicletas da
Amazônia Ocidental e
áreas de livre comércio
7 - SUFRAMA
8 - Venda a órgão público
9 - Outros
10 - Deficiente condutor
11 - Deficiente não
condutor
12 - Órgão de fomento e
desenvolvimento
agropecuário
deduzir_icms_custo BIT Indica se o FCP será
debitado ou creditado na
escrituração fiscal.
deduzir_icms_desonerado BIT Indica se o sistema deve
deduzir o valor do ICMS
Desone rado do Total da
Nota Fiscal
somar_ipi_base_difal_fcp BIT Indica se o valor do IPI
deverá compor a base de
cálculo do Diferencial de
Alíquota de operações de
Entrada
tipo_base_dupla SMALLINT Indica que fórmula
deverá ser usada no
cálculo do Diferencial de
Alíquota, onde as opções
disponíveis são:
Para operação de
Entrada:
1: (((Valor da Operação –
ICMS origem) / (1 –
Alíquota Interna)) *
(Alíquota Interna –
Alíquota Interestadual))
2: ((((Valo r da Operação
- ICMS origem) / (1 -
Alíquota Interna)) x
Alíquota Interna) - (Valor
da Operação x Alíquota
Interestadual))
Para operação de Saída:
1: ((Valor da Operação /
Página 56
(1 – Alíquota Interna)) *
(Alíquota Interna –
Alíquota Interestadual))
utiliza_lucro_base_icms BIT Indica se a base de
cálculo do ICMS deverá
ser calculada com base
no lucro da operação.
Utilizada no caso de
revenda de produtos
usados e consignação.
utiliza_lucro_base_pis BIT Indica se a base de
cálculo do PIS deverá ser
calculada com base no
lucro da operação.
Utilizada no caso de
revenda de produtos
usados e consignação.
utiliza_lucro_base_cofins BIT Indica se a base de
cálculo do COFINS deverá
ser calculada com base
no lucro da operação.
Utilizada no caso de
revenda de produtos
usados e consignação.
codigo_ws VARCHAR (100) Esse campo exporta o
código enviado na
integração via ws de
entrada pelo método
LinxCadastraConfiguracoe
sTributariasDetalhes.
timestamp BIGINT Timestamp da tabela.
Exemplo: “185318313”
Alíquota_diferimento_icms MONEY Informa a aliquota de
diferimento do ICMS
aliquota_diferimento_fcp MONEY Informa a aliquota de
diferimento do Fundo de
Combate a Pobreza (FCP)
Parâmetros de consulta do método LinxConfiguracoesTributariasDetalhes :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
id_config_tributaria Sim INT ID da Configuração Tributária no
Microvix.
Timestamp Nâo BIGINT Maior timestamp retornado na última
consulta
filtrar_empresa Não BIT 0 - Retorna todas as configurações
tributárias sem considerar o CNPJ
informado no parâmetro cnpjEmp, e 1
- Retorna as configuraçoes tributárias
disponíveis para a empresa conforme o
CNPJ informado no parâmetro
cnpjEmp. OBS: Quando não
informado o padrão é 1.
Página 57
Método LinxF aturas (Retorna as faturas a receber ou a pagar de uma loja):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da loja
codigo_fatura BIGINT Código interno da fatura no Microvix
data_emissao SMALLDATETIME Data da emissão da fatura
cod_cliente INT Código do cliente da fatura
nome_cliente VARCHAR (60) Nome do cliente/fornecedor da fatura
data_vencimento SMALLDATETIME Data do vencimento da fatura
data_baixa SMALLDATETIME Data da baixa da fatura
valor_fatura MONEY Valor original da Fatura
valor_pago MONEY Valor do pagamento (baixa)
valor_desconto MONEY Valor do desconto concedido na fatura
valor_juros MONEY Valor de juros cobrado na fatura
documento INT Número do documento gerador da fatura
serie VARCHAR (10) Série do documento gerados da fatura
ecf INT Número da ECF geradora da fatura
observacao TEXT Observação da fatura
qtde_parcelas INT Quantidade total de parcelas da fatura
ordem_parcela INT Ordem da Parcela
receber_pagar CHAR (1) Identifica se a fatura é a receber ou a
pagar
vendedor INT Código do vendedor relacionado na fatura
excluido CHAR (1) Identifica se a fatura está excluída
cancelado CHAR (1) Identifica se a fatura está cancelada
identificador UNIQUEIDENTIFIER Código para identificar e referenciar as
informações do documento fiscal.
NSU VARCHAR ( 50) Número NSU fatura com TEF.
cod_autorizacao VARCHAR ( 50) Código da autorização da fatura com TEF.
documento_sem_tef VARCHAR (350) Número Documento informado
manualmente para vendas sem TEF.
autorizacao_sem_tef VARCHAR (30) Código da autorização informada
manualmente para vendas sem TEF.
plano INT Código interno do plano de pagamento no
Microvix
conta_credito BIGINT Código da conta Credito do Lançamento
contábil
conta_debito BIGINT Código da conta Débito do Lançamento
contábil
conta_fluxo BIGINT Código da conta Fluxo do Lançamento
contábil
cod_historico BIGINT Código do Histórico no Microvix
forma_pgto VARCHAR (50) Nome da Forma de Pagamento.
ordem_cartao TINYINT Ordem do cartão. Ex: 1,2,3, etc. Somente
para planos da forma Cartão
banco_codigo VARCHAR (10) Código do Banco para faturas de Cheque.
banco_agencia VARCHAR (30) Código da Agencia para faturas de
Cheque.
Página 58
banco_conta VARCHAR (30) Código da Conta para faturas de Cheque.
banco_autorizacao_garantidora VARCHAR (30) Código da Garantidora para faturas de
Cheque.
numero_bilhete_seguro VARCHAR (30) Utilizado somente com modulo de Venda
de Serviços Terceiros
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
empresa INT Id da empresa no portal
id_categorias_financeiras INT Id da categoria financeira
taxa_financeira MONEY Taxa financeira
valor_abatimento FLOAT Valor abatimento
valor_multa MONEY Valor multa
centrocusto INT ID centro de custo
perc_taxa_adquirente FLOAT Percentual de taxa da adquirente de
cartão
fatura_origem_importacao_erp VARCHAR(50) Número original da fatura importada para
o ERP.
cod_portador INT Define o codigo de portador da fatura
nsu_host VARCHAR (50) NSU Host
nsu_sitef VARCHAR (50) NSU Sitef
Parâmetros de consulta do método LinxF aturas :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Não BIGINT Último Timestamp consultado
data_inicial Não SMALLDATETIME Data Inicial (emissão) de pesquisa das
faturas.
data_fim Não SMALLDATETIME Data Fim (emissão) de pesquisa das
faturas.
data_inicial_pag Não SMALLDATETIME Data Inicial (pagamento) de pesquisa
das faturas.
data_fim_pag Não SMALLDATETIME Data Fim (pagamento) de pesquisa das
faturas.
identificador Não UNIQUEIDENTIFIER Identificador da venda localizado no
método LinxMovimento.
empresa Não INT Id da empresa no portal
filtra_somente_timestamp Não BIT Quando informado o valor 1, ignora
todos os demais filtros, mesmo
obrigatórios e filtra apenas por
timestamp com retorno paginado.
Ignora até o CNPJ, retornando dados
de todas as empresas do portal.
Neste caso, é imprescindível informar o
parâmetro timestamp em conjunto,
caso contrário, não retornará registros.
Obs: Só poderá ser fornecido um período de listagem (Emissão ou Pagamento), o outro deverá
ficar como NULL. Mas deverá pelo menos ter um Período informado.
Página 59
Método LinxLancContabil (Retorna informações dos Lançamentos Contábeis por conta e
empresa):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_lanc BIGINT Código do lançamento contábil no Microvix
centro_custo VARCHAR (50) Descrição do Centro de Custo
ind_conta VARCHAR (150) Índice da Conta
cod_conta BIGINT Código da conta
nome_conta VARCHAR (50) Nome da Conta
valor_conta MONEY Valor
cred_deb CHAR (1) Informa se é um lançamento de Crédito “C”
ou Débito “D”
data_lanc SMALLDATETIME Data do Lançamento
compl_conta VARCHAR (500) Descrição do complemento
identificador UNIQUEIDENTIFIER Código para identificar e referenciar as
informações do documento fiscal.
cod_historico BIGINT Código do Histórico no Microvix
desc_historico VARCHAR (50) Descrição do Histórico
data_compensacao SMALLDATETIME Data da compensação
fatura_origem INT Código interno da fatura de origem no
Microvix
efetivado CHAR (1) Define se o Lançamento foi Efetivado. S ou N
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
empresa INT Id da empresa no portal
id_lanc BIGINT ID da tabela contab_lancamentos no Microvix
cancelado CHAR(1) Indica se o registro do lançamento contábil
está cancelado. (S = Sim e N = Não)
Parâmetros de consulta do método LinxLancContabil :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a
ser consultado
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
timestamp Não BIGINT Último Timestamp consultado
data_lanc_ini Sim SMALLDATETIME Data inicial para pesquisa dos
lançamentos contábeis.
data_lanc_fim Sim SMALLDATETIME Data Fim para pesquisa dos
lançamentos contábeis.
cod_cc Sim INT Código do Centro de Custo no Microvix.
cod_conta Sim INT Código da conta no Microvix.
identificador Não UNIQUEIDENTIFIER Identificador da venda localizado no
método LinxMovimento.
fatura_origem Não INT Código interno da fatura de origem no
Microvix.
empresa Não INT Id da empresa no portal
Página 60
exibir_cancelados Não BIT Exibe ou não os registros de
lançamentos contábeis cancelados. (0
= Não e 1 = Sim)
filtra_somente_timestamp Não BIT Quando informado o valor 1, ignora
todos os demais filtros, mesmo
obrigatórios e filtra apenas por
timestamp com retorno paginado.
Ignora até o CNPJ, retornando dados
de todas as empresas do portal.
Neste caso, é imprescindível informar o
parâmetro timestamp em conjunto,
caso contrário, não retornará registros.
Método LinxPedidosVenda (Retorna informações de pedidos de venda de acordo com a loja
pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_pedido INT Código do pedido
data_lancamento SMALLDATETIME Data do pedido
hora_lancamento CHAR (5) Hora Lançamento
transacao INT Código interno do Microvix
usuario INT Usuário que realizou o pedido.
codigo_cliente INT Código do cliente
cod_produto BIGINT Código do Produto
quantidade FLOAT Quantidade do Produto
valor_unitario MONEY Valor unitário do Produto
cod_vendedor INT Código do Vendedor no Microvix
valor_frete MONEY Valor do frete
valor_total MONEY Valor total do pedido
desconto_item MONEY Desconto do Item
cod_plano_pagamento INT Código do plano de pagamento
plano_pagamento VARCHAR ( 100) Nome Plano de Pagamento
obs VARCHAR (MAX) Observação do pedido
aprovado CHAR (1) S = Sim já é um pedido e N = Não ainda
está como orçamento.
cancelado CHAR (1) S = Sim e N = Não
data_aprovacao SMALLDATETIME Data da Aprovação
data_alteracao SMALLDATETIME Data da Alteração
tipo_frete SMALLINT 1 = CIF e 2 = FOB
natureza_operacao VARCHAR (60) Exibe a descrição da Natureza da Operação.
tabela_preco INT Código Tabela de Preço
nome_tabela_preco VARCHAR (50) Descrição Tabela Preço
previsao_entrega SMALLDATETIME Data de previsão de entrega
realizado_por INT Código do cliente realizado por.
pontuacao_ser INT Código do cliente Pontuação Ser.
venda_externa CHAR (1) S = Sim e N = Não
Página 61
nf_gerada VARCHAR (MAX) Número das Notas Fiscais geradas no
faturamento do pedido separadas por
vírgula.
status CHAR (1) F = Faturado Completo
P = Faturado Parcial
N = Não Faturado
numero_projeto_officina VARCHAR (50) Código do Projeto
cod_natureza_operacao CHAR (10) Código da Natureza de Operação
margem_contribuicao MONEY Margem de Contribuição da Loja
doc_origem INT Documento de origem
posicao_item INT Posição do item dentro do pedido de venda
orcamento_origem INT Número de onde surgiu esse orçamento.
Caso não tenha origem será 0.
transacao_origem INT Quando um pedido de venda é aprovado
parcialmente ele gera uma nova transação,
porém mantem no campo antecipaç_origem
a transação original.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetro Opcional.
desconto MONEY total do desconto do pedido de venda
transacao_ws INT Transação enviada na integração Ws
empresa INT Id da empresa no portal
transportador BIGINT Id do cadastro da transportadora no portal
deposito INT Id do depósito no portal
texto_agrupa mento VARCHAR (60) Nome do grupamento
posicao SMALLINT Código da posição do orçamento
Parâmetros de consulta do método LinxPedidosVenda :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
timestamp Não BIGINT Último Timestamp consultado
data_inicial Sim SMALLDATETIME Data Lançamento Inicial de pesquisa
dos pedidos.
data_fim Sim SMALLDATETIME Data Fim para pesquisa dos
lançamentos contábeis.
hora_inicial Não CHAR (5) Hora de lançamento inicial de
pesquisa da movimentação.
hora_fim Não CHAR (5) Hora de lançamento fim de pesquisa
da movimentação.
data_alt_inicial Não SMALLDATETIME Data Alteração Inicial de pesquisa dos
pedidos.
data_alt_fim Não SMALLDATETIME Data Alteração Fim de pesquisa dos
pedidos.
doc_cliente Não VARCHAR (14) CPF ou CNPJ do cliente ou fornecedor.
transacao Não INT Número da transação do pedido.
aprovado Não CHAR (1) Retornará somente pedidos
aprovados. Onde S=sim e N=não.
cancelado Não CHAR (1) Retornará somente os pedidos
cancelados. Onde S=sim e N=não.
Página 62
empresa Não INT Id da empresa no portal
doc_origem Não INT Documento origem do
orçamento/pedido de venda
Método LinxPlanos PedidoVenda (Retorna os Planos de Pagamentos realizados nos pedidos de
vendas ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_pedido INT Código do pedido
plano INT Código interno do plano de pagamento no
Microvix
desc_plano VARCHAR ( 100) Descrição do plano de pagamento
total MONEY Total pago no plano
qtde_parcelas INT Quantidade de parcelas
indice_plano MONEY Índice do plano de pagamento definido na
movimentação
valor_desc_acresc_plano MONEY Valor do desconto ou acréscimo no plano.
cod_forma_pgto INT Código da forma de pagamento
forma_pgto VARCHAR (50) Nome da forma de pagamento
Parâmetros de consulta do método LinxPlanosPedidoVenda :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
cod_pedido Sim INT Código do pedido de venda.
data_inicial Sim SMALLDATETIME Data Lançamento Inicial para
pesquisa do pedido de venda.
data_fim Sim SMALLDATETIME Data Fim para pesquisa do pedido de
venda.
hora_inicial Não CHAR (5) Hora de lançamento inicial de
pesquisa do pedido venda.
hora_fim Não CHAR (5) Hora de lançamento fim de pesquisa
do pedido venda.
dt_update_inicial Não SMALLDATETIME Data Inicial de alteração do registro.
dt_update_fim Não SMALLDATETIME Data Fim de alteração do registro.
Método LinxPedidos Compra (Retorna informações de pedidos de compra de acordo com a loja
pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_pedido INT Código do pedido
data_pedido SMALLDATETIM
E Data do pedido
Página 63
transacao INT Código interno do Microvix
usuario INT Usuário que realizou o pedido.
codigo_fornecedor INT Código do Fornecedor
cod_produto BIGINT Código do Produto
quantidade FLOAT Quantidade do Produto
valor_unitario MONEY Valor unitário do Produto
cod_comprador INT Código do Comprador no Microvix
valor_frete MONEY Valor do frete
valor_total MONEY Valor total do pedido
cod_plano_pagamento INT Código do plano de pagamento
plano_pagamento VARCHAR ( 100) Nome Plano de Pagamento
obs VARCHAR (MAX) Observação do pedido
aprovado CHAR (1) S = Sim e N = Não
cancelado CHAR (1) S = Sim e N = Não
encerrado CHAR (1) S = Sim e N = Não
data_aprovacao DATETIME Data da Aprovação
numero_ped_fornec VARCHAR (15) Número do pedido do Fornecedor, quando
informado.
tipo_frete CHAR (1) Código do Frete
natureza_operacao VARCHAR (73) Exibe a descrição da Natureza da Operação.
previsao_entrega SMALLDATETIM
E Data de previsão de entrega
numero_projeto_officina VARCHAR (50) Código do Projeto
status_pedido CHAR (1) “E” = Entregues ou “P” = Pendente
qtde_entregue FLOAT Quantidade de itens já entregue
descricao_frete VARCHAR (40) Descrição do Frete
integrado_linx BIT 1 = Integrado pelo Linx, 0 = Não integrado
nf_gerada INT Número da Nota Fiscal gerada no faturamento
do pedido. Somente ira mostrar a primeira NF.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
empresa INT Id da empresa no portal
nf_origem_ws VARCHAR(30) Número da nota fiscal integrada pelo método
LinxCadastraNotas
id_compras_pedido_status INT Id do status do pedido de compra
Parâmetros de consulta do método LinxPedidosCompra :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Não BIGINT Último Timestamp consultado
data_inicial Sim SMALLDATETIME Data Inicial de pesquisa dos pedidos.
data_fim Sim SMALLDATETIME Data Fim de pesquisa dos pedidos.
status_pedido Não CHAR (1) “E” = Entregues ou “P” = Pendente
integrado_linx Não BIT “1” = Integrado Linx ou “0” = Não integrados
pelo Linx.
Página 64
empresa Não INT Id da empresa no portal
Método LinxReducoesZ (Retorna as ReduçõesZ de acordo com a loja pesquisada , somente para
clientes que ainda utilizam a impressora fiscal ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
empresa INT Código da empresa no Microvix
cnpj VARCHAR (14) CNPJ da empresa
data_fechamento SMALLDATETIME Data fechamento da redução
numero_ecf SMALLINT Numero do ECF
numeroserie VARCHAR (30) Numero de serie do ECF
numero_reducoes INT Numero de reduções
cupom_inicial INT Cupom inicial
cupom_final INT Cupom Final
gt_inicial MONEY GT Inicial
gt_final MONEY GT Final
qtde_cupons INT Quantidade de Cupons
venda_bruta MONEY Venda Bruta
descontos MONEY Descontos
acrescimos MONEY Acrescimos
cancelamentos MONEY Cancelamento
cro SMALLINT CRO
usuario INT Código do usuário do fechamento
aliquota VARCHAR (4) Aliquota (%)
valor MONEY Valor
data_mov SMALLDATETIME Data do Movimento
Parâmetros de consulta do método LinxReducoesZ :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
cnpjPortal Sim CHAR (1) (S) = Retorna registros de todos
CNPJs do Portal (utiliza como base o
cnpj informado no campo cnpjEmp
para pesquisar o portal).
(N) = Retorna registros somente do
CNPJ pesquisado no campo cnpjEmp.
Opção padrão.
data_inicial Sim DATE Data de lançamento inicial de
pesquisa da Redução Z.
data_fim Sim DATE Data de lançamento final de pesquisa
da Redução Z.
Obs: Só retorna informações do cadastro de reduções Z feito pelas impressoras fiscais.
Página 65
Método LinxServicos (Retorna o cadastro de serviços de acordo com a loja pesquisada ou dados
da estrutura mercadológica):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cod_servico BIGINT Código do serviço no Microvix
nome VARCHAR (250) Nome do serviço
id_setor INT Código do Setor do serviço no Microvix
desc_setor VARCHAR (30) Descrição do Setor do serviço no Microvix
id_linha INT Código da Linha do serviço no Microvix
desc_linha VARCHAR (30) Descrição da Linha do serviço no Microvix
id_marca INT Código da Marca do serviço no Microvix
desc_marca VARCHAR (30) Descrição da Marca do serviço no Microvix
dt_update SMALLDATETIME Data de alteração do serviço
operacao_servico CHAR (1) Indica se o serviço é uma operação de
Entrada, Saída ou Ambos
servico_km CHAR (1) Indica se o serviço aponta KM’s rodados
desativado CHAR (1) Indica se o serviço está desativado ou não.
cod_lc11603 VARCHAR (4) Código informado referente a Lei
Complementar nº116/2003
codigo_nbs VARCHAR (20) Código NBS (Nomenclatura Brasileira de
Serviços)
dt_inclusao SMALLDATETIME Data de inclusão do serviço
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_ws VARCHAR (50) Esse campo exporta o código enviado na
integração via ws de entrada pelo método
LinxCadastraServicos
Parâmetros de consulta do método LinxServicos :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Não BIGINT Último Timestamp consultado
dt_update_inicio Sim SMALLDATETIME Data inicial de alteração do serviço.
dt_update_fim Sim SMALLDATETIME Data final de alteração do serviço.
id_linha Sim INT Código da Linha do serviço no
Microvix.
id_marca Sim INT Código da Marca do serviço no
Microvix.
id_setor Sim INT Código do Setor do serviço no
Microvix
cod_servico Não BIGINT Poderá ser informado o código do
serviço para pesquisa.
Página 66
Método LinxServicosDetalhes (Retorna informações dos serviços de acordo com a loja
pesquisada):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
cod_servico BIGINT Código do serviço no Microvix
preco_custo_hn MONEY Preço de custo Hora Normal
preco_primera_hn MONEY Preço de venda do serviço na tabela padrão
da hora normal
preco_demais_hn MONEY Preço de venda do serviço na tabela padrão
da hora normal
preco_custo_he MONEY Preço de custo Hora Extra
preco_primera_he MONEY Preço de venda do serviço na tabela padrão
da hora extra
preco_demais_he MONEY Preço de venda do serviço na tabela padrão
da hora extra
preco_custo_had MONEY Preço de custo Hora Adicional Noturno
preco_primera_had MONEY Preço de venda do serviço na tabela padrão
da Hora Adicional Noturno
preco_demais_had MONEY Preço de venda do serviço na tabela padrão
da Hora Adicional Noturno
id_config_tributaria INT Código da Configuração Tributária atrelada
ao serviço
desc_config_tributaria VARCHAR (100) Descrição da Configuração Tributária
atrelada ao serviço
cod_trib_servico_municipio VARCHAR (20) Código de Tributação no Município
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxServicosDetalhes :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Não BIGINT Último Timestamp consultado
cod_servico Não BIGINT Poderá ser informado o código do
serviço para pesquisa. Quando
pesquisado pelo código de serviço
retornará mesmo com saldo zero.
Método LinxClientesFornecContatosParentesco (Retorna os graus de parentesco cadastrado
no portal):
Campos Tipo Descrição
id_parentesco TINYINT Código interno parentesco
descricao_parentesco VARCHAR (50) Descrição do parentesco
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 67
Parâmetros de consulta do método LinxClientesFornecContatosParentesco :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Não BIGINT Último Timestamp consultado
descricao_parentesco Não VARCHAR (50) Descrição do parentesco
id_parentesco Não INT Código interno parentesco
Método LinxAntecipacoesFinanceiras (Retorna informações das antecipações financeiras do
portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
empresa INT Código do serviço no Microvix
cod_cliente INT Código do cliente vinculado a
antecipação
numero_antecipacao INT Código referente a Antecipação
data_antecipacao SMALLDATETIME Data realizada a Antecipação
previsao_entrega SMALLDATETIME Previsão de entrega da pré-
venda/DAV
dav_pv VARCHAR (3) PV (Pré -venda) ouDAV
numero_origem INT Número da DAV original
dav_remessa INT Número da DAV de remessa
codigoproduto BIGINT Código de produto no Microvix
quantidade MONEY Quantidade do produto informada
na DAV ou venda
preco_unitario_produto MONEY Preço da unidade informado na
DAV ou venda
valor_pago_antecipacao MONEY Valor pago no ato da antecipação
entregue CHAR (1) Informa se foi finalizada a
antecipação e gerado o documento
fiscal. Ex.: “S” ou “N”
identificador UNIQUEIDENTIFIER Código para identificar e agrupar as
informações do documento fiscal.
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
cancelado BIT Retorna se a antecipação estará
cancelada ou não.
id_antecipacoes_financeiras INT ID da antecipação financeira
id_antecipacoes_financeiras_detalhes INT Id do detalhamento da
antecipação financeira
id_vendas_pos_produtos INT Id vendas produtos
valor_pagar MONEY Valor a pagar
identificador_faturamento_antecipado UNIQUEIDENTIFIER Identificador do faturamento
antecipado
Página 68
Parâmetros de consulta do método LinxAntecipacoesFinanceiras :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da
loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
data_lanc_ini Não SMALLDATETIME Data inicial de alteração do serviço.
data_lanc_fim Não SMALLDATETIME Data fim de alteração do serviço.
numero_antecipacao Não INT Poderá ser informado o número da
Antecipação financeira.
identificador Não UNIQUEIDENTIFIER Identificador de movimentação no
Microvix, podendo ser utilizado para
listar as antecipações financeiras de
uma venda.
antecipacao_finalizada Não BIT Para retornar somente as
antecipações financeiras não
finalizadas informe 0. Para retornar
as antecipações finalizadas informe
1.
exibir_cancelados Não BIT Para retornar registros cancelados
informe 1 e para retornar registros
não cancelados informe 0
Método LinxXMLDocumentos (Retorna o XML dos documentos emitidos pela loja):
Campos Tipo Descrição
Portal INT Id do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da Loja
documento INT Número do Documento
Serie VARCHAR (10) Série do documento
data_emissao SMALLDATETIME Data de emissão do documento
chave_nfe VARCHAR (44) Chave de até 44 dígitos da Nota/cupom
situacao TINYINT ID de situação da nota ou cupom:
1 - Autorizada
2 - Cancelada
3 - Denegada
4 - Inutilizada
5 - Pendente de Autorização
6 - Pendente de Envio
7 - Pendente de Geração
8 - Excluída
9 - Rejeitada
10 - Enviado
11 - Rejeitada após Contingência
12 - Inutilização Agendada
13 - Inutilização Rejeitada
14 - Aguardando SEFAZ
15 - Cancelamento Agendado
16 - Cancelamento Rejeitado
Xml VARCHAR (MAX) XML do documento
excluido BIT Indica se o documento foi excluído ou não
Página 69
identificador_microvix UNIQUEIDENTIFIER Identificador único no Microvix para
vínculo com as movimentações
dt_insert SMALLDATETIME Data de Inserção
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
nProtCanc VARCHAR (15) Número Protocolo Cancelamento
nProtInut VARCHAR (15) Número Protocolo Inutilização
xmlDistribuicao VARCHAR (MAX) XML de Distribuição do Documento
nProtDeneg VARCHAR (15) Número Protocolo Denegado
CStat VARCHAR (5) Situação da nota no SEFAZ
id_nfe INT ID da Nfe no Microvix
justificativa VARCHAR(255) Justificativa da NFe
cod_cliente INT Código do cliente
Parâmetros de consulta do método LinxXMLDocumentos :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
timestamp Sim BIGINT Último Timestamp consultado
data_inicial Não DATE Data inicial do período a ser
pesquisado
data_fim Não DATE Data fim do período a ser
pesquisado
chave_nfe Não VARCHAR (44) Chave da Nota / Cupom
documento Não INT Número de Documento no Microvix
identificador Não UNIQUEIDENTIFIER Identificador de movimento no
Microvix
serie Não VARCHAR (10) Serie do documento
Método LinxProdutosOpticosTipoAro (Retorna os tipos de aros):
Campos Tipo Descrição
id_tipo_aro INT Id da tabela
tipo_aro VARCHAR (100) Descrição do tipo aro
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxProdutosOpticosTipoAro :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_tipo_aro Não INT Id tipo aro.
Página 70
Método LinxProdutosOpticosFormatoAro (Retorna os formatos de aros):
Campos Tipo Descrição
id_formato_aro INT Id da tabela
codigo VARCHAR (16) Código do formato do aro
descricao VARCHAR (60) Descrição do formato do aro
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxProdutosOpticosFormatoAro :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_formato_aro Não INT Id formato aro.
Método LinxDadosOpticosDav (Retorna os dados ópticos dos produtos da DAV):
Campos Tipo Descrição
id_vendas_pos_produtos BIGINT Id da tabela
cod_produto BIGINT Código do produto
dav INT Número da DAV
tipo_lente VARCHAR (20) Tipo de lente: Monofocal,
Bifocal, Multifocal ou Nenhum
od_oe CHAR (2) Lado:
OD – Olho Direito
OE – Olho Esquerdo
A – Ambos
lng_esferico_od MONEY Longe Esférico Olho Direito
lng_cilindrico_od MONEY Longe Cilíndrico Olho Direito
lng_eixo_od MONEY Longe Eixo Olho Direito
lng_esferico_oe MONEY Longe Esférico Olho Esquerdo
lng_cilindrico_oe MONEY Longe Cilíndrico Olho
Esquerdo
lng_eixo_oe MONEY Longe Eixo Olho Esquerdo
prt_esferico_od MONEY Perto Esférico Olho Direito
prt_cilindrico_od MONEY Perto Cilíndrico Olho Direito
prt_eixo_od MONEY Perto Eixo Olho Direito
prt_esferico_oe MONEY Perto Esférico Olho Esquerdo
prt_cilindrico_oe MONEY Perto Cilíndrico Olho
Esquerdo
prt_eixo_oe MONEY Perto Eixo Olho Esquerdo
cmpl_add_od MONEY Complementos Adição Olho
Direito
base_od MONEY Complementos Base Olho
Direito
Página 71
diametro_od MONEY Complementos Diâmetro
Olho Direito
cmpl_add_oe MONEY Complementos Adição Olho
Esquerdo
base_oe MONEY Complementos Base Olho
Esquerdo
diametro_oe MONEY Complementos Diâmetro
Olho Esquerdo
ponte MONEY Ponte
altura MONEY Altura
aro MONEY Aro
diag_maior MONEY Diagonal Maior
dist_haste MONEY Distância entre Hastes
dist_front MONEY Distância Frontal
tipo_armacao CHAR (1) Tipo Armação:
M – Metal
F – Fio de Nylon
P – Parafuso
A – Acetato
S – Segurança
curvatura MONEY Curvatura
id_produtos_opticos_tipo_aro INT Id exportado no método
LinxProdutosOpticosTipoAro
id_produtos_opticos_formato_aro INT Id exportado no método
LinxProdutosOpticosFormato
Aro
lng_dpdpn_od MONEY Longe DNP Olho Direito
prt_dpdpn_od MONEY Perto DNP Olho Direito
lng_dpdpn_oe MONEY Longe DNP Olho Esquerdo
prt_dpdpn_oe MONEY Perto DNP Olho Esquerdo
lng_altura_od MONEY Longe Altura Olho Direito
prt_altura_od MONEY Perto Altura Olho Direito
lng_altura_oe MONEY Longe Altura Olho Esquerdo
prt_altura_oe MONEY Perto Altura Olho Esquerdo
calibre MONEY Calibre
dp_montagem MONEY DP
observacao VARCHAR (MAX) Observação
paciente VARCHAR (100) Paciente
endereco_paciente VARCHAR (100) Endereço do paciente
medico_especialista VARCHAR (100) Médico/Especialista
endereco_medico_especialista VARCHAR (100) Endereço Médico/Especialista
refracionista_optico VARCHAR (100) Refracionista Óptico
data_receita SMALLDATETIME Data da receita
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
id_ordservprod INT ID da ordem serviço de
produção
id_vendas_pos_produtos_tmp INT ID do item da venda
id_vendas_pos BIGINT ID da venda
Página 72
cancelado BIT Cancelado (1 - Sim ou 0 -
Não)
previsao_entrega SMALLDATETIME Data de previsão da entrega
numero_ficha BIGINT Número da ficha
id_vendas_pos_produtos_campos_adicionais_t
mp INT ID do campo adicional do
item da venda
id_link_pagamento_linx_pay_hub INT ID link pagamento linx pay
hub
codigo_gerencial VARCHAR (20) Código gerencial
empresa INT Número da empresa no
portal
origem TINYINT Origem
acoes_promocionais_desconto MONEY Desconto de ação
promocional
desconto MONEY Desconto
acrescimo MONEY Acréscimo
frete MONEY Frete
descontos_impostos MONEY Desconto impostos
acrescimos_impostos MONEY Acréscimos impostos
preco_unitario MONEY Valor unitário
quantidade MONEY Quantidade
desconto_item MONEY Desconto no item
acrescimo_item_valor MONEY Valor de acrescimo no item
desconto_item_valor MONEY Valor de desconto no item
portal INT Id do código do portal no
Microvix
Parâmetros de consulta do método LinxDadosOpticosDav :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da
loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
dav Não INT Número da Dav
id_vendas_pos_produtos Não BIGINT Id vendas produtos
Método LinxAntecipacoesFinanceirasPlanos (Retorna os dados da tabela
antecipações _financeiras e antecipações _financeiras_planos no portal):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
empresa INT Id da empresa no portal
cnpj_emp VARCHAR (14) CNPJ da loja
id_antecipacoes_financeiras INT Id do registro na tabela antecipações_financeiras
numero_antecipacao INT Número da antecipação financeira
forma_pgto VARCHAR (50) Nome da forma de pagamento
Página 73
plano INT Id do plano
nome_plano VARCHAR ( 100) Nome do plano
valor MONEY Valor da antecipação
cancelado BIT Cancelado
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxAntecipacoesFinanceirasPlanos
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ
da loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_antecipacoes_financeiras Não INT Id do registro na tabela
antecipações_financeiras
numero_antecipacao Não INT Número da antecipação
financeira
Método LinxSubClasses (Retorna as subclasses de CRM):
Campos Tipo Descrição
id_subclasses SMALLINT ID da subclasse no Microvix
classe SMALLINT ID da classe no Microvix
descricao VARCHAR (50) Descrição da subclasse
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxSubClasses:
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
descricao Não VARCHAR (50) Descrição da subclasse
Método LinxDevolucaoRemanejoFabricaTipo (Retorna informações de tipos de devoluções de
romanejo):
Campos Tipo Descrição
id_devolucao_remanejo_fabrica_tipo TINYINT Id da devolução remanejo fabrica
tipo
descricao VARCHAR (100) Descrição da devolução remanejo
fabrica tipo
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no Microvix
portal INT Id do código do portal no Microvix
Página 74
Parâmetros de c onsulta do método LinxDevolucaoRemanejoFabricaTipo
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao
Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado
o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp
consultado
id_devolucao_remanejo_fabrica_tipo Não BIT Id da devolução
remanejo fabrica tipo
Método LinxDevolucaoRemanejoFabricaStatus (Retorna informações de status de devoluções
de romanejo):
Campos Tipo Descrição
id_devolucao_remanejo_fabrica_status TINYINT Id da devolução remanejo fabrica
status
id_devolucao_remanejo_fabrica_tipo TINYINT Id da devolução remanejo fabrica
tipo
descricao VARCHAR (100) Descrição da devolução remanejo
fabrica status
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT
Id do código do portal no Microvix
Parâmetros de c onsulta do método LinxDevolucaoRemanejoFabricaStatus
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao
Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser
informado o CNPJ da
loja a ser consultado
timestamp Sim BIGINT Último Timestamp
consultado
id_devolucao_remanejo_fabrica_status Não BIT Id da devolução
remanejo fabrica
status
Método LinxDevolucaoRemanejoFabrica (Retorna as devoluções de remanejo ):
Campos Tipo Descrição
id_devolucao_remanejo_fabrica INT ID da devolucao remanejo fabrica
id_devolucao_remanejo_fabrica_tipo TINYINT ID da devolução remanejo fabrica
tipo
id_motivo_devolucao_fabrica SMALLINT ID do motivo devolução fabrica
id_deposito INT ID do deposito
id_devolucao_remanejo_fabrica_status TINYINT ID da devolução remanejo fabrica
status
empresa INT Empresa
Página 75
fornecedor INT Código do fornecedor
cfop CHAR (10) cfop
serie VARCHAR (10) Serie
codigo_solicitacao VARCHAR (50) Código solicitação
portal INT Portal
data_solicitacao DATE Data solicitação
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
Parâmetros de c onsulta do método LinxDevolucaoRemanejoFabrica
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao
Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o
CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp
consultado
data_solicitacao Não SMALLDATETIME Data da solicitação
fornecedor Não INT Código do fornecedor
id_devolucao_remanejo_fabrica Não INT ID da devolucao remanejo
fabrica tipo
Método LinxDevolucaoRemanejoFabricaItem (Retorna os itens de devoluções de romanejo):
Campos Tipo Descrição
id_devolucao_remanejo_fabrica_item INT ID da devolução remanejo fábrica
item
id_devolucao_remanejo_fabrica INT ID da devolução remanejo fábrica
codigoproduto BIGINT Código do produto
codigo_produto_franqueadora VARCHAR (50) Código do produto na franqueadora
quantidade INT Quantidade
codebar VARCHAR (20) Código de barras
serial VARCHAR (50) Serial
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no Microvix
Parâmetros de Consulta do método LinxDevolucaoRemanejoFabricaItem
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso
ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser
informado o CNPJ
da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp
consultado
id_devolucao_remanejo_fabrica Não INT ID da devolução
remanejo fábrica
Página 76
id_devolucao_remanejo_fabrica_item Não INT ID da devolução
remanejo fábrica
item
Método LinxProdutosDetalhesSimplificado (Retorna informações dos produtos de acordo com
a loja pesquisada)
Campos Tipo Descrição
portal INT Código do portal no Microvix
empresa INT Código da empresa no portal
cnpj_emp VARCHAR (14) CNPJ da loja
cod_produto BIGINT Código do produto no Microvix
quantidade MONEY Posição do estoque atual do produto
id_config_tributaria INT Código da Configuração Tributária do
produto
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxProdutosDetalhesSimplificado
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
cod_produto Não BIGINT Código do produto
somente_com_saldo Não BIT 0 – Retorna todos os produtos
1 – Retorna apenas os produtos com
saldo
Quando não informado o padrão é 1
Método LinxConfiguracoesTributariasDetalhesSimplificado (Retorna o detalhamento das
configurações tributarias de forma simplificada. )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_config_tributaria_detalhe INT Código do Detalhe da Configuração
Tributária
id_config_tributaria INT Código da Configuração Tributária do
produto
cod_natureza_operacao CHAR (10) Código da natureza de operação
id_classe_fiscal SMALLINT Id da classe fiscal
id_cst_icms_fiscal SMALLINT Id do cst icms fiscal
id_csosn_fiscal SMALLINT Id do csosn fiscal
id_cfop_fiscal SMALLINT Id da cfop fiscal
ipi_credito BIT IPI credito
icms_credito BIT ICMS credito
aliq_icms MONEY Aliquota de ICMS
perc_reducao_icms MONEY Percentual de redução de ICM
aliquota_st MONEY Aliquota ST
margem_st MONEY Margem ST
Página 77
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxConfiguracoesTributariasDetalhesSimplificado
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_config_tributaria Não INT Código da Configuração Tributária
Método LinxNatureza Operacao (Retorna as naturezas de operações )
Campos Tipo Descrição
portal INT Código do portal no Microvix
cod_natureza_operacao CHAR (10) Código da natureza de operação
descricao VARCHAR (60) Descrição da natureza de operação
soma_relatorios CHAR (1) Soma em relatórios (S/N)
operacao CHAR (2) Operação
inativa CHAR (1) Inativa (S/N)
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
calcula_ipi BIT Indica se para essa Natureza se aplica o
cálculo do Imposto sobre Produto
Industrializado - IPI:
S - calcula
N - não calcula
calcula_iss BIT Indica se para essa Natureza se aplica o
cálculo do Imposto sobre Serviço - ISS:
S - calcula
N - não calcula
calcula_irrf BIT Indica se para essa Natureza se aplica o
cálculo do Imposto de Renda Retido na
Fonte - IRRF:
S - calcula
N - não calcula
tipo_preco CHAR (2) Indica que campo do cadastro do produto
será utilizado pelo sistema ao lançar um
documento com essa Natureza:
PV - preço de venda,
C1 - custo com ICMS
CT - custo total,
VU - Valor última compra (apenas para
devolução de compra)
CM - Custo Médi o atual (apenas para saída)
atualiza_custo CHAR (1) Campo que determina de que forma deverá
ocorrer a atualização do campo Custo ICMS
do cadastro do produto, sendo as opções:
N - Não atualizar
S - Custo de reposição (representa o preço
do produto da última entrada)
M - Custo médio. OBS: Esse campo
deverá ser preenchido quando a
operação for 'E' (entrada).
Página 78
transferencia BIT Indica se a Natureza de Operação se refere
a uma operação de Transferência entre
Filiais
baixar_estoque BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema deverá ou
não atualizar o saldo do produto
consumo_proprio BIT Indica se a Natureza de Operação se refere
a uma operação de consumo próprio.
contabiliza_cmv BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema deverá
gerar um lançamento contábil com o Custo
da Mercadoria Vendida (CMV)
despesa BIT Indica que a Natureza de Operação é
relativa a uma operação de despesa e deve
ser contabilizada conforme uma Operação
Padrão específica, que é a Despesas (997).
atualiza_custo_medio BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema deverá ou
não atualizar o custo médio do produto.
Aplica -se somente a operações de entrada.
exige_nf_origem BIT Indica se ao lançar um documento com esta
Natureza de Operação o usuário será
obrigado a informar um documento de
origem (referenciar outro documento).
Aplica -se somente a operações de
devolução.
integra_contabilidade BIT Indica se ao lançar um documento com esta
Natureza de Operação deverá ser gerado
um lançamento contábil (respeitando as
Operações Padrões do sistema) e as faturas
no financeiro
id_obs INT Indica o código da Observação Padrão que
deverá ser relacionada a Natureza de
Operação. O ID deverá estar previamente
cadastrado em: Faturamento > Cadastros
Auxiliares > Observações Padrões (tabela
movimento_observacoes)
venda_futura BIT Indica que a Natureza de Operação é
relativa a uma operação de entrega futura
(gera financeiro, mas não baixa estoque) e
deve ser contabilizada conforme uma
Operação Padrão específica, que é a
Estoque de Terceiros - Entrega Futura (62).
Só deve ser ativado quando a Natureza não
atualizar estoque. É utilizada por um
processo específico nas rotinas e Emissão
de Nota (antiga) e Entrega Futura (nova).
base_icms_considera_ipi BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema deverá
somar o valor do IPI na Base de Cálculo do
ICMS
permite_escolha_historico BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema permitirá
selecionar um histórico contábil
manualmente ao invés de usar o histórico
da Operação Padrão. Parâmetro utilizado
pela rotina de emissão de nota e entrada de
compras manual e xml(antiga)
Página 79
import_produtos BIT Indica que a Natureza de Operação é
relativa a uma operação de importação de
mercadorias. Deve ser utilizado somente
para operação de entrada. É respeitado
somente na entrada de compras manual e
quando ativado apresenta campos relativos
a operação de impor tação para o usuário
preencher.
deposito_reserva_venda INT Depósito para reserva de mercadoria, após
venda com entrega futura.
exibe_nfe BIT Indica se ao lançar um documento com esta
Natureza de Operação este deverá gerar
NF-e. Este parâmetro deve ser ativado por
padrão para operação de Saída e
Devolução. Para naturezas de entrada
recomenda -se marcar esta opção somente
quando fizer uma nota de entrada com
série de saída
faturamento_antecipado BIT Indica que a Natureza de Operação é
relativa a uma operação de faturamento
antecipado (gera financeiro, mas não baixa
estoque) e deve ser contabilizada conforme
uma Operação Padrão específica, que é a
Faturamento Antecipado (63). Só deve ser
ativado quando a Natureza não atualizar
estoque. É utilizada por um processo
específico nas rotinas e Emissão de Nota
(antiga) e Entrega Futura (nova).
exibir_informacoes_imposto BIT Parâmetro exclusivo para naturezas de
saída. Determina a exibição das
informações referente a Lei de Olho no
Imposto. Ao marcá -lo deve -se realizar as
configurações necessárias em Empresa>
Parâmetros Globais> Faturamento -Gerais>
Lei de Olho no Imposto.
gera_garantia_nacional BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema irá gerar
uma Garantia Nacional para o produto,
possibilitando a troca em qualquer loja do
país. Parâmetro específico da rede Chilli
Beans, na qual são necessárias outras
parametrizaç ões para o processo acontecer
corretamente
transferencia_deposito BIT Indica se esta Natureza de Operação
poderá ser utilizada na rotina de
Transferência entre Depósitos. A Natureza
em questão deverá ser selecionada em:
Empresa > Parâmetros globais > Estoque >
Transferência entre
depósitos. Deverá haver uma natureza de
operação para entrada e outra para saída
venda_diferencial_aliquota BIT Indica se ao lançar um documento com esta
Natureza de Operação o sistema deverá
calcular Diferencial de Alíquota de operação
interestadual a não contribuinte (DIFAL).
Aplica -se somente a operações de saída de
devolução de saída. Além de marcar este
parâmet ro é necessário informar os
Página 80
percentuais do imposto na Config.
Tributária do produto.
insere_obs_pis_cofins BIT Indica se será apresentado um totalizador
com os valores de Pis e Cofins na
Observação da Nota Fiscal
diferencial_ativo_consumo BIT Indica se ao utilizar esta Natureza de
Operação poderá ser realizado o cálculo de
Diferencial de Alíquota relativo a operações
de uso e consumo (serão necessárias
outras configurações)
recusa_de BIT Indica se esta Natureza de Operação será
utilizada na rotina de Recusa de Nota Fiscal
de Devolução de Compra
codigo_ws VARCHAR (50) Esse campo exporta o código enviado na
integração via ws de entrada pelo método
LinxCadastraNatuezaOperacao.
Parâmetros de consulta do método LinxNatureza Operacao
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da
loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
cod_natureza_operacao Não CHAR (10) Código da natureza de operação
Método LinxClasseFiscal (Retorna o cadastro da classe fiscal. )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_classe_fiscal SMALLINT Id da classe fiscal
descricao VARCHAR (150) Descrição da classe fiscal
excluido BIT Determina se a classe fiscal está excluída
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxClasseFiscal
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_classe_fiscal Não SMALLINT Id da classe fiscal
Método LinxCstIcmsFiscal (Retorna o cadastro de cst icms fiscal ):
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cst_icms_fiscal SMALLINT Id do cst icms fiscal
cst_icms_fiscal VARCHAR (4) Código do cst icms fiscal
descricao VARCHAR (150) Descrição do cst icms fiscal
substituicao_tributaria BIT 0 – Não ou 1 – Sim
Página 81
excluido BIT Determina se a cst icms fiscal está excluída
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxCstIcmsFiscal
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
cst_icms_fiscal Não VARCHAR (4) Código do cst icms fiscal
id_cst_icms_fiscal Não SMALLINT Id do cst icms fiscal
Método LinxCsosnFiscal (Retorna o cadastro de csosn fiscal ):
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_csosn_fiscal SMALLINT Id do csosn fiscal
csosn_fiscal VARCHAR (5) Código do csosn fiscal
descricao VARCHAR (200) Descrição do csosn fiscal
id_csosn_fiscal_substitutiva SMALLINT Id do csosn fiscal substituitiva
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxCsosnFiscal
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa
timestamp Sim BIGINT Último Timestamp consultado
id_csosn_fiscal Não SMALLINT Id do csosn fiscal
csosn_fiscal Não VARCHAR (5) Código do csosn fiscal
Método LinxCfopFiscal (Retorna o cadastro da CFOP Fiscal ):
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cfop_fiscal SMALLINT Id da cfop fiscal
cfop_fiscal VARCHAR (5) Código da cfop fiscal
descricao VARCHAR (300) Descrição da cfop fiscal
excluido BIT Determina se a cfop fiscal está excluída
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxCfopFiscal
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa
timestamp Sim BIGINT Último Timestamp consultado
Página 82
id_cfop_fiscal Não SMALLINT Id da cfop fiscal
cfop_fiscal Não VARCHAR (5) Código da cfop fiscal
Método LinxRotinaOrigem (Retorna as rotinas cadastradas no portal):
Campos Tipo Descrição
portal INT Código do portal no Microvix
codigo_rotina TINYINT Código da rotina
descricao_rotina VARCHAR (150) Descrição da rotina
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxRotinaOrigem
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa
timestamp Sim BIGINT Último Timestamp consultado
codigo_rotina Não TINYINT Código da rotina
Método LinxPedidosVendaChecklistEntregaLocal (Retorna os tipos de locais cadastrados no
checklist de entrega do pedido de venda):
Campos Tipo Descrição
id_checklist_entrega_local INT ID do tipo de local de entrega
descricao VARCHAR (100) Descrição do tipo de local de entrega
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxPedidosVendaChecklistEntregaLocal:
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da
loja a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_checklist_entrega_local Não INT ID do tipo de local de entrega.
Método LinxPedidosVendaChecklistEntregaArmazenamento (Retorna os tipos de
armazenamentos cadastrados no checklist de entrega do pedido de venda):
Campos Tipo Descrição
id_checklist_entrega_armazenamento INT ID do tipo de armazenamento da
entrega
descricao VARCHAR (100) Descrição do tipo de
armazenamento da entrega
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no Microvix
Página 83
Parâmetros de consulta do método LinxPedidosVendaChecklistEntregaArmazenamento :
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao
Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado
o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp
consultado
id_checklist_entrega_armazenamento Não INT ID do tipo de
armazenamento da
entrega.
Método LinxPedidosVendaChecklistEntregaDificuldade (Retorna os tipos de dificuldades
cadastradas no checklist de entrega do pedido de venda):
Campos Tipo Descrição
id_checklist_entrega_dificuldades INT ID do tipo de dificuldade da entrega
descricao VARCHAR (100) Descrição do tipo de dificuldade da
entrega
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxPedidosVendaChecklistEntregaDificuldade:
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao
Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o
CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp
consultado
id_checklist_entrega_dificuldade Não INT ID do tipo de dificuldade
da entrega.
Método LinxSetores (Retorna os setores cadastrados no portal):
Campos Tipo Descrição
id_setor INT Identifição do setor
desc_setor VARCHAR (30) Descrição do setor
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
ativo BIT Ativo = 1 ou Inativo = 0
portal INT Id do código do portal no Microvix.
Parâmetros de consulta do método LinxSetores
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
Página 84
timestamp Sim BIGINT Último Timestamp consultado
id_setor Não INT Id do setor
Método LinxLinhas (Retorna as linhas cadastrad as no portal):
Campos Tipo Descrição
id_linha INT Identifição da linha
desc_linha VARCHAR (30) Descrição da linha
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
portal INT Número do portal
coeficiente_comissao FLOAT Coeficiente de comissao
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxLinhas
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Não BIGINT Último Timestamp consultado
id_linha Não INT Id da linha
Método LinxMarcas (Retorna as marcas cadastrad as no portal):
Campos Tipo Descrição
id_marca INT Identificação da Marca
desc_marca VARCHAR (30) Descrição da Marca
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMarcas
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_marca Não INT Id da marca
Método LinxColecoes (Retorna as coleções cadastrad as no portal):
Campos Tipo Descrição
id_colecao INT Identificação coleção
desc_colecao VARCHAR (50) Descrição da coleção
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
portal INT Id do código do portal no Microvix.
Página 85
Parâmetros de consulta do método LinxColecoes
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_colecao Não INT Id da coleção
Método LinxTamanhos (Retorna os tamanhos cadastrados no portal):
Campos Tipo Descrição
id_tamanho VARCHAR (5) Identificação do tamanho
desc_tamanho VARCHAR (50) Descrição do tamanho
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
ativo BIT Ativo = 1 ou Inativo = 0
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxTamanhos
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_tamanho Não INT Id do tamanho
Método LinxCores (Retorna as cores cadastrad zs no portal):
Campos Tipo Descrição
id_cor INT Identificação da cor
desc_cor VARCHAR (30) Descrição da cor
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
ativo BIT Ativo = 1 ou Inativo = 0
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxCores
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_cor Não INT Id da cor
Página 86
Método LinxEspessuras (Retorna as espessuras cadastrad zs no portal):
Campos Tipo Descrição
id_espessura INT Identificação da espessura
desc_espessura VARCHAR (50) Descrição da espessura
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
ativo BIT Ativo = 1 ou Inativo = 0
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxEspessuras
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_espessura Não INT Id da espessura
Método LinxClassificacoes (Retorna as classificações cadastrad zs no portal):
Campos Tipo Descrição
id_classificacao INT Identificação classificação
desc_classificacao VARCHAR (50) Descrição da classificação
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
codigo_integracao_ws VARCHAR(50) Código da integração do webservice
ativo BIT Ativo = 1 ou Inativo = 0
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxClassificacoes
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_classificacao Não INT Id da classificação
Método LinxUnidades (Retorna as unidades cadastrad as no portal):
Campos Tipo Descrição
unidade VARCHAR (50) Unidade
descricao VARCHAR (200) descrição da unidade
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 87
Parâmetros de consulta do método LinxUnidades
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
unidade Não VARCHAR (50) Unidade
Método LinxRamosAtividade (Retorna os ramos de atividade cadastrados no portal):
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_ramo_atividade SMALLINT Identificação do ramo de atividade
nome_ramo_atividade VARCHAR (50) Nome do ramo de atividade
codigo_ramo_atividade VARCHAR (12) Código do ramo de atividade
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxRamosAtividade
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxECF (Retorna as ECFs cadastrados no portal):
Campos Tipo Descrição
id_ecf SMALLINT Código do ECF
empresa INT Empresa
ecf SMALLINT ECF
numeroserie VARCHAR (30) Número da Série
indice_sangria VARCHAR (4) Índice Sangria
modelo TINYINT Modelo
nome VARCHAR (30) Nome
indice_suprimento VARCHAR (4) Índice Suprimento
ativo BIT Ativo
indice_sinal VARCHAR (53) Índice Sinal
indice_antecipacao VARCHAR (50) Índice Antecipação
indice_cartao_credito VARCHAR (50) Índice Cartão de crédito
empresa_ecf VARCHAR (50) Empresa ECF
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 88
Parâmetros de consulta do método LinxECF
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxECFFormasPagamento (Retorna as formas de pagamento de uma ECF):
Campos Tipo Descrição
id_empresa_ecf_formas_pgto INT Código empresa ecf formas de pagamento
id_ecf SMALLINT Código ECF
cod_forma_pgto INT Código forma de pagamento
indice_forma VARCHAR (53) Índice Forma
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxECFFormasPagamento
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoGiftCard (Retorna os dados de Gift Card):
Campos Tipo Descrição
empresa INT Empresa
data_transacao SMALLDATETIME Data da transação
operacao TINYINT Operação
nsu_cliente VARCHAR (100) NSU do cliente
nsu_host VARCHAR (100) NSU do host
valor MONEY Valor
json_envio VARCHAR (MAX) Json do envio
json_retorno VARCHAR (MAX) Json do retorno
qtde_tentativa INT Quantidade tentativa
aprovado_barramento VARCHAR (4) Aprovado barramento
estornada BIT Estornada
codigo_loja VARCHAR (100) Código da loja
identificador_movimento UNIQUEIDENTIFIER Identificador do movimento
numero_cartao VARCHAR (100) Número do cartão
plano INT Plano
ambiente_producao BIT Ambiente de produção
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 89
Parâmetros de consulta do método LinxMovimentoGiftCard
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
data_inicial Não DATE Data inicial
data_fim Não DATE Data Fim
identificador Não UNIQUEIDENTIFIER Identificador
numero_cartao Não VARCHAR (100) Número do Cartão
Método LinxProdutosOpticosTipo (Retorna os tipos de produtos opticos):
Campos Tipo Descrição
id_produtos_opticos_tipo INT Código do produto optico tipo
tipo VARCHAR (100) Tipo do produto
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxProdutosOpticosTipo
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR ( 14) CNPJ da empresa
timestamp Sim BIGINT Último Timestamp consultado
Método LinxProdutosSerial (Retorna os seriais cadastrados no portal):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
empresa INT Empresa
codigoproduto BIGINT Código de produto no Microvix
serial VARCHAR (50) Código do produto serial
id_deposito INT ID do depósito
saldo BIT Saldo produto serial
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros LinxProdutosSerial
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
codigoproduto Não BIGINT Código de produto no Microvix
serial Não VARCHAR (50) Código do produto serial
depositos Não VARCHAR (100) Códigos dos depósitos, separados por
vírgula.
Página 90
Método LinxMovimentoRemessas (Retorna os dados da tabela remessas no portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
empresa INT Empresa
id_remessas INT Id remessa
id_tipo INT Id do tipo de remessa na tabela
remessa_retorno_tipos
identificador_remessa UNIQUEIDENTIFIER Identificador da remessa na tabela
movimento
status TINYINT Id do status da remessa
status_descricao VARCHAR (35) Descrição do status da remessa
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoRemessas
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
id_tipo Não INT Id do tipo de remessa na tabela
remessa_retorno_tipos
identificador Não UNIQUEIDENTIFIER Identificador da tabela remessas
Método LinxMovimentoRemessasItens (Retorna os dados da tabela remessas_itens no portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
empresa INT Id da empresa no portal
id_remessas_itens INT Id remessa itens
id_remessas INT Id da remessa na tabela remessas
transacao INT Id da transação da remessa na tabela movimento
qtde_total FLOAT Quantidade total
qtde_venda FLOAT Quantidade de venda
qtde_devolvido FLOAT Quantidade devolvido
qtde_pendente FLOAT Quantidade pendente
qtde_pendente_pagamento FLOAT Quantidade pendente pagamento
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoRemessasItens
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_remessas Não INT Id da remessa na tabela remessas
transacao Não INT Id da transação da remessa na tabela
movimento
Página 91
Método LinxMovimentoRemessasAcertos (Retorna os dados da tabela remessas _acertos no
portal.)
Campos Descrição Formato
portal INT Id do Portal no Microvix
empresa INT Id da empresa no portal
id_remessas_acertos INT Id da tabela remessas acertos
id_remessas INT Id da remessa na tabela remessas
identificador_venda UNIQUEIDENTIFIER Identificador da venda na tabela movimento
identificador_retorno UNIQUEIDENTIFIER Identificador do retorno na tabela movimento
identificador_devolucao UNIQUEIDENTIFIER Identificador da devolução na tabela movimento
data SMALLDATETIME Data
id_vendas_pos BIGINT Id na tabela vendas_pos
excluido BIT Excluído
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxMovimentoRemessasAcertos
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
data_inicial Não SMALLDATETIME Informar a data inicial do período
consultado. (AAAA -MM-DD)
data_fim Não SMALLDATETIME Informar a data final do período
consultado. (AAAA -MM-DD)
id_remessas Não INT Id da remessa na tabela remessas
Método LinxMovimentoRemessasAcertosItens (Retorna os dados da tabela remessas _acertos _
itens no portal.) :
Campos Descrição Formato
portal INT Id do Portal no Microvix
empresa INT Id da empresa no portal
id_remessas_acertos INT Id na tabela remessas_acertos
transacao INT Id da transação da remessa na tabela
movimento
qtde_total FLOAT Quantidade total
id_remessa_operacoes TINYINT Id do tipo de operação na tabela
remessa_operacoes
id_remessas_itens INT Id na tabela remessas_itens
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Página 92
Parâmetros de consulta do método LinxMovimentoRemessasAcertosItens
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_remessas_acertos Não INT Id na tabela remessas_acertos
id_remessas_itens Não INT Id na tabela remessas_itens
transacao Não INT Id da transação da remessa na tabela
movimento
Método LinxRemessasRetornoTipos (Retorna os dados da tabela remessa_retorno_tipos no
portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
id_remessa_retorno_tipos INT Id da tabela remessa_retorno_tipos
descricao VARCHAR (50) Descrição do tipo de retorno
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxRemessasRetornoTipos
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxRemessasOperacoes (Retorna os dados da tabela remessa_ operacoes no portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
id_remessa_operacoes TINYINT Id da tabela remessa_operacoes
descricao VARCHAR (30) Descrição da operação
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxRemessasOperacoes
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxLojasParametros (Retorna parâmetros do portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
empresa INT Empresa
Página 93
percentual_minimo_antecipacao MONEY Percentual mínimo antecipação
financeira
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxLojasParametros
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxSeries (Retorna as séries cadastradas no portal.):
Campos Descrição Formato
portal INT Id do Portal no Microvix
serie VARCHAR (10) Série
id_modelo_nf INT Id modelo NF
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxSeries
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
id_modelo_nf Não INT Id modelo NF
Método LinxNFeEvento (Retorna os dados d e eventos de NFe .):
Campos Descrição Formato
portal INT Id do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da empresa
id_nfe_evento INT Id na Nfe evento
id_nfe INT Id da Nfe
codigo_tipo VARCHAR (6) Código do tipo:
110110 - Carta de Correção Eletrônica – CC-e
110111 - Evento de Cancelamento
xml VARCHAR (MAX) XML
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
data_emissao SMALLDATETIME Data de emissão do evento NFe
hora_emissao CHAR (5) Hora da emissão d o evento NFe
Parâmetros de consulta do método LinxNFeEvento
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
Página 94
timestamp Sim BIGINT Último Timestamp consultado
codigo_tipo Não VARCHAR ( 6) Código do tipo
id_nfe Não INT Id NFe
Método LinxMetasVendedoresDia (Retorna as metas dos vendedores por dia )
Campos Descrição Formato
portal INT Id do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da empresa
id_meta INT Id da meta
descricao_meta VARCHAR (50) Descrição da meta
data_inicial_meta SMALLDATETIME Data inicial da meta
data_final_meta SMALLDATETIME Data final da meta
dia SMALLDATETIME Dia
valor_meta_diaria MONEY Valor meta diária
cod_vendedor INT Código do vendedor
Parâmetros de consulta do método LinxMetasVendedoresDia
Campos Obrigatório Tipo Observações
cnpjEmp Sim VARCHAR (14) Chave de acesso ao Webservice
chave Sim UNIQUEIDENTIFIER Deverá ser informado o CNPJ da loja a ser
consultado
data_inicial_meta Sim SMALLDATETIME Data inicial da meta
data_fim_meta Sim SMALLDATETIME Data fim da meta
id_meta Não INT Id da meta
cod_vendedor Não INT Código do vendedor
Método LinxSpedTipoItem (Retorna o tipo de item de sped
Campos Descrição Formato
portal INT Id do Portal no Microvix
id_sped_tipo_item INT Id sped tipo item
codigo VARCHAR (2) Código tipo item
descricao VARCHAR (60) Descrição tipo item
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxSpedTipoItem
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Página 95
Método LinxRemessasIdentificadores (Recebe o identificador da venda e retorna a relação com
os identificadores das notas dos itens da remessa. ):
Campos Tipo Descrição
identificador_venda UNIQUEIDENTIFIER Id da transação da venda na tabela movimento
identificador_remessa UNIQUEIDENTIFIER Id da transação da remessa na tabela
movimento
id_remessas INT Id remessa
id_remessas_acertos INT Id da tabela remessas acertos
transacao _acerto INT Id da transação da remessa na tabela
movimento
qtde_total _acerto FLOAT Quantidade total
transacao_remessa INT Transação remessa
identificador_devolucao UNIQUEIDENTIFIER Identificador da devolução
id_remessa_operacoes TINYINT Id remessa operações
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxRemessasIdentificadores
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
identificador_venda Não UNIQUEIDENTIFIER Identificador da venda
identificador_devolucao Não UNIQUEIDENTIFIER Identificador da devolução
Obs 1: É obrigatório informar 1 filtro de identificador e somente 1, ou seja, não é possível usar os
2 como filtro .
Obs 2: Quando utilizado o filtro identificador_devolucao serão exportadas apenas os
id_remessa_operacoes 1 e 2, quando utilizado o filtro identificador_venda serão exportadas apenas
os id_remessa_operacoes 3.
Método LinxTrocaUnificadaResumoVendas (Retorna as vendas do troca unificada)
Campos Tipo Descrição
portal INT Id do Portal no Microvix
empresa INT Id da empresa no portal
id_troca_unificada_resumo_vendas BIGINT Id da Troca Nacional Resumo Venda
token VARCHAR (30) Token gerado na Troca Nacional
identificador UNIQUEIDENTIFIER Identificador da venda no método
LinxMovimento
documento INT Número do documento fiscal
serie VARCHAR (10) Série do documento
data_venda SMALLDATETIME Data da venda
documento_cliente VARCHAR (14) CPF ou CNPJ do Cliente
venda_cancelada BIT 0 = Não cancelada, 1 = Cancelada
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
Página 96
Obs1: Para quando o cliente utiliza a base central, apenas serão exportadas trocas que tenham ao
menos 1 item dentro validade ou que a troca já tenha sido utilizada ou regerada.
Obs2: O retorno do método está limitado em 10mil registros por consulta, por isso é imprescindível
que o controle de buscas seja feito pelo timestamp.
Parâmetros de consulta do método LinxTrocaUnificadaResumoVendas
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxTrocaUnificadaResumoVendasItens (Retorna os itens das vendas da troca
unificada )
Campos Tipo Descrição
id_troca_unificada_resumo_vendas_itens BIGINT Id da Troca Nacional Resumo
Venda Item
id_troca_unificada_resumo_vendas BIGINT Id da Troca Nacional Resumo
Venda
codigoproduto BIGINT Código de produto no Microvix
transacao INT Código da transação da venda
serial VARCHAR (50) Código do Serial
valor_liquido MONEY Valor Líquido do produto
data_validade SMALLDATETIME Data Validade
venda_referenciada BIT 0 = Não, 1 = Sim
token_utilizado BIT 0 = Não, 1 = Sim
quantidade FLOAT Quantidade do produto
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
Parâmetros de consulta do método LinxTrocaUnificadaResumoVendasItens
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoPrincipal (Retorna os dados d o movimento principal)
Campos Tipo Descrição
id_movimento_principal INT Id do movimento principal
identificador UNIQUEIDENTIFIER Identificador d o movimento
codigoproduto_manutencao BIGINT Código do produto manutenção
timestamp BIGINT Timestamp da tabela
id_pergunta_venda INT ID da pergunta no final da venda
cadastrada no portal.
Página 97
id_resposta_venda INT ID da resposta no final da venda
cadastrada no portal.
total_fidelidade_cashback MONEY Total fidelidade cashback
plano_fidelidade_cashback INT Plano de fidelidade cashback
remessa_pedido_compra VARCHAR (30) número da remessa enviado pelo
método de entrada LinxCadastraNotas
no campo remessa
id_motivo_desconto INT ID do motivo de desconto na venda
valor_nota MONEY Valor da nota
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoPrincipal
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
identificador Não UNIQUEIDENTIFIER Identificador da venda localizado no método
LinxMovimento
limite Não BIGINT Limitar a quantidade de registros retornados
Método LinxCupomDesconto (Retorna os dados da tabela cupom_desconto cadastrados no
portal):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
empresa INT Código da empresa no portal Microvix
id_cupom_desconto INT Código do cadastro do cupom de
desconto
cupom VARCHAR (50) Nome do cupom de desconto
descricao VARCHAR (255) Descrição do cupom de desconto
percentual_desconto FLOAT Percentual de desconto do cupom
data_inicial_vigencia DATETIME Data de início da vigência do cupom
data_final_vigencia DATETIME Data do término da vigência do cupom
qtde_original INT Quantidade original de cupons
qtde_disponivel INT Quantidade ainda disponível de cupons
cod_vendedor INT Código do vendedor
disponivel BIT Cupom ativo
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Página 98
Parâmetros de consulta do método LinxCupomDesconto
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
a ser consultado
timestamp Sim BIGINT Último timestamp consultado
data_inicial Não VARCHAR(10) Data do início da vigência (aaaa -mm-
dd)
data_fim Não VARCHAR(10) Data do término da vigência (aaaa -
mm-dd)
id_cupom_desconto Não INT Código do cupom de desconto
Método LinxCupomDescontoVendas (Retorna o id do cupom de desconto, o valor do cupom e o
identificador das vendas que utilizaram cupons de desconto):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
empresa INT Código da empresa no portal Microvix
id_cupom_desconto_vendas INT Id da tabela cupom_desconto_vendas
id_cupom_desconto INT Código do cadastro do cupom de
desconto
identificador UNIQUEIDENTIFIER Identificador da venda na tabela
movimento
valor FLOAT Valor do cupom de desconto utilizado
na venda
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
id_vendas_pos INT ID da venda
Parâmetros de consulta do método LinxCupomDescontoVendas
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último timestamp consultado
identificador Não UNIQUEIDENTIFIER Identificador da tabela movimento
id_cupom_desconto Não INT Código do cupom de desconto
Página 99
Método LinxTrocaUnificadaResumoBaixa (Retorna as vendas do troca unificada resumo baixa)
Campos Tipo Descrição
portal_baixa INT Id do portal de baixa no Microvix
empresa_baixa INT Id da empresa de baixa no portal
cnpj_empresa_baixa VARCHAR (14) CNPJ da empresa de baixa
id_troca_baixa INT Id da Troca Nacional
id_troca_unificada_resumo_vendas_itens BIGINT Id da Troca Nacional Resumo
Venda Itens
Vínculo com o método
LinxTrocaUnificadaResumoVenda
sItens
data_troca_baixa SMALLDATETIME Data da movimentação de
devolução no método
LinxMovimento
transacao_baixa INT Número da transação relacionada
com a movimentação de
Devolução no método
LinxMovimento
descricao_empresa_baixa VARCHAR (50) Descrição da empresa de baixa
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
Obs: O retorno do método está limitado em 10mil registros por consulta, por isso é imprescindível
que o controle de buscas seja feito pelo timestamp.
Parâmetros de consulta do método LinxTrocaUnificadaResumoBaixa
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxListagemBalanco (Retorna a listagem de balanços ):
Campos Tipo Descrição
id_balanco INT Código do balanço no Microvix
data SMALLDATETIME Data do inventário processado no Microvix
nome_arquivo VARCHAR (50) Nome do arquivo de inventário
processado CHAR (1) Se o balanço foi processado S ou N
data_ultimo_processamento SMALLDATETIME Data para lançamento (quando a loja indica
que foi feita a contagem física)
qtde_produtos INT Quantidade de produtos no estoque
qtde_itens INT Quantidade de itens contados
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 100
Parâmetros de consulta do método LinxListagemBalanco :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja a ser
consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxProdutosAssociados (Retorna a listagem de produtos associados):
Campos Tipo Descrição
portal NVARCHAR (50) Número d o portal no Microvix
codigoproduto_origem BIGINT Código do produto no Microvix que possui a
associação.
codigoproduto_associado BIGINT Código do produto no Microvix que é
associado ao produto origem.
coeficiente_desconto FLOAT Coeficiente de desconto aplicado ao produto
associado.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
qtde_item FLOAT Quantidade de itens da associação.
item_obrigatorio BIT Obrigatório: 1, Não Obrigatório: 0
Parâmetros de consulta do método LinxProdutosAssociados :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoObservacaoCF (Retorna as observações do cupom fiscal):
Campos Tipo Descrição
identificador UNIQUEIDENTIFIER Identificador de movimento.
documento_cliente VARCHAR(14) Documento do cliente
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoObservacaoCF :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoReshop (Retorna movimentação de campanhas do Reshop ):
Campos Tipo Descrição
id_movimento_campanha_reshop INT Id da tabela.
id_campanha INT Id da campanha do Reshop .
identificador UNIQUEIDENTIFIER Identificador de movimento.
Página 101
nome VARCHAR(200) Nome da campanha do Reshop .
descricao VARCHAR(200) Descrição da campanha do Reshop .
aplicar_desconto_venda BIT 0 = Não, 1 = Sim.
valor_desconto_subtotal MONEY Valor do desconto do subtotal .
valor_desconto_completo MONEY Valor do desconto completo .
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoReshop :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoReshopItens (Retorna os itens de movimentação de campanhas do
Reshop ):
Campos Tipo Descrição
id_movimento_campanha_reshop_item INT Id da tabela
id_campanha INT Id da campanha do Reshop
identificador UNIQUEIDENTIFIER Identificador de movimento.
valor_unitario MONEY Valor unitário
valor_desconto_item MONEY Valor desconto item
valor_total_desconto_item MONEY Valor total de desconto do item
Reshop
quantidade FLOAT Quantidade
valor_original MONEY Valor original
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
ordem SMALLINT Ordem do item na nota fiscal
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoReshopItens :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxCentroCusto (Retorna as informações dos centros de custos cadastrados no portal)
Campos Tipo Descrição
portal INT Código do portal no Microvix
empresa INT Código da empresa no Microvix
CNPJ VARCHAR (14) CNPJ da loja
id_centrocusto INT ID do centro de custo no Microvix
nome_centrocusto VARCHAR (50) Nome do centro de custo
Página 102
ativo BIT Indica se está ativo. 1 – Ativo e 0 – Inativo.
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxCentroCusto
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxPlanoContas (Retorna as informações do plano de contas cadastrado no portal)
Campos Tipo Descrição
portal INT Código do portal no Microvix
empresa INT Código da empresa no Microvix
CNPJ VARCHAR (14) CNPJ da loja
id_conta INT ID da conta contábil no Microvix
nome_conta VARCHAR (50) Nome da conta contábil
sintetica CHAR (1) Indica se a conta é sintética. S – Sim e N – Não.
indice VARCHAR (150) Índice da conta contábil
ativa CHAR (1) Indica se a conta está ativa. S – Sim e N – Não.
fluxo_caixa CHAR (1) Indica se é uma conta de fluxo de caixa. S – Sim e N –
Não.
CONTA_CONTABIL VARCHAR (20)
id_natureza_conta INT ID da natureza da conta na tabela
sped_natureza_conta_contabil. Indicando se a conta
contábil é: Contas de ativo, Contas de passivo,
Patrimônio líquido, Contas de resultado, Contas de
compensação ou outras.
conta_bancaria BIT Indica se é uma conta bancária. 1 – Sim e 0 – Não.
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxPlanoContas
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
FiltrarCNPJ Não BIT Filtra o CNPJ da empresa para consulta
Método LinxPerguntaVenda (Retorna as perguntas no final da venda cadastradas no portal )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_pergunta_venda INT ID da pergunta no final da venda cadastrada no portal
Página 103
descricao_pergunta VARCHAR (200) Descrição da pergunta no final da venda cadastrada no
portal
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxPerguntaVenda
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxRespostaVenda (Retorna as respostas no final da venda cadastradas no portal )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_resposta_venda INT ID da resposta no final da venda cadastrada no portal
descricao_resposta VARCHAR (100) Descrição da resposta no final da venda cadastrada no
portal
id_pergunta_venda INT ID da pergunta no final da venda cadastrada no portal
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxRespostaVenda
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxConfiguracoesTributariasEmpresas (Retorna o conteúdo da tabela
config_tributaria_empresa)
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_config_tributaria INT Id do cadastro da configuração tributária no Microvix
empresa INT Id do cadastro da empresa no Microvix
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxConfiguracoesTributariasEmpresas
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Página 104
Método LinxCest (Retorna o conteúdo da tabela classificacao_cest_produto)
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cest INT ID do cadastro na tabela
descricao VARCHAR (700) Descrição do CEST
cest VARCHAR (10) Código CEST
id_segmento_mercadoria_bem INT ID do cadastro na tabela
segmento_mercadoria_bem
ativo BIT Indica se o cadastro está ativo. 1 = Ativo e
0 = Inativo
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxCest
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxCstCofinsFiscal (Retorna o conteúdo da tabela cst_cofins_fiscal )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cst_cofins_fiscal INT ID do cadastro da CST_COFINS_FISCAL no
Microvix
cst_cofins_fiscal VARCHAR(4) Código da CST_COFINS_FISCAL
descricao VARCHAR(150) Descrição da CST_COFINS_FISCAL
excluido BIT Indica se o cadastro está excluído. 1 =
Excluído e 0 = Não excluído
inicio_vigencia DATETIME Início da vigência para a
CST_COFINS_FISCAL
termino_vigencia DATETIME término da vigência para a
CST_COFINS_FISCAL
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxCstCofinsFiscal
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxCstIpiFiscal (Retorna o conteúdo da tabela cst_ipi_fiscal)
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cst_ipi_fiscal INT ID do cadastro da CST_IPI_FISCAL no
Microvix
Página 105
cst_ipi_fiscal VARCHAR (4) Código da CST_IPI_FISCAL
descricao VARCHAR (150) Descrição da CST_IPI_FISCAL
excluido BIT Indica se o cadastro está excluído. 1 =
Excluído e 0 = Não excluído
inicio_vigencia DATETIME Início da vigência para a CST_IPI_FISCAL
termino_vigencia DATETIME término da vigência para a CST_IPI_FISCAL
cst_ipi_fiscal_inverso VARCHAR (4) código da CST_IPI_FISCAL inversa
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxCstIpiFiscal
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxCstPisFiscal (Retorna o conteúdo da tabela cst_pis_fiscal)
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_cst_pis_fiscal INT ID do cadastro da CST_PIS_FISCAL no
Microvix
cst_pis_fiscal VARCHAR(4) Código da CST_PIS_FISCAL
descricao VARCHAR(150) Descrição da CST_PIS_FISCAL
excluido BIT Indica se o cadastro está excluído. 1 =
Excluído e 0 = Não excluído
inicio_vigencia DATETIME Início da vigência para a CST_PIS_FISCAL
termino_vigencia DATETIME término da vigência para a
CST_PIS_FISCAL
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxCstPisFiscal
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxEnquadramentoIpi
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_enquadramento_ipi INT ID do cadastro do enquadramento IPI no
Microvix
codigo CHAR( 3) Código do enquadramento IPI
descricao VARCHAR( 600) Descrição do enquadramento IPI
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Página 106
Parâmetros de consulta do método LinxEnquadramentoIpi
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxMotivosDesoneracaoIcms (Retorna o conteúdo da tabela
motivos_desoneracao_icms)
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_motivos_desoneracao_icms INT Código do motivo da desoneração do ICMS
descricao VARCHAR( 200) Descrição do motivo da desoneração do
ICMS
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxMotivosDesoneracaoIcms
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxMovimentoObservacoes (Retorna o conteúdo da tabela movimento_observacoes )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_obs INT ID do cadastro da observ ação no Microvix
titulo_obs VARCHAR (50) Título da observação
descricao_obs VARCHAR (250) Descrição da observação
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxMovimentoObservacoes
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxNcm (Retorna o conteúdo da tabela classificacao_ncm_produto )
Campos Tipo Descrição
portal INT Código do portal no Microvix
codigo VARCHAR (20) Código da NCM
descricao VARCHAR (60) Descrição da NCM
Página 107
codigo_genero INT Código do gênero da NCM
ativo BIT Indica se o cadastro está ativo. 1 = Ativo e
0 = Inativo
id_ncm INT ID de cadastro código da NCM no Microvix
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxNcm
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxSpedTipoBaseCredito (Retorna o conteúdo da tabela sped_tipo_base_credito )
Campos Tipo Descrição
portal INT Código do portal no Microvix
id_sped_tipo_base_credito INT ID do cadastro do SPED Tipo base de crédito
na tabela do Microvix
codigo_sped_tipo_base_credito VARCHAR (2) Código do SPED Tipo base de crédito
descricao VARCHAR (150) Descrição do SPED Tipo base de crédito
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxSpedTipoBaseCredito
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
Timestamp Sim BIGINT Maior timestamp retornado na última
consulta
Método LinxNfceEstacao (Retorna cadastro de estações )
Campos Tipo Descrição
id_nfce_estacao INT Id da tabela
empresa INT Número da empresa
descricao VARCHAR(50) Descrição d a estação
numero_pdv_tef VARCHAR(20) Número da estação
ativo BIT 1 = Ativo, 0 = Inativo
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
OBS: Para relacionar os registros da LinxMovimento com os registros do novo método
LinxNfceEstacao:
- O campo ecf do método LinxMovimento deve ser igual ao campo id_nfce_estacao do método
LinxNfceEstacao;
- Esta condição somente é válida quando o campo modelo_nf for igual a 33 (Cupom Fiscal Eletrônico
- CF-e) ou 35 (Nota Fiscal ao Consumidor Eletrônica) e o campo codigo_rotina_origem for igual a
Página 108
15 (Venda POS). Fora destas condições o relacionamento não é válido, pois não há uso de estação
e o campo ecf do método LinxMovimento passa a ter outras finalidades.
Parâmetros de consulta do método LinxNfceEstacao
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
Timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoIndicacoes (Retorna o cliente indicador da venda)
Campos Tipo Descrição
identificador UNIQUEIDENTIFIER Identificador de movimento.
cod_cliente INT Código do cliente.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoIndicacoes
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxValesComprasEnviadosAPI (Retorna Vale Compras importado via API)
Campos Tipo Descrição
numero_controle INT Número de controle .
valor_vale MONEY Valor do vale.
doc_cliente VARCHAR(14) Documento do cliente.
status_vale TINYINT 1 = aberto, 2 = resgatado e 3 =
cancelado.
codigo_portal_resgate INT Código do portal de resgate.
codigo_empresa_resgate INT Código da empresa de resgate.
codigo_usuario_resgate INT Código do usuário de resgate.
codigo_vale_empresa_resgate INT Código do vale da empresa de resgate.
data_criacao DATE Data de criação.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
cnpj_empresa_resgate VARCHAR(14) CNPJ da empresa de resgate
data_resgate DATETIME Data de resgate
portal INT Id do código do portal no Microvix
Página 109
Parâmetros de consulta do método LinxValesComprasEnviadosAPI
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Método LinxProdutosLotes (Retorna o saldo dos lotes de produtos)
Campos Tipo Descrição
portal INT Número do portal
codigoproduto BIGINT Código do produto
empresa INT Número da empresa no portal
lote VARCHAR (60) Lote
deposito INT Id do depósito
saldo_disponivel DECIMAL (20,3) Saldo disponível
timestamp BIGINT Timestamp da tabela
Parâmetros de consulta do método LinxProdutosLotes
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
OBS1: São retornados apenas 1000 registros por consulta;
OBS2: Retorna apenas os saldos da data atual;
OBS3: Somente são retornados saldos de produtos que tenham realizado alguma movimentação
de lote na empresa e depósito em questão. Caso não atenda esta condição, não será retornado o
registro (nem mesmo com o valor zero) .
Método LinxMovimentoVendaConjugada (Retorna movimento da venda conjugada)
Campos Tipo Descrição
identificador_produto UNIQUEIDENTIFIER Identificador da venda do produto .
identificador_servico UNIQUEIDENTIFIER Identificador da venda do serviço.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoVendaConjugada
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Página 110
Método LinxNfse (Retorna Nota Fiscal de Serviços Eletrônica)
Campos Tipo Descrição
portal VARCHAR(20) Portal da Nfse.
documento VARCHAR(20) Documento da Nfse.
id_nfse INT Id da Nfse.
codigo_verificacao VARCHAR(50) Código de verificação.
id_nfse_situacao TINYINT Situação da Nfse:
- 1 Autorizada
- 2 Pendente de Envio
- 3 Em Processamento
- 4 Com Erros
- 5 Excluída
- 6 Cancelada
- 7 Cancelar em Processamento
identificador UNIQUEIDENTIFIER Identificador do movimento.
dt_insert SMALLDATETIME Data de inserção da Nfse.
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxNfse
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) Deverá ser informado o CNPJ da loja
timestamp Sim BIGINT Último Timestamp consultado
Identificador Não UNIQUEIDENTIFIER Identificador do movimento
Método LinxMovimentoOrdemServicoExterna (Retorna a ordem de serviço externa da
movimentação)
Campos Tipo Descrição
id_movimento_ordem_servico_externa INT ID movimento ordem servi ço
externa
identificador UNIQUEIDENTIFIER Identificador da movimentação
codigo_ordem_servico VARCHAR (20) Código da ordem de serviço
timestamp BIGINT Timestamp da tabela
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoOrdemServicoExterna
Nome Obrigatório Tipo Descrição
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Página 111
Método LinxTradeinParceiro (Retorna os registros cadastrados na tabela tradein_parceiro do
portal )
Campos Tipo Descrição
portal INT Código do portal Microvix
id_tradein_parceiro TINYINT Código ID do parceiro no Microvix
nome_parceiro VARCHAR (100) Nome do parceiro
timestamp BIGINT Timestamp da tabela. Ex:
“185318313
Parâmetros de consulta do método LinxTradeinParceiro
Nome Obrigatório Tipo Descrição
chave Sim VARCHAR (36) Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxCategoria sFinanceira s (Retorna Categoria Financeira):
Campos Tipo Descrição
id_categorias_financeiras INT Id da categoria financeira
descricao VARCHAR(50) Descrição da categoria financeira
ativo BIT 0 – Inativo
1 – Ativo
historico BIGINT Código do Histórico do Microvix
timestamp BIGINT Timestamp da tabela. Ex:
“185318313
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxCategoria sFinanceira s
Nome Obrigatório Tipo Descrição
chave Sim VARCHAR (36) Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR ( 14) Deverá ser informado o CNPJ da loja a
ser consultado
timestamp Sim BIGINT Último Timestamp consultado
Método LinxValeOrdemServicoExterna (Retorna os dados de vale ordem de serviço externa ):
Campos Tipo Descrição
portal INT Código do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da loja
id_vale_ordem_servico_externa INT Id da tabela
Página 112
numero_controle VARCHAR (25) Número controle
timestamp BIGINT Timestamp da tabela
Parâmetros de consulta do método LinxValeOrdemServicoExterna
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxProdutosDetalhesDeposito s (Retorna os saldos dos produtos por depósito.):
Campos Tipo Descrição
portal INT Id do Portal no Microvix
cnpj_emp VARCHAR (14) CNPJ da loja
cod_produto BIGINT Código do produto
empresa INT Código da Empresa no Microvix
cod_deposito INT Código do depósito
saldo FLOAT Saldo do produto
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxProdutosDetalhesDepositos
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
cod_deposito Sim VARCHAR (MAX) Códigos dos depósitos
separados por vírgula
Método LinxSerialVenda (Retorna os registros da tabela serial_venda)
Campos Tipo Descrição
portal INT Id do Portal no Microvix
id_serial_venda INT Id da tabela serial_venda
transacao INT Código da transação na tabela movimento
codigoproduto BIGINT Código do produto no Microvix
serial VARCHAR (50) Código serial associado à venda
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
Parâmetros de consulta do método LinxSerialVenda
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Página 113
Método LinxProdutosFornec (Retorna os dados de produtos x fornecedores):
Campos Tipo Descrição
id_prod_forn INT ID da tabela
codigoproduto BIGINT Código do produto
cod_fornecedor INT Código do fornecedor
custo MONEY Preço de custo
moeda VARCHAR (10) Moeda
unidade_compra VARCHAR (50) Unidade de compra
fator_conversao_compra DECIMAL Fator de conversão
codauxiliar VARCHAR (40) Código auxiliar do produto
qtde_embalagem FLOAT Quantidade embalagem
prazo_entrega_padrao INT Prazo de entrega padrão
empresa INT Código da empresa no Microvix
desconto1 FLOAT Desconto 1
desconto2 FLOAT Desconto 2
desconto3 FLOAT Desconto 3
desconto FLOAT Desconto
ipi1 MONEY Ipi
diferencial_icms FLOAT Diferencial de ICMS
despesas1 MONEY Despesas
acrescimo MONEY Acréscimo
valor_custo_substituicao MONEY Valor custo substituição
frete1 MONEY Frete
fornecedor_principal CHAR (1) Fornecedor principal (S/N)
excluido CHAR (1) Excluído (S/N)
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxProdutosFornec :
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxComissoesVendedores (Retorna as comissões de vendedores)
Campos Tipo Descrição
vendedor INT Código do vendedor no Microvix
empresa INT Número da empresa no Microvix
data_origem DATETIME Data da venda
valor_base FLOAT Valor base
valor_comissao FLOAT Valor da comissão
cancelado CHAR (1) Cancelado (S/N)
disponivel CHAR (1) Disponível (S/N)
timestamp BIGINT Timestamp da tabela
portal INT Id do código do portal no Microvix
Página 114
Parâmetros de consulta do método LinxComissoesVendedores
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Obs: Serão retornados 10000 registros por consulta.
Método LinxFaturasOrigem (Retorna as faturas de origem do portal)
Campos Tipo Descrição
codigo_fatura BIGINT Código da fatura
codigo_fatura_origem BIGINT Código da fatura origem
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxFaturasOrigem
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMotivoDesconto (Retorna os motivos de desconto cadastrados no portal
Campos Tipo Descrição
id_motivo_desconto INT ID motivo desconto
desc_motivo_desconto VARCHAR (60) Descrição motivo desconto
ativo BIT Ativo (1 – Sim / 0 – Não)
excluido BIT Excluído (1 – Sim / 0 – Não)
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMotivoDesconto
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxPosicaoOsRamoOptico (Retorna o cadastro da posição da OS do Ramo Optico)
Campos Tipo Descrição
id_posicao_os_ramo_optico SMALLINT ID da tabela
descricao VARCHAR (50) Descrição
codigo_status_padrao TINYINT Código
ativo BIT Ativo (1 - Sim ou 0 - Não)
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Página 115
Parâmetros de consulta do método LinxPosicaoOsRamoOptico
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOrdensServico (Retorna as ordens de serviço)
Campos Tipo Descrição
numero_os INT ID da tabela
empresa INT Empresa no portal
data_os SMALLDATETIME Data da OS
data_envio_laboratorio SMALLDATETIME Data de envio para
laboratório
cancelado CHAR (1) Cancelado (S - Sim ou N -
Não)
id_laboratorio INT Id do laboratório
id_posicao_os_ramo_optico SMALLINT ID da posição da OS ramo
óptico
compartilhar_hub_laboratorios BIT Compartilhar HUB
laboratórios
cod_cliente_os INT Código do cliente
cod_vendedor INT Código do vendedor
numero_sequencial_antecipacao_financeira INT Número sequencial da
antecipação financeira
chave_nfe_laboratorio VARCHAR (44) Chave Nfe laboratório
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no
Microvix
Parâmetros de consulta do método LinxOrdensServico
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOrdensServicoProdutos (Retorna os produtos das ordens de serviço)
Campos Tipo Descrição
numero_os INT Número da OS
cod_produto_serv BIGINT Código do produto
id_ordservprod INT ID da ordem serviço de
produção
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no
Microvix
Página 116
Parâmetros de consulta do método LinxOrdensServicoProdutos
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOrdensServicoPosicaoOsRamoOpticoHistorico (Retorna o histórico das posições
das ordens de serviço do ramo optico)
Campos Tipo Descrição
id_ordens_servico_posicao_os_ramo_optico_historico INT ID da tabela
numero_os INT Número da OS
usuario INT Id do usuário
timestamp BIGINT Timestamp da tabela.
Ex: “185318313”
id_posicao_os_ramo_optico SMALLINT ID da posição da OS
ramo óptico
data SMALLDATETIME Data
observacao VARCHAR(200) Observação
portal INT Código do Portal no
Microvix
Parâmetros de consulta do método LinxOrdensServicoPosicaoOsRamoOpticoHistorico
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxPagamentoParcialDav (Retorna os pagamentos parciais da DAVs)
Campos Tipo Descrição
id_vendas_pos INT ID da tabela
valor MONEY Valor
ajuste_valor_desc_acresc_plano MONEY Ajuste de valor de desconto ou acrescimo
do plano
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
id_pagamento_parcial_tmp INT ID do pagamento
plano INT ID do plano de pagamento
forma_pgto VARCHAR (50) Nome da forma de pagamento
valor MONEY Valor
id_bandeira TINYINT ID da bandeira do cartão
qtde_parcelas TINYINT Quantidade de parcelas
credito_debito CHAR (1) C = Crédito ou D = Débito
portal INT Código do Portal no Microvix
Página 117
Parâmetros de consulta do método LinxPagamentoParcialDav
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxMovimentoCamposAdicionais (Retorna os campos adicionais da movimentação)
Campos Tipo Descrição
transacao INT Transação da venda
id_ordservprod INT ID da ordem serviço de produção
paciente VARCHAR (100) Paciente
codigo_gerencial VARCHAR (40) Código gerencial
timestamp BIGINT Timestamp da tabela. Ex: “185318313”
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxMovimentoCamposAdicionais
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOrdemServicoExternaDav (Retorna as ordens de serviço externas das DAVs)
Campos Tipo Descrição
id_vendas_pos_tmp_ordem_servico_externa INT ID da tabela
id_vendas_pos BIGINT ID da venda
codigo_ordem_servico_externa VARCHAR (20) Código da ordem de serviço
externa
timestamp BIGINT Timestamp da tabela. Ex:
“185318313”
portal INT Id do código do portal no
Microvix
Parâmetros de consulta do método LinxOrdemServicoExternaDav
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxB2CPedidos (Retorna os pedidos de B2C)
Campos Tipo Descrição
id_pedido INT Código do pedido
dt_pedido SMALLDATETIME Data do pedido
cod_cliente_erp INT Código do cliente no Microvix
cod_cliente_b2c INT Código do cliente no B2C
Página 118
vl_frete FLOAT Valor do frete
forma_pgto INT Forma de pagamento
plano_pagamento INT Plano de pagamento
anotacao VARCHAR (400) Observação do pedido
taxa_impressao FLOAT Taxa de impressão do pedido
finalizado BIT Indica se o pedido foi finalizado
valor_frete_gratis FLOAT Valor do frete grátis
tipo_frete INT Identificador do tipo do frete
id_status INT Id do status do pedido
cod_transportador INT Código do transportador do pedido
tipo_cobranca_frete INT Indica o tipo de cobrança do frete do pedido
ativo BIT Indica se o pedido está ativo ou cancelado
empresa INT Indica em qual empresa o pedido será
integrado.
id_tabela_preco INT Indica o id da tabela de preço do Microvix.
valor_credito MONEY Valor de crédito utilizado como meio de
pagamento
cod_vendedor INT Código do vendedor
timestamp BIGINT Timestamp da tabela
dt_insert SMALLDATETIME Data que o pedido foi inserido no Microvix
dt_disponivel_faturamento SMALLDATETIME Data que o pedido foi disponibilizado para
faturamento no Microvix
mensagem_falha_faturamento VARCHAR(MAX) Mensagem de falha do faturamento
portal INT Número do portal
order_id VARCHAR(40) Id do pedido no Commerce Linx
fulfillment_id VARCHAR(40) Id do fulfillment no Commerce Linx
id_tipo_b2c TINYINT Indica tipo B2C
ecommerce_origem VARCHAR (200) Ecommerce origem
marketplace_loja VARCHAR(60) Marketplace do pedido
Parâmetros de consulta do método LinxB2CPedidos
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Página 119
Método LinxB2CPedidosItens (Retorna os itens dos pedidos de B2C)
Campos Tipo Descrição
id_pedido_item INT Código interno do item do pedido
id_pedido INT Código do pedido
codigoproduto BIGINT Código do produto
quantidade INT Quantidade pedida do item
vl_unitario FLOAT Valor unitário do item
timestamp BIGINT Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxB2CPedidosItens
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxB2CStatus (Retorna o cadastro dos status de B2C)
Campos Tipo Descrição
id_status TINYINT Código interno do valor do cadastro de
status efetuado no ERP
descricao_status VARCHAR (30) Descrição do status cadastrado no ERP
timestamp BIGINT Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxB2CStatus
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxB2CPedidosStatus (Retorna o status dos pedidos de B2C)
Campos Tipo Descrição
id INT Código interno do valor do cadastro de
status efetuado no ERP
id_status TINYINT Chave estrangeira com a tabela status
id_pedido INT Chave estrangeira com a tabela de pedidos
data_hora DATETIME Data e hora em que o status do pedido foi
alterado no ERP
Página 120
anotacao VARCHAR (80) Anotação anexada à troca de status no ERP
timestamp BIGINT Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxB2CPedidosStatus
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOticoPrismaDescricao (Retorna descrição de prismas óticos)
Campos Tipo Descrição
id_otico_prisma_descricao TINYINT Id da tabela
descricao VARCHAR (1 0) Descrição do prisma
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxOticoPrismaDescricao
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOticoReceitas (Retorna as receitas óticas importadas no sistema)
Campos Tipo Descrição
id_otico_receitas INT Id da tabela
cod_cliente INT Cliente da Receita
codigoproduto BIGINT Código do Produto
lng_esferico_od MONEY Esférico Longe Olho Direito
lng_cilindrico_od MONEY Cilindrico Longe Olho Direito
lng_eixo_od MONEY Eixo Longe Olho Direito
lng_dpdpn_od MONEY DNP (Distância Naso Pupilar) Longe Olho
Direito
lng_altura_od MONEY Altura Longe Olho Direito
prt_esferico_od MONEY Esférico Perto Olho Direito
prt_cilindrico_od MONEY Cilindrico Perto Olho Direito
prt_eixo_od MONEY Eixo Perto Olho Direito
Página 121
prt_dpdpn_od MONEY DNP (Distância Naso Pupilar) Perto Olho
Direito
lng_esferico_oe MONEY Esférico Longe Olho Esquerdo
lng_cilindrico_oe MONEY Cilindrico Longe Olho Esquerdo
lng_eixo_oe MONEY Eixo Longe Olho Esquerdo
lng_dpdpn_oe MONEY DNP (Distância Naso Pupilar) Longe Olho
Esquerdo
lng_altura_oe MONEY Altura Longe Olho Esquerdo
prt_esferico_oe MONEY Esférico Perto Olho Esquerdo
prt_cilindrico_oe MONEY Cilindrico Perto Olho Esquerdo
prt_eixo_oe MONEY Eixo Perto Olho Esquerdo
prt_dpdpn_oe MONEY DNP (Distância Naso Pupilar) Perto Olho
Esquerdo
lng_adicao_od MONEY Adição Longe Olho Direito
lng_adicao_oe MONEY Adicao Longe Olho Esquerdo
otico_lado_lente VARCHAR(1 5) Lado da lente na receita
diametro_od MONEY Diametro Olho Direito
diametro_oe MONEY Diametro Olho Esquerdo
ponte MONEY Ponte da Armação
altura MONEY Altura da Armação
aro MONEY Medida do Aro da Armação
diag_maior MONEY Diagonal Maior da Armação
tipo_armacao VARCHAR(100) Tipo de Armação (Metal, acetato, Fio de
Nylon...)
observacao VARCHAR(100) Observação da receita
paciente VARCHAR(100) Nome do Paciente/Receita
cmpl_add_od MONEY Adição Olho Direito
cmpl_add_oe MONEY Adição Olho Esquerdo
base_od MONEY Base Olho Direito
base_oe MONEY Base Olho Esquerdo
dist_haste MONEY Distância entre as Hastes/Tamanho da
Haste da Armação
dist_front MONEY Distância Frontal da Armação
curvatura MONEY Curvatura da Armação
lng_pris1_od MONEY Prisma 1 Longe Olho Direito
id_lng_pris1_od_desc TINYINT Id da Descrição Prisma 1 Longe Olho
Direito
lng_pris1_oe MONEY Prisma 1 Longe Olho Esquerdo
Página 122
id_lng_pris1_oe_desc TINYINT Id da Descrição Prisma 1 Longe Olho
Esquerdo
prt_pris1_od MONEY Prisma 1 Perto Olho Direito
id_prt_pris1_od_desc TINYINT Id da Descrição Prisma 1 Perto Olho
Direito
prt_pris1_oe MONEY Prisma 1 Perto Olho Esquerdo
id_prt_pris1_oe_desc TINYINT Id da Descrição Prisma 1 Perto Olho
Esquerdo
lng_pris2_od MONEY Prisma 2 Longe Olho Direito
id_lng_pris2_od_desc TINYINT Id da Descrição Prisma 2 Longe Olho
Direito
lng_pris2_oe MONEY Prisma 2 Longe Olho Esquerdo
id_lng_pris2_oe_desc TINYINT Id da Descrição Prisma 2 Longe Olho
Esquerdo
prt_pris2_od MONEY Prisma 2 Perto Olho Direito
id_prt_pris2_od_desc TINYINT Id da Descrição Prisma 2 Perto Olho
Direito
prt_pris2_oe MONEY Prisma 2 Perto Olho Esquerdo
id_prt_pris2_oe_desc TINYINT Id da Descrição Prisma 2 Perto Olho
Esquerdo
dist_vertice MONEY Distância Vertice (Tecnologia)
inc_planto MONEY Inclinação Pantoscópica (Tecnologia)
ativ_princ VARCHAR(40) Atividade Principal (Tecnologia)
otico_area_privilegiada VARCHAR(1 5) Área Privilegiada
dist_visao MONEY Distância Visão (cm) (Tecnologia)
personalizada VARCHAR(100) Personalizada (Gravação Indelével)
(Tecnologia)
pris_od MONEY Prisma Olho Direito (Afinamento
Prismático)
pris_oe MONEY Prisma Olho Esquerdo (Afinamento
Prismático)
eixo_od MONEY Eixo Olho Direito (Afinamento
Prismático)
eixo_oe MONEY Eixo Olho Esquerdo (Afinamento
Prismático)
borda_od MONEY Borda Olho Direito (Espessura Mínima)
borda_oe MONEY Borda Olho Esquerdo (Espessura Mínima)
centro_od MONEY Centro Olho Direito (Espessura Mínima)
Página 123
centro_oe MONEY Centro Olho Esquerdo (Espessura
Mínima)
furo_od MONEY Furo Olho Direito (Espessura Mínima)
furo_oe MONEY Furo Olho Esquerdo (Espessura Mínima)
format_corte VARCHAR(40) Formado do Corte (Espessura Mínima)
dist_leitura VARCHAR(40) Distância Leitura (Espessura Mínima)
tipo_lente VARCHAR(100) Tipo da Lente (Monofocal, Bifocal,
Multifocal...)
endereco_paciente VARCHAR(100) Endereço do Paciente (Observações)
medico_especialista VARCHAR(100) Médico Especialista (Observações)
endereco_medico_especialista VARCHAR(100) Endereço do Médico Especialista
(Observações)
refracionista_optico VARCHAR(100) Refracionista Ótico (Observações)
data_receita SMALLDATETIME Data da Receita
id_produtos_opticos_tipo_aro INT Id do Tipo de Aro
dp_montagem MONEY DP (Distância Pupilar)
id_produtos_opticos_formato_aro INT Id do Formato do Aro da Armação
codigo_gerencial VARCHAR(40) Código Gerencial da Ordem de Serviço
migracao_dados BIT
migracao_observacao VARCHAR( MAX) Campo reservado para informações
adicionais da importação
portal INT Número do portal
timestamp TIMESTAMP Timestamp da tabela
Parâmetros de consulta do método LinxOticoReceitas
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxOrcamentoComponenteFormula (Retorna os componentes de fórmulas
relacionados ao orçamento)
Campos Tipo Descrição
id_orcamento_componente_formula INT Id da tabela
documento INT Documento do orçamento no Microvix
codigo_produto BIGINT Código do produto no Microvix
codigo_componente VARCHAR(10) Código do componente
descricao_componente VARCHAR(50) Descrição do componente
Página 124
unidade VARCHAR(5) Unidade do componente
quantidade MONEY Quantidade do componente
valor_componente MONEY Valor do componente
lote_componente VARCHAR(30) Lote do componente
data_validade_lote SMALLDATETIM
E Data de validade do lote do componente
codigo_ws VARCHAR(50) Código do registro no sistema de origem
portal INT Número do portal
timestamp TIMESTAMP Timestamp da tabela
Parâmetros de consulta do método LinxOrcamentoComponenteFormula
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxLotesProdutos (Retorna os dados dos lotes dos produtos)
Campos Tipo Descrição
id_lote INT Id da tabela
codigo_produto BIGINT Código do produto no Microvix
lote VARCHAR(60) Lote
identificador UNIQUEIDENTIFIE
R Identificador de movimento
transacao INT Transação na tabela movimento
data_fabricacao SMALLDATETIME Data de fabricação do lote
data_vencimento SMALLDATETIME Data de vencimento do lote
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxLotesProdutos
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxClientesRede (Retorna os registros da tabela clientes_rede no portal centralizador )
Nome Tipo Descrição
id_clientes_rede INT ID da tabela clientes_rede
Página 125
doc_cliente VARCHAR (14) CPF ou CNPJ do cliente. Somente
números com os zeros na frente, caso
haja.
nome_razao_social VARCHAR (60) Nome ou razão social do cliente.
data_cadastro DATETIME Data de cadastro do cliente no sistema
terceiro.
pf_pj CHAR (1) F - Pessoa física; J - Pessoa Jurídica.
tipo CHAR (1) Indica o tipo de cadastro. Valores
aceitos: C para clientes; F para
fornecedores; A para ambos, clientes e
fornecedores; e T para tranportadores.
endereco VARCHAR
(250) Endereço do cliente.
cidade VARCHAR (40) Nome da cidade do cliente
uf VARCHAR (20) Sigla do estado do endereço do cliente
pais VARCHAR (80) Nome do país
id_estado_civil SMALLINT Estado civil do cliente: 1 – Não
informado; 2 – Casado; 3 – Solteiro; 4 –
Divorciado; 5 – Viúvo; 6 – Outros.
compras_a_prazo BIT Indica se o cliente tem permissão para
comprar a prazo. 0 - Não e 1 - Sim.
aceita_boleto_bancario BIT Indica se o cliente aceita a emissão de
boleto bancário. 0 - Não e 1 -Sim.
nome_fantasia VARCHAR (60) Nome fantasia do cliente.
numero_endereco VARCHAR (20) Número do imóvel do endereço do
cliente.
complemento VARCHAR (60) Complemento do endereço do cliente.
bairro VARCHAR (60) Bairro do cliente
cep VARCHAR (9) CEP do endereço do cliente.
telefone VARCHAR (20) Nº do telefone do cliente.
celular VARCHAR (20) Nº do celular do cliente.
fax VARCHAR (50) Nº do fax do cliente.
email VARCHAR (50) E-mai do cliente.
site VARCHAR (50) Site do cliente.
data_nascimento DATETIME Data de nascimento do cliente.
naturalidade VARCHAR (40) Naturalidade do cliente
sexo CHAR (1) M - Masculino; F - Feminino.
nome_pai VARCHAR (60) Nome do pai.
nome_mae VARCHAR (60) Nome da mãe.
identidade_cliente VARCHAR (20) Nº do documento de identidade do
cliente.
data_emissao_identidade_cliente DATETIME Data de emissão do documento de
identidade do cliente.
uf_emissao_identidade_cliente CHAR (2) Sigla do estado emissor do documento de
identidade do cliente.
orgao_emissao_identidade_cliente VARCHAR (10) Órgão emissor do documento de
identidade do cliente.
observacao VARCHAR
(500) Observações do cadastro do cliente.
nome_empresa_titular VARCHAR (60) Nome da empresa onde o cliente
trabalha.
telefone_empresa_titular VARCHAR (20) Telefone da empresa onde o cliente
trabalha.
funcao_titular VARCHAR (40) Profissão ou função exercida pelo cliente.
Página 126
tempo_servico_titular VARCHAR (20) Tempo de empresa.
renda_titular MONEY Renda do cliente.
inscricao_estadual VARCHAR (20) Nº da inscrição estadual do cliente.
inscricao_municipal VARCHAR (20) Nº da inscrição municipal do cliente.
cliente_optante_simples_municipal BIT Indica se o cliente é optante do simples
municipal. 0 - Não e 1 - Sim.
cliente_optante_simples_federal BIT Indica se o cliente é optante do simples
federal. 0 - Não e 1 - Sim.
limite_compras MONEY Informa o valor para o campo Limite de
Crédito (Crediário) no cadastro de
clientes e fornecedores
cartao_fidelidade VARCHAR (20) Nº do cartão fidelidade do cliente.
desabilitado BIT Indica se o cadastro do cliente está ou
não desativado. 0 - Não e 1 Sim.
motivo_bloqueio VARCHAR (50) Descrição do motivo do bloqueio do
cadastro do cliente.
portal_origem INT Número do portal da rede onde o cliente
foi cadastrado.
empresa_origem INT Número da empresa no portal da rede
onde o cliente foi cadastrado.
cod_cliente_portal_origem INT Código do cliente no portal onde foi
cadastrado.
codigo_ws VARCHAR (14) Número do documento do cliente quando
cadastrado pelo metodo
LinxCadastraClientesRede.
integrado_ws BIT Indica se o cadastro foi realizado pelo
método LinxCadastraClientesRede. 0 -
Não e 1 - Sim.
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxClientesRede
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxFechamentoCaixa (Retorna os dados do fechamento de caixa)
Campos Tipo Descrição
empresa INT Empresa
data DATETIME Data do fechamento
usuario CHAR(10) Usuario
qtd_001 INT Quantidade 0.01
qtd_005 INT Quantidade 0.05
qtd_010 INT Quantidade 0.10
qtd_025 INT Quantidade 0.25
qtd_050 INT Quantidade 0.50
qtd_1 INT Quantidade 1
qtd_2 INT Quantidade 2
qtd_5 INT Quantidade 5
qtd_10 INT Quantidade 10
qtd_20 INT Quantidade 20
qtd_50 INT Quantidade 50
qtd_100 INT Quantidade 100
Página 127
qtd_200 INT Quantidade 200
total_geral MONEY Total geral
obs TEXT Observação
total_c_vista MONEY Total a vista
total_c_prazo MONEY Total a prazo
total_cartao MONEY Total cartao
total_convenio MONEY Total convênio
total_crediario MONEY Total crediario
total_giftcard MONEY Total giftcard
total_qr_linx MONEY Total QR linx
total_cartao_credito MONEY Total cartao credito
total_cartao_debito MONEY Total cartao debito
total_pix MONEY Total pix
total_link_pagamento MONEY Total link pagamento
total_link_pagamento_credito MONEY Total link pagamento credito
total_link_pagamento_debito MONEY Total link pagamento debito
total_vale_compra MONEY Total vale compra
vale_compras_dev MONEY Vale compras
sangria MONEY Sangria
suprimentos MONEY Suprimento
ativo BIT Ativo
conferencia_efetuada BIT Conferência efetuada
timestamp TIMESTAMP Timestamp da tabela
portal INT Id do código do portal no Microvix
Parâmetros de consulta do método LinxFechamentoCaixa
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxAcoesPromocionaisProdutosCortesia (Retorna os produtos de cortesia de ações
promocionais)
Campos Tipo Descrição
id_acoes_promocionais_produtos_cortesia INT Id da tabela
id_acoes_promocionais INT Id da ação promocional
codigoproduto BIGINT Código do produto no Microvix
id_combinacao_produto INT Id da combinação do produto ação
promocional
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxAcoesPromocionaisProdutosCortesia
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Página 128
Método LinxAcoesPromocionaisCombinacaoProdutosItens (Retorna os itens da combinação
de produtos de ações promocionais)
Campos Tipo Descrição
id_acoes_promocionais_combinacao_produtos_itens INT Id da tabela
id_combinacao_produto INT Id da combinação do
produto ação promocional
codigoproduto BIGINT Código do produto no
Microvix
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxAcoesPromocionaisCombinacaoProdutosItens
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxProdutosInformacoes Retorna informações dos produtos (características)
Campos Tipo Descrição
codigoproduto BIGINT Código do produto no Microvix
informacoes_produto VARCHAR(MAX) Informações do produto (características).
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxProdutosInformacoes
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
OBS: como o campo informacoes_produto pode possuir tags HTML, no retorno haverá a
substituição de caracteres, conforme abaixo:
< por <
> por >
Página 129
Método LinxFreteTipos (Retorna os dados dos tipos de fretes )
Campos Tipo Descrição
id_frete_tipos INT Id da tabela
descricao VARCHAR(40) Descrição do tipo de frete
codigo_sped INT Código Sped
codigo_nfe INT Código NF -e Frete (vide observação)
codigo_sintegra INT Código Sintegra
permite_valor BIT 1-Sim, 0 -Nao
ativo BIT Indica se está ativo
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxFreteTipos
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxNfeIbgeMunicipio (Retorna dados do IBGE sobre municípios. )
Campos Tipo Descrição
id_nfe_ibge_municipio SMALLINT Id da tabela
cod_ibge_municipio INT Código IBGE do município
nome VARCHAR(60) Nome do município
cod_ibge_uf SMALLINT Código IBGE da UF
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxNfeIbgeMunicipio
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxConhecimentoFretes (Retorna dados de conhecimento de fretes. )
Campos Tipo Descrição
id_conhecimento INT Id da tabela
transportador INT ID Transportador CRM Microvix
valor_frete MONEY Valor Frete
Página 130
conhecimento INT Número conhecimento
serie_frete VARCHAR(10) Serie do CT -e
tipo_frete CHAR ID tipo frete (vide observação)
vencto_frete SMALLDATETIME Data vencimento do Frete
valor_total_notas MONEY Valor total das notas
valor_lancado MONEY Valor lançado
data_emissao SMALLDATETIME Data emissão do CT -e
data_entrada SMALLDATETIME Data de entrada do CT -e
cfop CHAR Cfop
aliq_icms MONEY Alíquota ICMS
empresa INT ID empresa no Microvix
base_calculo_icms MONEY Base de cálculo ICMS
id_cfop_fiscal SMALLINT ID que representa a CFOP (Código Fiscal da
Operação Fiscal)
id_modelo_nf INT Id modelo NF
id_cte_tipo SMALLINT ID CT -e tipo (vide observação)
valor_icms MONEY Valor ICMS
valor_pis MONEY Valor Pis
valor_cofins MONEY Valor COFINS
chave_cte VARCHAR(44) Chave CT -e
regime_pis_cofins CHAR Regime tributário
base_pis MONEY Base Pis
base_cofins MONEY Base COFINS
usuario INT Id usuário Microvix
id_cst_icms_fiscal SMALLINT ID que representa a CST (Código da
Situação Tributária)
id_nfe_ibge_municipio_origem SMALLINT Id do cadastro de NF -e IBGE Município para
origem
id_nfe_ibge_municipio_destino SMALLINT Id do cadastro de NF -e IBGE Município para
destino
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxConhecimentoFretes
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Página 131
OBS1: Método LinxFreteTipos
- Campo codigo_nfe = ID do código NFe conforme print abaixo.
OBS2: Método LinxConhecimentoFretes
- Campo id_cte_tipo retorna os códigos conforme print abaixo:
Método LinxPlanosParcelas (Retorna as parcelas vinculadas ao plano de pgto)
Campos Tipo Descrição
plano INT Código do plano de pagamento
ordem_parcela INT Ordem de pagamento de cada parcela
prazo_parc INT Prazo de pagamento entre as parcelas
id_planos_parcelas INT Código da parcela do plano de pagamento
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxPlanosParcelas
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Página 132
Método LinxComponenteFormulaDav (Retorna os componentes de fórmulas relacionados ao
Dav)
Campos Tipo Descrição
id_componente_formula_dav INT Id da tabela
codigo_sistema_terceiro INT Documento do orçamento no Microvix
codigo_produto BIGINT Código do produto no Microvix
codigo_componente VARCHAR(10) Código do componente
descricao_componente VARCHAR(50) Descrição do componente
unidade VARCHAR(5) Unidade do componente
quantidade MONEY Quantidade do componente
valor_componente MONEY Valor do componente
lote_componente VARCHAR(30) Lote do componente
data_validade_lote SMALLDATETIME Data de validade do lote do componente
codigo_ws VARCHAR(50) Código do registro no sistema de origem
portal INT Número do portal
timestamp TIMESTAMP Timestamp da tabela
Parâmetros de consulta do método LinxComponenteFormulaDav
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxClientesEnderecosEntrega (Retorna endereço de entrega do cliente)
Campos Tipo Descrição
id_endereco_entrega INT Código interno do endereço de entrega do
cliente
cod_cliente INT Código do cliente no Microvix ERP
endereco_cliente VARCHAR(250) Nome da rua do cliente
numero_rua_cliente VARCHAR(20) Número da residência do cliente na rua
complemento_end_cli VARCHAR(60) Complemento do endereço do cliente
cep_cliente CHAR(9) CEP do cliente
bairro_cliente VARCHAR(60) Bairro do cliente
cidade_cliente VARCHAR(40) Cidade do cliente
uf_cliente CHAR(2) Estado do cliente
descricao VARCHAR(250) Descrição do endereço de entrega do
cliente
Página 133
principal BIT Indica se o endereço do cliente é o
principal utilizado para as entregas da
loja
fone_cliente VARCHAR(20) Número do telefone do cliente
fone_celular VARCHAR(20) Número do celular do cliente
timestamp BIGINT Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxClientesEnderecosEntrega
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxUsuarios (Retorna os usuários do Microvix)
Campos Tipo Descrição
usuario_id INT Id do usuário
usuario_login VARCHAR(30) Login do usuário
usuario_nome VARCHAR(50) Nome do usuário
usuario_email VARCHAR(60) Email do usuário
portal INT Número do portal
usuario_grupo_id INT ID do grupo a que pertence (0 indica sem
grupo)
grupo_usuarios CHAR(1) Indica se é um grupo de usuários
usuario_supervisor CHAR(1) Indica se é usuário supervisor
usuario_doc VARCHAR(14) Documento do usuário
vendedor INT Código do vendedor associado
data_criacao SMALLDATETIME Data de criação do usuário
desativado CHAR(1) Indica se o usuário está desativado
empresas VARCHAR(MAX) Empresas/lojas em que o usuário tem
acesso
timestamp BIGINT Timestamp da tabela
Parâmetros de consulta do método LinxUsuarios
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
timestamp Sim BIGINT Último Timestamp consultado
Página 134
Método LinxProdutosImagensURL (Retorna as URLs das imagens dos produtos)
Campos Tipo Descrição
codigoproduto BIGINT Código do produto
url_imagem_blob VARCHAR(200) URL da imagem
timestamp BIGINT Timestamp da tabela
portal INT Número do portal
id_imagem INT Id da imagem
Parâmetros de consulta do método LinxProdutosImagensURL
Nome Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso ao Webservice
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Último Timestamp consultado
Método LinxVendasPosAgrupamentoTmp (Retorna os registros da tabela
vendas_pos_agrupamento_tmp.)
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_vendas_pos_agrupamento_tmp INT ID da tabela vendas_pos_agrupamento_tmp
id_vendas_pos BIGINT ID da tabela vendas_pos
id_vendas_pos_origem BIGINT ID da tabela vendas_pos origem
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxVendasPosAgrupamentoTmp
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEID
ENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR
(14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxVendasPosTmp (Retorna os registros da tabela vendas_pos_tmp )
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_vendas_pos BIGINT ID na tabela vendas_pos
numero_ficha BIGINT Número da ficha
numero_sequencial INT Número sequencial
cod_cliente INT Código do cliente
data_lcto SMALLDATETIME Data de lancamento
empresa INT Id da empresa no Microvix
cliente_indicador INT Código do cliente indicador
Página 135
observacao_dav VARCHAR(4000) Observação DAV
observacao VARCHAR(500) Observação
codigo_sistema_terceiro INT Código do sistema terceiro
cancelado BIT Indica se o o registro está cacelado. Sendo 0 Não e
1 Sim.
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxVendasPosTmp
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxRegistroProfissional (Retorna os registros da tabela tipo_registro_profissional )
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_tipo_registro_profissional INT ID do registro no Microvix
descricao_tipo_registro_profissional VARCHAR (100) Descrição do tipo de registro profissional
ativo BIT Indica se o registro está ativo. 0 - Não e
1 - Sim
excluido BIT Indica se o registro foi excluído. 0 - Não e
1 - Sim
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxRegistroProfissional
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxClientesFornecVendedores (Retorna o código do vendedor associado ao cadastro
do cliente, conforme a tabela clientes_fornec_vendedores. )
Nome Tipo Descrição
portal INT Número do portal no Microvix
cod_cliente INT Código do cliente
cod_vendedor INT Código do vendedor
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxClientesFornecVendedores
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Página 136
Método LinxExtratoBancarioLancamentos (Retorna os top 10000 registros da tabela
extrato_bancario_lancamentos ordenados pelo campo timestamp )
Nome Tipo Descrição
portal INT Código do portal no Microvix
id_extrato_bancario_lancamentos INT Código do lançamento no Microvix
codigo_banco VARCHAR(4) Código do banco
numero_conta VARCHAR(20) Código da conta
id_conta BIGINT Código da conta no Microvix
valor MONEY Valor total das faturas conciliadas
descricao VARCHAR(100) Descrição do lançamento
data_lancamento SMALLDATETIME Data da Conciliação
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxExtratoBancarioLancamentos
Campos Obrigatório Tipo Observações
Chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxExtratoBancarioConciliacoes ((Retorna os top 10000 registros da tabela
extrato_bancario_lancamentos ordenados pelo campo timestam p)
Nome Tipo Descrição
portal INT Código do portal no Microvix
id_extrato_bancario_conciliacoes INT Código da conciliação no Microvix
id_extrato_bancario_lancamentos INT Código do lançamento no Microvix
codigo_fatura BIGINT Código da fatura no Microvix
dados_anteriores_baixa_fatura VARCHAR(MAX) Dados da fatura
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxExtratoBancarioConciliacoes
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxHistoricosContabeis (Retorna os dados dos históricos contábeis)
Nome Tipo Descrição
id_historico BIGINT Id da tabela
nome_historico VARCHAR(50) Nome descritivo do histórico.
conta_credito BIGINT Código da conta cont ábil de crédito.
conta_debito BIGINT Código da conta cont ábil de débito.
Página 137
tipo_rateio CHAR(1) N = nenhum, F = fixo, V = variável
inativo CHAR(1) Determina se o histórico da conta
está ativo, S - sim, N - não.
operacao CHAR(1) Determina se é entrada ou saída, E -
entrada , S - saída.
historico_contabil INT Código do histórico cont ábil.
somente_gerencial BIT Definir se o histórico é somente
gerencial.
obrigatorio_insercao_anexo_sangria BIT Código do registro no sistema de
origem
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxHistoricosContabeis
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxPortadores (Retorna os dados dos portadores)
Nome Tipo Descrição
cod_portador INT Código do portador.
nome_portador VARCHAR(50) Nome do portador.
taxa_acrescimo MONEY Taxa de acrescimo do portador.
aviso_vencimento BIT Defini se será enviado e -mail de aviso de
vencimento 1 dia antes do vencimento para
faturas que estejam neste portador.
reaviso_vencimento BIT Defini se será enviado e -mail de reaviso de
vencimento 1 dia depois do vencimento para
faturas que estejam neste portador.
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Parâmetros de consulta do método LinxPortadores
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxPedidosCompraStatus (Retorna os status de pedidos de compra)
Nome Tipo Descrição
id_compras_pedido_status INT Id do status do pedido de compra
descricao VARCHAR(50) Descrição do status
ativo BIT Define se o status está ativo ou não
timestamp TIMESTAMP Timestamp da tabela
portal INT Número do portal
Página 138
Parâmetros de consulta do método LinxPedidosCompraStatus
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxDesfazimentosAntecipacoes (Retorna os registros da tabela
desfazimentos_antecipacoes.)
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_desfazimentos_antecipacoes INT ID da tabela desfazimentos_antecipacoes
id_antecipacoes_financeiras INT ID da tabela antecipacoes_financeiras
data_desfazimento SMALLDATETIME Data do desfazimento
valor_dasfazimento MONEY Número do portal
valor_acerto MONEY Valor do desfazimento
tipo_acerto INT Valor do acerto
observacoes VARCHAR(MAX) Observações
usuario INT ID do usuario que realizou o desfazimento
timestamp BIGINT Timestamp da tabela. Exemplo: “185318313”
Parâmetros de consulta do método LinxDesfazimentosAntecipacoes
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxDesfazimentosAntecipacoes Itens (Retorna os registros da tabela
desfazimentos_antecipacoes _itens .)
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_desfazimentos_antecipacoes_itens INT ID da tabela
desfazimentos_antecipacoes _itens
id_desfazimento_antecipacoes INT ID da tabela desfazimento_antecipacoes
numero_squencial INT Número sequencial
ordem INT Ordem
identificador UNIQUEIDENTIFIER Identificador
preco MONEY Preço
quantidade MONEY Quantidade
desconto MONEY Desconto
Página 139
valor MONEY Valor
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxDesfazimentosAntecipacoes Itens
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Método LinxDesfazimentosAntecipacoes Documento (Retorna os registros da tabela
desfazimentos_antecipacoes _documento .)
Nome Tipo Descrição
portal INT Número do portal no Microvix
id_documento_desfazimento_optico INT ID da tabela
documento_ desfazimento_ optico
empresa INT ID da empresa no portal Microvix
id_desfazimento_antecipacoes INT ID da tabela desfazimentos_antecipacoes
id_antecipacoes_financeiras INT ID da tabela antecipacoes_financeiras
cfop CHAR(10) ID da Natureza de Operação
cod_cliente INT ID do cadastro do cliente no Microvix
valor_operacao_nao_desfeita MONEY Valor Desfazimento
texto_descricao_desfazimento VARCHAR(MAX) Descrição do desfazimento
timestamp BIGINT Timestamp da tabela. Exemplo:
“185318313”
Parâmetros de consulta do método LinxDesfazimentosAntecipacoes Documento
Campos Obrigatório Tipo Observações
chave Sim UNIQUEIDENTIFIER Chave de acesso
cnpjEmp Sim VARCHAR (14) CNPJ da empresa para consulta
timestamp Sim BIGINT Maior timestamp retornado na última consulta
Página 140
6. Exemplo de Estrutura do Método de Saída
<?xml version="1.0" encoding="utf -8" ?>
<LinxMicrovix>
<Authentication user="linx_export" password="linx_export" />
<ResponseFormat>xml</ResponseFormat>
<IdPortal>12345</IdPortal>
<Command>
<Name>LinxMovimento</Name>
<Parameters>
<Parameter id="chave">7d73503f -db26-4112-ac66-94033ac4986P</Parameter>
<Parameter id="cnpjEmp">9876545678996</Parameter>
<Parameter id="data_inicial">2021 -07-28</Parameter>
<Parameter id="data_fim">2021 -07-29</Parameter>
<Parameter id="timestamp">0</Parameter>
</Parameters>
</Command>
</LinxMicrovix>
7. Restrições
• No método que retorna o estoque, somente serão fornecidos os registros de produtos com
saldo diferente de zero.
• No método (LinxProdutosDetalhes ) que retorna a quantidade de estoque , o saldo de
estoque de produtos será somente o atual , no momento da chamada ;
• O cliente necessita ter em sua estrutura equipe especializada em infraestrutura/manutenção
de WebService e XML.
• A Linx Microvix não fara nenhum tratamento nos dados fornecidos via WebService;
• O cliente necessita ter em sua estrutura uma base local para armazenar as
informações extraídas dos métodos do WebService. Assim terá muito mais
agilidade em informações históricas e garante a performance da API, pois poderá
consultar via WebService, apena s os dados que tiveram atualizações ou foram
inclusos desde o último Timestamp.
• TIMESTAMP : O timestamp no SQL Server é um contador de operações, sendo assim
qualquer alteração que seja realizada no banco irá alterar o timestamp do dado na tabela.
Nós utilizamos esta informação como filtro, para que sempre sejam exportados apenas os
dados atual izados. Quando é feita uma carga inicial o timestamp será 0 e o último timestamp
retornado nesta consulta deve ser armazenado, pois na próxima consulta ele deverá ser
informado na chamada, e então só serão exportados os dados com timestamp maior, ou
seja, os que tiveram alteração. O timestamp não é padrão UNIX.
Página 141
8. Benefícios
• Acesso em tempo real a estrutura de dados do MicrovixERP em qualquer loja de um portal
(podendo estar até dentro de um grupo econômico ou rede de franquias );
• Acesso de qualquer lugar a API do WebService MicrovixERP;
• Segurança, onde qualquer WebService é restrito com usuário , senha e chave ;
• Documentação de utilização da API do WebService;
• Atualização de melhorias automaticamente (sem comunicado prévio );
9. Documentação dos métodos
A documentação atualizada dos métodos estará sempre disponível no link abaixo .
• https://share.linx.com.br/x/ziINCg
10. Homologação
Atividade Data
Entrega da Chave XX/XX/XXXX
Homologação XX/XX/XXXX a XX/XX/XXXX*
*Após a data inicial de homologação consideramos um período de 30 dias de
acompanhamento. Após este período o atendimento será via suporte Microvix.
Pontos importantes:
Está incluído nesta etapa de homologação/apoio as seguintes atividades:
1. Apoio exclusivo a dúvidas sobre os métodos e campos da especificação e que não esteja já
respondida neste documento;
2. Verificação pontual quando necessário na base de dados da loja, somente dentro do
período de homologação;
3. Os testes serão feitos no aplicativo Postman e não será utilizado nenhum outro aplicativo
para verificação de conexão ao WebService Linx.
Não está incluído nesta etapa de homologação/apoio as seguintes atividades:
1. Apresentação ou Treinamento d e algum módulo d o MicrovixERP ou integração com o
WebService;
Página 142
2. Apoio ou consultoria no formato como será feito as conexões com o WebService;
3. Apoio ou consultoria em linguagens de programação ou estruturas de programação para
conexão ou consumo dos métodos e campos deste WebService;
4. Criação de documentos extras específicos ou fluxogramas que envolvam o processo de
uma integração .
11. Ativação do serviço
Processo Horas
Taxa de Ativação de Serviço 20 horas
12. Manutenção
Será cobrada uma taxa de manutenção mensal, para o custo com a manutenção da integração e
infraestrutura do WebService.
13. Condição Comercial
Processo Esforço Condição Valor
OS 20 Horas A vista R$
Manutenção Conforme
negociação
comercial
*Para contratar o serviço é necessário entrar em contato com seu Gerente de
Relacionamento. Chat – https://cliente.linx.com.br/livechat/
Abertura de chamados – https://cliente.linx.com.br/webchamados/
Telefones: 3003-6632 / 0800 -718-6632
Horário de atendimento:
De segunda à sexta 08:30h às 22:00h (Após 18:00h apenas faturamento parado)
Sábados – 09:00h às 22:00h
Domingos e Feriados nacionais – 10:00h às 20:00h (exceto dias 25/12 e 01/01) a.
Página 143
14. Aceite
Estando de acordo com a condição comercial e especificações indicadas neste documento,
autorizamos a Linx Sistemas a prosseguir com a Ordem de Serviço.
Data de aprovação: ______/_______/_______
________________________________ _____________________________
Responsável Cliente Assinatura
15. Controle de revisão
Revisão Data Histórico das revisões Revisado por
1 27/09/2016 Criação do Documento Thiago Rochadel
2 18/10/2016 Coluna de Tipo e Tamanho dos campos Thiago Rochadel
3 23/10/2016 Inclusão do método Lançamento Contábil Thiago Rochadel
4 12/02/2017 Inclusão do método de Trocas Thiago Rochadel
5 21/02/2017 Melhoria nos Métodos de Produtos e ProdutosDetalhes Thiago Rochadel
6 03/04/2017 Inclusão dos Métodos de Seriais, Ações Promocionais
e Planos de Pagamentos Thiago Rochadel
7 19/04/2017 Inclusão do método de documentos de origem de uma
devolução Thiago Rochadel
8 02/05/2017 Inclusão dos métodos de Pedido de Venda e Compra Thiago Rochadel
9 22/06/2017 Inclusão dos métodos de Campos Adicionais, Planos
de pagamentos de pedidos e Redução Z Thiago Rochadel
10 13/09/2017 Inclusão do método de campos Adicionais de Produtos Thiago Rochadel
11 14/12/2017 Inclusão dos métodos de Metas de Vendedores,
Configuração Tributária e o seu Detalhamento Thiago Rochadel
12 16/03/2018 Inclusão dos métodos de Lista da Vez e Planos de
Pagamento Thiago Rochadel
13 11/04/2018 Inclusão do método de saldo de inventário Thiago Rochadel
Página 144
Revisão Data Histórico das revisões Revisado por
14 14/05/2018 Inclusão do método de contatos de clientes Thiago Rochadel
15 07/06/2018 Inclusão do método de cadastro de depósitos Thiago Rochadel
16 11/09/2018 Inclusão dos métodos de Trocafone e Produtos em
Promoção Thiago Rochadel
17 29/11/2018 Inclusão do método de Planos por Bandeira e
Adquirente Thiago Rochadel
18 06/02/2019 Inclusão dos métodos Serviços e ServiçosDetalhes Christhian S.
Stoever
19 06/052019 Inclusão do timestamp, nos métodos que não o
possuíam.
Adição do método
LinxClientesFornecContatosParentesco Christhian S.
Stoever
20 21/06/2019 Inclusão método LinxClientesFornecClasses Laysa Senderski
21 09/07/2019 Inclusão campo posição_item no método
LinxPedidosVenda Laysa Senderski
22 16/07/2019 Inclusão método LinxXMLDocumentos Christhian S.
Stoever
23 07/08/2019 Inclusão do campo 144onversão _origem no Método
LinxPedidosVenda Christhian S.
Stoever
24 12/08/2019 Inclusão do método LinxMovimentoCartoes Roney Kuntz
25 02/09/2019 Inclusão de campos LinxMovimento,
144onver _cliente e cod_produto Roana de Mello
26 04/09/2019 Inclusão de filtros LinxMovimento e
LinxMovimentoOrigemDevoluções (documento e
nota_origem) Roana de Mello
27 09/10/2019 Inclusão do método LinxClientesFornecCreditoAvulso Roana de Mello
28 14/10/2019 LinxProdutosDetalhes (adição dos campos:
qtde_minima, qtde_maxima, ipi) e LinxProdutos
(adição do campo: fator_conversao) Roney Kuntz
29 23/10/2019 Incluído o item 7 Homologação Roana de Mello
30 25/10/2019 Inclusão do campo Id Sangria e Suprimentos no
método LinxSangriaSuprimentos Roana de Mello
31 08/11/2019 Inclusão do campo identificador no método
LinxClientesFornecCreditoAvulso Roana de Mello
Página 145
Revisão Data Histórico das revisões Revisado por
32 11/11/2019 Inclusão dos campos nProtCanc, nProtInut,
xmlDistribuicao e nProtDeneg no método
LinxXMLDocumentos Roana de Mello
33 19/11/2019 Inclusão do método LinxMovimentoExtensao Roana de Mello
34 19/11/2019 Inclusão do campo cStat no método
LinxXMLDocumentos e inclusão do novo método
LinxMotivoDevolucao Roana de Mello
35 20/11/2019 Inclusão do campo cnpjEmp no método
LinxClientesFornecCreditoAvulso Roana de Mello
36 04/12/2019 Inclusão do método LinxMovimentoDevoluçõesItens Roana de Mello
37 04/12/2019 Inclusão do método LinxFidelidade Roney Kuntz
38 04/12/2019 Inclusão do campo acréscimo no método
LinxMovimento Roana de Mello
39 17/12/2019 Inclusão do campo e filtro timestamp no método
LinxClientesFornec Roana de Mello
40 18/12/2019 Inclusão do campo tipo_tabela no método
LinxProdutosTabelas Danubia Gattis
41 20/12/2019 Inclusão do campo mob_checkout no método
LinxMovimento Roana de Mello
42 06/01/2020 Inclusão do campo sigla_empresa no método
LinxLojas Roney Kuntz
43 23/01/2020 Inclusão dos métodos: LinxProdutosOpticosTipoAro,
LinxProdutosOpticosFormatoAro,
LinxDadosOpticosDav Roney Kuntz
44 23/03/2020 Inclusão do método:
LinxAntecipacoesFinanceirasPlanos Roney Kuntz
45 16/04/2020 Inclusão dos filtros exibir_cancelados e
145ntecipaçõe _finalizada e inclusão do campo
cancelado no método LinxAntecipacoesFinanceiras. Roana de Mello
Danúbia Gattis
46 04/05/2020 Inclusão do filtro exibir excluídos no método
Linxmovimentotrocas e incluído os filtros aprovado e
cancelado no método Linxpedidosvenda. Roana de Mello
Danúbia Gattis
47 11/05/2020 Inclusão do filtro timestamp no método
LinxPedidosVenda e inclusão do timestamp no
parâmetro de consulta do método LinxPedidosVenda Danúbia Gattis
Página 146
Revisão Data Histórico das revisões Revisado por
48 02/06/2020 Inclusão do campo operação _origem no método
LinxPedidosVenda; inclusão do método
LinxSubClasses; inclusão de orientação geral sobre
Timestamps; inclusão de orientação geral sobre
acesso ao ERP. Danúbia Gattis
49 22/06/2020 Inclusão dos Método s
LinxDevolucaoRemanejoFabricaTipo, Consulta do
método LinxDevolucaoRemanejoFabricaTipo, Método
LinxDevolucaoRemanejoFabricaStatus, Consulta do
método LinxDevolucaoRemanejoFabricaStatus,
Método LinxDevolucaoRemanejoFabrica, Consulta do
método LinxDevolucaoRemanejoFabrica, Método
LinxDevolucaoRemanejoFabricaItem, Consulta do
método LinxDevolucaoRemanejoFabricaItem . Danúbia Gattis
Roana de Mello
50 25/06/2020 Atualização e ajustes no documento Danúbia Gattis
Roana de Mello
51 26/06/2020 Inclusão do campo id_classe_fiscal no método
LinxLojas; inclusão do campo ativa no método
LinxConfiguracoesTributarias; inclusão do campo
somente_ativa no Parâmetros de consulta do
método LinxConfiguracoesTributarias e inclusão de
novos métodos e parâmetros
LinxProdutosDetalhesSimplificado;
LinxConfiguracoesTributariasDetalhesSimplificado;
LinxNaturezaOperacao; LinxClasseFiscal;
LinxCstIcmsFiscal; LinxCsosnFiscal; LinxCfopFiscal Danúbia Gattis
52 03/08/2020 Inclusão dos campos 146peração _iss e base_iss no
método LinxMovimento Danúbia Gattis
53 11/08/2020 Inclusão do s campo s ordem , operaç _rotina_origem
no método LinxMovimento ; inclusão de novo
método LinxRotinaOrigem e consulta de método
LinxRotinaOrigem Danúbia Gattis
54 12/08/2020 Inclusão do campo cod_natureza_operacao e
timestamp no método LinxMovimento Danúbia Gattis
55 20/08/2020 Inclusão de novos métodos e parâmetros
LinxPedidosVendaChecklistEntregaLocal;
LinxPedidosVendaChecklistEntregaArmazenamento;
LinxPedidosVendaChecklistEntregaDificuldade Danúbia Gattis
Página 147
Revisão Data Histórico das revisões Revisado por
56 24/08/2020 Inclusão de novos métodos e parâmetros
LinxSetores ; LinxMarcas ; LinxColecoes ;
LinxTamanhos ; LinxCores ;
LinxEspessuras ;LinxClassificacoes ; LinxUnidades Danúbia Gattis
57 25/08/2020 Inclusão dos campos valor_iss , tipo_tributacao_iss
no método LinxMovimentoExtensao ; inclusão dos
campos 147ntecipaç _municipal_emp , cnae_emp no
método Linxlojas ; inclusão do campo
id_ramo_atividade no método
LinxConfiguracoesTributariasDetalhes e inclusão de
novo método e parâmetros LinxRamosAtividade Danubia Gattis
58 18/09/2020 Inclusão do novo método LinxECF , paramentros de
consulta do método LinxECF e do método
LinxECFFormasPagamento e parâmetros de consulta
do método LinxECFFormasPagamento Danúbia Gattis
59 21/09/2020 Inclusão do filtro anteci_integracao_ws no
parâmetros de consulta no método LinxProdutos e
inclusão do filtro id_antecipacoes_financeiras no
parâmetros de consulta LinxMovimentoCartoes Danúbia Gattis
60 21/10/2020 Inclusão do campo desconto no método
LinxPedidosVenda Danúbia Gattis
61 28/10/2020 Inclusão do campo Desfazimento no método
LinxMovimentoTrocas Danubia Gattis
62 16/11/2020 Inclusão de novo método LinxMovimentoGiftCard e
parâmetros de consulta LinxMovimentoGiftCard Danúbia Gattis
63 28/12/2020 Inclusão de novo método e parâmetros de consulta
LinxProdutosOpticosTipo. Inclusão do campo
id_produtos_opticos_tipo no método LinxProdutos Danúbia Gattis
64 19/01/2021 Inclusão do novo método LinxProdutosSerial e
parâmetros de consulta LinxProdutosSerial Danúbia Gattis
65 03/02/2021 Inclusão de novos métodos e parâmetros de
consulta: LinxMovimentoRemessas ;
LinxMovimentoRemessasItens ;
LinxMovimentoRemessasAcertos ;
LinxMovimentoRemessasAcertosItens ;
LinxRemessasRetornoTipos ;
LinxRemessasOperacoes Danúbia Gattis
Página 148
Revisão Data Histórico das revisões Revisado por
66 12/02/2021 Inclusão do filtro depositos no Parâmetros de
consulta do método LinxProdutosSerial Danúbia Gattis
67 16/04/2021 Atualização do documento completo Thayze Naizer
68 22/06/2021 Inclusão do método e parâmetros
LinxRemessasIdentificadores Danúbia Gattis
69 01/07/2021 Inclusão do campo matr ícula no método
LinxVendedores Danúbia Gattis
70 12/07/2021 Inclusão do item 4.3 BIT nas Orientações Gerais Danúbia Gattis
71 15/07/2021 Inclusão da Obs2 no método LinxProdutosDetalhes Danubia Gattis
72 23/07/2021 Inclusão de novos métodos e parâmetros
LinxTrocaUnificadaResumoVendas ,
LinxTrocaUnificadaResumoVendasItens Danúbia Gattis
73 26/07/2021 Inclusão dos campos icms_fcp_aliquota,
icms_fcp_base_item, icms_fcp_valor_item no
método LinxMovimentoExtensao . Danúbia Gattis
74 29/07/2021 Inclusão do campo cod_cliente_linx no método
LinxLojas , inclusão do campo cliente_anonimo no
método LinxCLientesFornec Danúbia Gattis
75 03/08/2021 Inclusão do campo transacao_ws no método
LinxPedidosVenda Danúbia Gattis
76 06/08/2021 Inclusão do campo identificador_devolucao no
método LinxRemessasIdentificadores Danúbia Gattis
77 09/08/2021 Alteração dos campos transação para
transacao_acerto , qtde_total para qtde_total_acerto
e inclusão do campo transacao_remessa no método
LinxRemessasIdentificadores Danúbia Gattis
78 11/08/2021 Inclusão do campo id_remessa_operacoes no
método LinxremessasIdentificadores e observações
abaixo do método. Danúbia Gattis
79 21/09/2021 Inclusão do método e parâmetros de consulta do
método LinxMovimentoPrincipal Danúbia Gattis
80 18/10/2021 Inclusão do campo troco no método LinxMovimento
e do item Exemplo de Estrutura do Método de Saída Danúbia Gattis
81 25/10/2021 Inclusão de novos métodos e parâmetros
LinxCupomDesconto e LinxCupomDescontoVendas Danúbia Gattis
Página 149
Revisão Data Histórico das revisões Revisado por
82 16/11/2021 Inclusão do parâmetro identificador no método
LinxMovimentoPrincipal Danúbia Gattis
83 29/11/2021 Inclusão de novos métodos e parâmetros
LinxTrocaUnificadaResumoBaixa Danúbia Gattis
84 07/11/2021 Inclusão do campo limite_compras no método
LinxClientesFornec Danúbia Gattis
85 16/12/2021 Inclusão do campo codigo_ws no método
LinxClientesFornec Danúbia Gattis
86 20/12/2021 Inclusão do campo apenas_com_faturas no
parâmetro LinxMovimentoCartoe s Danúbia Gattis
87 03/01/2021 Inclusão do campo plano no parâmetro LinxPlanos Danúbia Gattis
88 11/01/2022 Inclusão do campo limite_credito _compra no
método LinxClientesFornec Danúbia Gattis
89 14/02/2022 Inclusão do campo componente no método
LinxProdutos Danúbia Gattis
90 02/03/2022 Inclusão do campo codigo_integracao_reshop no
método LinxProdutos Danúbia Gattis
91 04/03/2022 Inclusão de novo método e parâmetros de consulta
LinxListagemBalanco Danúbia Gattis
92 29/03/2022 Inclusão dos campos altura_para_frete,
largura_para_frete , comprimento_para_frete no
método LinxProdutos; inclusão do campo
transportador no método LinxMovimento Danúbia Gattis
93 05/04/2022 Inclusão dos campos icms_aliquota_desonerado ,
icms_valor_desonerado_item no método
LinxMovimento Danúbia Gattis
94 06/04/2022 Inclusão do campo loja_virtual no método
LinxProdutos Danúbia Gattis
95 24/05/2022 Inclusão do novo método e parâmetros de consulta
LinxProdutosAssociados e
LinxMovimentoObservacaoCF Danúbia Gattis
96 03/06/2022 Inlcusão de novos métodos e parâmetros de
consulta LinxMovimentoReshop e
LinxMovimentoReshopItens Danúbia Gattis
97 20/06/2022 Inclusão de novos métodos e parâmetros de
consulta LinxCentroCusto e LinxPlanoContas Danúbia Gattis
Página 150
Revisão Data Histórico das revisões Revisado por
98 22/06/2022 Inclusão de novos métodos e parâmetros de
consulta LinxPerguntaVenda e LinxRespostaVenda e
inclusão dos campos id_pergunta_venda e
id_resposta_venda no método
LinxMovimentoPrincipal Danúbia Gattis
99 30/06/2022 Inclusão de novos métodos e parâmetros de
consulta LinxConfiguracoesTributariasEmpresas ,
LinxCest , LinxCstCofinsFiscal , LinxCstIpiFiscal ,
LinxCstPisFiscal , LinxEnquadramentoIpi ,
LinxMotivosDesoneracaoIcms ,
LinxMovimentoObservacoes , LinxNcm ,
LinxSpedTipoBaseCredito e inclusão de novos
campos no método LinxNaturezaOperacao ,
LinxConfiguracoesTributarias ,
LinxConfiguracoesTributariasDetalhes Danúbia Gattis
100 21/07/2022 Inclusão do campo empresa nos métodos e
parâmetros de consulta:
LinxMovimentoOrigemDevolucoes , LinxMovimento ,
LinxMovimentoTrocas, LinxMovimentoPlanos,
LinxProdutosDetalhes, LinxFaturas,
LinxLancContabil, LinxPedidosVenda,
LinxPedidosCompra, LinxProdutosInventario e
inclusão dos campos transportador e deposito no
método LinxPedidosVenda Danúbia Gattis
101 15/08/2022 Inclusão do campo id_classe_fiscal no método
LinxClientesFornec Danúbia Gattis
102 25/08/2022 Atualização do documento – inclusão do item 4.4
em Orientações Gerais Danúbia Gattis
103 29/08/2022 Inclusão do campo codigo_ws no método
LinxServicos Danúbia Gattis
104 29/09/2022 Inclusão do novo método e paramêtros de consulta
LinxNfceEstacao
Alteração do tipo do campo cod_forma_pgto de
CHAR(1) para INT
Inclusão do campo ordem no método
LinxMovimentoReshopItens
Inclusão do método e parâmetros
LinxMovimentoIndicacoes Danúbia Gattis
Página 151
Revisão Data Histórico das revisões Revisado por
105 13/10/2022 Inclusão dos campos id_tipo_venda e
descricao_tipo_venda no método LinxVendedores Danúbia Gattis
106 24/10/2022 Inclusão do campo desconto_item no método
LinxMovimento Danúbia Gattis
107 25/10/2022 Inclusão do novo método e parâmetros de consulta
LinxValesComprasEnviadosAPI Danúbia Gattis
108 03/11/2022 Inclusão d e novos método s LinxProdutosLotes ,
LinxMovimentoVendaConjugada Danúbia Gattis
109 29/11/2022 Inclusão do campo diferenciar_avista no Parâmetros
de consulta LinxMovimentoPlanos Danúbia Gattis
110 21/12/2022 Inclusão de novo método Método LinxNfse e dos
campos aliq_iss e iss_base_item no método
LinxMovimento Danúbia Gattis
111 02/01/2023 Inclusão dos campos obs e mae no método
LinxClientesFornec Danúbia Gattis
112 01/02/2023 Inclusão de novo método e parâmetro de consulta
LinxMovimentoOrdemServicoExterna Danúbia Gattis
113 14/02/2023 Inlusão de novos campos no método
LinxMovimentoExtensao Danúbia Gattis
114 28/02/2023 Atualização do tipo no campo cod_autorizacao no
método LinxFaturas Danúbia Gattis
115 03/03/2023 Inclusão d os novos campos data_emissao ,
hora_emissao no método LinxNFeEvento Danúbia Gattis
116 06/03/2023 Atualização do tipo no s campos NSU, - nsu_host e
nsu_sitef do s métodos LinxFaturas e
LinxMovimentoCartoes Danúbia Gattis
117 17/03/2023 Inclusão do campo codigo_bandeira_sitef no método
LinxPlanosBandeiras Danubia Gattis
118 29/03/2023 Inclusão dos campos cnpj_empresa_resgate ,
data_resgate no método
LinxValesComprasEnviadosAPI Danúbia Gattis
119 30/03/2023 Inclusão do campo despesas no método
LinxMovimento Danúbia Gattis
120 31/03/2023 Inclusão do campos
aliquota_diferimento_icms ,aliquota_diferimento_fcp
no método LinxConfiguracoesTributariasDetalhes Danúbia Gattis
121 05/04/2023 Inclusão do campo id_tradein_parceiro no méodo e
parâmetro LinxMovimentoTrocafone . Danubia Gattis
Página 152
Revisão Data Histórico das revisões Revisado por
Inclusão de novo método e parâmetro de consulta
LinxTradeinParceiro .
Inclusão de novos campos vale_cod_cliente ,
vale_codigoproduto no método
LinxMovimentoTrocas
122 10/04/2023 Inclusão dos campos codigo_pacote,
codigo_itens_associados, codigo_kit no método
LinxMovimentoExtensão. Juliana Fandaruff
123 13/04/2023 Inclusão dos campos seguro_total_item,
acrescimo_total_item e despesas_total_item no
método LinxMovimento Juliana Fandaruff
124 10/05/2023 Inclusão do campo cod_comprador no método
LinxProdutos Danubia Gattis
125 17/05/2023 Atualização da URL de entrada em ambiente de
homologação Danubia Gattis
126 18/05/2023 Inclusão de Observação no método LinxMovimento Danubia Gattis
127 24/05/2023 Inclusão da OBS2 no método LinxMovimento e
Inclusão da descrição da operação C = Nota
Subst utiva de CF no método LinxMovimento Danubia Gattis
128 05/06/2023 Inclusão d o novo campo doc_origem no parâmetro
de consulta LinxPedidosVenda Danubia Gattis
129 09/06/2023 Inclusão do novo método e parâmetro de consulta e
inclusão d o novo campo id_categorias_financeiras
no método LinxFaturas Danubia Gattis
130 14/06/2023 Inclusão dos novos campos taxa_financeira ,
valor_abatimento , valor_multa , centrocusto no
Método LinxFaturas Danúbia Gattis
131 23/06/2023 Inclusão do novo campo identificador no parâmetro
de consulta LinxNfse Danubia Gattis
132 17/07/2023 Inclusão do novo método e parâmetro de consulta
LinxValeOrdemServicoExterna e inclusão do campo
id_vale_ordem_servico_externa no método
LinxMovimentoTrocas Danúbia Gattis
133 24/07/2023 Inclusão do novo campo perc_taxa_adquirente no
método LinxFaturas Danubia Gattis
134 23/08/2023 Inclusão de novo método e parâmetro de consulta
LinxProdutosDetalhesDepositos . Danubia Gattis
Página 153
Revisão Data Histórico das revisões Revisado por
Inclusão dos novos campos forma_pix , total_pix ,
forma_deposito_bancario e total_deposito_bancario
no método LinxMovimento
135 30/08/2023 Inclusão de novo método e parâmetro de consulta
LinxSerialVenda Danubia Gattis
136 26/09/2023 Inclusão de novos os campos
total_fidelidade_cashback ,
plano_fidelidade_cashback no método
LinxMovimentoPrincipal Danúbia Gattis
137 07/11/2023 Inclusão do novo campo remessa_pedido_compra no
método LinxMovimentoPrincipal Danúbia Gattis
138 09/11/2023 Inclusão do novo campo codigo_integracao_ws nos
métodos LinxSetores, LinxLinhas , LinxMarcas ,
LinxColecoes , LinxTamanhos , LinxCores ,
LinxEspessuras , LinxClassificacoes Danúbia Gattis
139 28/11/2023 Inclusão do novo método LinxProdutosFornec e
parâmetros de consulta LinxProdutosFornec Danubia Gattis
140 06/12/2023 Inclusão do novo campo nf_origem_ws no método
LinxPedidosCompra Danubia Gattis
141 19/12/2023 Inclusão do campo ativo nos métodos LinxSetores,
LinxTamanhos, LinxCores, LinxEspessuras e
LinxClassificacoes e inclusão do campo cargo no
método LinxVendedores Danubia Gattis
142 21/12/2023 Inclusão do campo fatura_origem_importacao_erp
no método LinxFaturas Danubia Gattis
143 11/01/2 024 Inclusão de novo método LinxComissoesVendedores Danubia Gattis
144 15/01/2024 Inclusão da OBS no item 4.1 TIMESTAMPS: Danúbia Gattis
145 20/02/2024 Atualização do campo tipo_cadastro no parâmetro de
consulta do método LinxClientesFornec Danubia Gattis
146 01/03/2024 Inclusão de novo método e parâmetro de consulta
LinxFaturasOrigem ;
Inclusão de novo método e parâmetro de consulta
LixMotivoDesconto ;
Inclusão de novo campo id_motivo_desconto no
método LinxMovimentoPrincipal ; Danubia Gattis
Página 154
Revisão Data Histórico das revisões Revisado por
Inclusão de novo campo id_motivo_desconto no
método LinxMovimentoExtensao
147 14/03/2024 Inclusão do campo no parâmetro de consulta no
método LinxMovimentoPrincipal Danubia Gattis
148 02/04/2024 Inclusão do campo tabela_preco_preferencial no
método LinxLojas Danubia Gattis
149 03/04/2024 Atualização no nome do método LixMotivoDesconto
para LinxMotivoDesconto
150 10/04/2024 Inclusão dos campos id_ordservprod ,
id_vendas_pos_produtos_tmp ,
id_vendas_pos ,cancelado , previsao_entrega ,
numero_ficha ,
id_vendas_pos_produtos_campos_adicionais_tmp ,
id_link_pagamento_linx_pay_hub ,
codigo_gerencial ,empresa , origem ,
acoes_promocionais_desconto , desconto , acréscimo,
frete, descontos_impostos , acrescimos_impostos ,
preco_unitario , quantidade , desconto_item ,
acrescimo_item_valor , desconto_item_valor no
método LinxDadosOpticosDav .
Inclusão do campo cod_cliente no método
LinxXMLDocumentos .
Inclusão do campo valor_nota no método
LinxMovimentoPrincipal .
Inclusão do campo id_vendas_pos no método ID da
venda .
Inclusão dos novos métodos e parâmetros
LinxPosicaoOsRamoOptico , LinxOrdensServico ,
LinxOrdensServicoProdutos ,
LinxOrdensServicoPosicaoOsRamoOpticoHistorico ,
LinxPagamentoParcialDav ,
LinxMovimentoCamposAdicionais ,
LinxOrdemServicoExternaDav Danubia Gattis
151 17/04/2024 Inclusão de novo campo
obrigatorio_identificacao_cliente no método
LinxProdutos Danubia Gattis
152 22/04/2024 Inclusão do campo descricao_basica no método
LinxProdutos Danubia Gattis
Página 155
Revisão Data Histórico das revisões Revisado por
153 24/04/2024 Inclusão do campo codigo_integracao_ws no método
LinxProdutosTabelas Danubia Gattis
154 29/04/2024 Atualização dos campos dt_update_inicio e
dt_update_fim para o tipo SMALLDATETIME no
parâmetro do método LinxProdutos Danubia Gattis
155 29/04/2024 Inclusão dos campos id_lanc e cancelado no método
LinxLancContabil e inclusão do campo
exibir_cancelados no parâmetro LinxLancContabil Danubia Gattis
156 07/05/2024 Inclusão de novo filtro retornar_saldo_zero no
paramento de consulta do método
LinxProdutosDetalhes Danubia Gattis
157 14/05/2024 Inclusão do novo campo id_venda_produto_b2c no
método LinxMovimento ; inclusão do novo campo
id_antecipacoes_financeiras_detalhes no método
LinxAntecipacoesFinanceiras ; inclusão dos novos
campos id_posicao_os_ramo_optico , data,
observação e portal no método
LinxOrdensServicoPosicaoOsRamoOpticoHistorico ,
inclusão dos novos campos
id_pagamento_parcial_tmp , plano , forma_pgto ,
valor, id_bandeira , qtde_parcelas , credito_debito e
portal no método LinxPagamentoParcialDav Danúbia Gattis
158 20/05/2024 Inclusão do novo campo id_vendas_pos_produtos no
método LinxAntecipacoesFinanceiras .
Inclusão do novos métodos e parâmetros de
consulta: LinxB2CPedidos , LinxB2CPedidosItens ,
LinxB2CStatus , LinxB2CPedidosStatus . Danúbia Gattis
159 29/05/2024 Inclusão do novo campo curva no método
LinxProdutos Danubia Gattis
160 11/06/20224 Inclusão do novo campo cartao_prepago no método
LinxMovimentoCartoes Danubia Gattis
161 17/06/2024 Inclusão do novo campo marketplace_loja no método
LinxB2CPedidos e do campo FiltrarCNPJ no
parâmetro LinxPlanoContas Danubia Gattis
162 25/06/2024 Inclusão do novos métodos e parâmetros de consulta
LinxOticoPrismaDescricao e LinxOticoReceitas Danubia Gattis
Página 156
Revisão Data Histórico das revisões Revisado por
163 27/06/2024 Inclusão de novos campos doc_venda_origem ,
serie_venda_origem no método
LinxMovimentoTrocas Danubia Gattis
164 01/07/2024 Inclusão do novo campo item_promocional no
método LinxMovimento Danubia Gattis
165 02/07/2024 Inclusão do novo método e parâmetros de consulta
LinxOrcamentoComponenteFormula Danubia Gattis
166 17/07/2024 Inclusão dos campos portal , coeficiente_comissao no
método LinxLinhas Danubia Gattis
167 24/07/2024 Inclusão de novo método e parâmetro de consulta
LinxLotesProdutos
Atualização do campo id_config_tributaria, alterando
a informação da coluna "Tipo" de "SMALLINT" para
"INT", nos métodos : LinxProdutosDetalhes
LinxConfiguracoesTributarias
LinxConfiguracoesTributariasDetalhes
LinxServicosDetalhes
LinxProdutosDetalhesSimplificado
LinxConfiguracoesTributariasDetalhesSimplificado
(neste método, além do retorno, também no filtro) Danubia Gattis
168 25/07/2024 Inclusão do campo acrescimo_item no método
LinxMovimento Danubia Gattis
169 30/07/2024 Inclusão do novo método e parâmetros de consulta
LinxCadastraClientesRede Danubia Gattis
170 01/08/2024 Inclusão dos novos campos
icms_st_antecipado_base_item ,
icms_suportado_valor_item ,
icms_suportado_valor_unitario ,
icms_st_pago_base ,icms_st_pago_valor ,
icms_st_pago_aliq , icms_para_st_pago_valor no
método LinxMovimentoExtensao ;
Inclusão dos novos campos
icms_st_antecipado_aliquota ,
icms_st_antecipado_margem ,
icms_st_antecipado_percentual_reducao ,
icms_st_antecipado_valor_item ,
icms_base_desonerado_item no método
LinxMovimento ; Danubia Gattis
Página 157
Revisão Data Histórico das revisões Revisado por
Inclusão do campo cod_cliente no método
LinxMovimentoTrocas e atualização da descrição do
campo vale_cod_cliente
Inclusão do novo método e parâmetros de consulta
LinxFechamentoCaixa
171 05/08/2024 Inclusão dos novos métodos e parâmetros de
consulta LinxAcoesPromocionaisProdutosCortesia ,
LinxAcoesPromocionaisCombinacaoProdutosItens Danubia Gattis
172 19/08/2024 Inclusão do novo campo codigo_status_nfe no
método LinxMovimento Danubia Gattis
173 20/08/2024 Inclusão do novo campo timestamp no método e
parâmetros de consulta
LinxMovimentoOrigemDevolucoes Danubia Gattis
174 17/09/2024 Inclusão de novo método e parâmetro de consulta
LinxProdutosInformacoes Danubia Gattis
175 07/10/2024 Inclusão de novos campos data_vencimento e
valor_original no método LinxMovimentoTrocas Juliana Fandaruff
176 16/10/2024 Inclusão dos novos métodos LinxFreteTipos,
LinxNfeIbgeMunicipio e LinxConhecim entoFretes.
Atualização das informações de desconto nas
observações do método LinxMovimento. Juliana Fandaruff
177 18/10/2024 Inclusão do novo método e parâmetro de consulta
LinxPlanosParcelas. Juliana Fandaruff
178 05/11/2024 Inclusão de novo método e parâmetro de consulta
LinxComponenteFormulaDav Danubia Gattis
179 25/11/2024 Inclusão de novo método e parâmetro de consulta
LinxClientesEnderecosEntrega Danubia Gattis
180 25/11/2024 Inclusão do novo campo texto_agrupador no método
LinxPedidosVenda Danubia Gattis
181 29/11/2024 Inclusão dos campos codigoproduto_io e
codigo_integracao_oms no método LinxProdutos Danubia Gattis
182 03/12/2024 Inclusão do campo preco_produto_epoca no método
LinxMovimento.
Inclusão do campo cancelado no parâmetro de
consulta do método LinxMovimento
Aline da Veiga
Danúbia Gattis
183 04/12/2024 Inclusão do novo método e parâmetro de consulta
LinxUsuarios . Danubia Gattis
Página 158
Revisão Data Histórico das revisões Revisado por
Inclusão do campo id_campo_valor no método
LinxProdutosCamposAdicionais .
Inclusão do novo método e parâmetro de consulta
LinxProdutosImagensURL
184 30/12/2024 Inclusão dos campos id_tipo_registro_profissional ,
registro_profissional no método LinxClientesFornec .
Inclusão dos campos ficha, numero_sequencial_pos
no método LinxMovimento .
Inclusão do campo cod_cliente_indicador no método
LinxMovimentoExtensao .
Inclusão dos novos métodos e parâmetros de
consulta LinxRegistroProfissional ,
LinxVendasPosTmp e
LinxVendasPosAgrupamentoTmp Danúbia Gattis
185 14/01/2025 Inclusão do novo campo tributa_fcp no método
LinxProdutos Danubia Gattis
186 20/01/2025 Inclusão do novo campo id_imagem no método
LinxProdutosImagensURL .
Inclusão do novo campo dt_insert no método
LinxMovimento
Inclusão do novo campo portal nos métodos
LinxSetores , LinxLinhas , LinxMarcas , LinxColecoes ,
LinxTamanhos , LinxCores , LinxEspessuras ,
LinxUnidades , LinxClassificacoes , LinxSubClasses ,
LinxECF , LinxECFFormasPagamento ,
LinxMovimentoGiftCard ,
inxRemessasIdentificadores ,
inxMovimentoOrdemServicoExterna ,
LinxMovimentoPrincipal , LinxListagemBalanco ,
LinxMovimentoObservacaoCF ,
LinxMovimentoReshop , LinxMovimentoReshopItens
LinxNfceEstacao , LinxMovimentoIndicacoes ,
LinxValesComprasEnviadosAPI ,
LinxMovimentoVendaConjugada ,
LinxProdutosFornec , LinxComissoesVendedores ,
LinxFaturasOrigem , LinxMotivoDesconto ,
LinxPosicaoOsRamoOptico , LinxOrdensServico ,
LinxOrdensServicoProdutos , Danúbia Gattis
Página 159
Revisão Data Histórico das revisões Revisado por
LinxMovimentoCamposAdicionais ,
LinxOrdemServicoExternaDav ,
LinxFechamentoCaixa , LinxCategoriasFinanceiras ,
LinxClientesFornecContatosParentesco ,
LinxDevolucaoRemanejoFabrica ,
LinxDevolucaoRemanejoFabricaStatus ,
LinxDevolucaoRemanejoFabricaTipo ,
LinxDadosOpticosDav , LinxProdutosOpticosTipo ,
LinxProdutosOpticosFormatoAro ,
LinxProdutosOpticosTipoAro ,
LinxPedidosVendaChecklistEntregaLocal ,
LinxPedidosVendaChecklistEntregaArmazenamento ,
LinxPedidosVendaChecklistEntregaDificuldade ,
LinxDevolucaoRemanejoFabricaItem ,
187 22/01/2025 Inclusão de novo campo filtra_somente_timestamp
no Parâmetros de consulta do método LinxMovimento Danúbia Gattis
188 27/01/2025 Inclusão do novo campo filtra_somente_timestamp
no filtro dos métodos LinxFaturas e LinxLancContabil Danúbia Gattis
189 18/02/2025 Inclusão do novo campo observacao e do campo
exibe_observacao no filtro do método LinxProdutos Danúbia Gattis
190 20/02/2025 Inclusão dos novos campos nome_exibicao e função
no método LinxVendedores .
Inclusão do novo método e parâmetro de consulta
LinxClientesFornecVendedores Danúbia Gattis
191 25/02/2025 Inclusão do novo campo
id_acoes_promocionais_origem no método
LinxAcoesPromocionais
Inclusão dos novos métodos e parâmetros de
consulta LinxExtratoBancarioLancamentos e
LinxExtratoBancarioConciliacoes Danúbia Gattis
192 03/03/2025 Inclusão do campo recebe_newsletter no método
LinxClientesFornec Danúbia Gattis
193 12/03/2025 Inclusão dos campos diferencial_icms_fornec ,
perc_diferencial_icms_fornec no método
LinxClientesFornec Danúbia Gattis
194 27/03/202 5 Inclusão do campo custo_medio_epoca no método
LinxMovimento
Danúbia Gattis
Página 160
Revisão Data Histórico das revisões Revisado por
195 03/04/2025 Ajuste do tipo para VARCHAR(100) o campo
nome_plano no método
LinxAntecipacoesFinanceirasPlanos , campo
desc_plano no método LinxMovimentoPlanos ,
método LinxPlanos e método LinxPlanosPedidoVenda ,
campo plano_pagamento no método
LinxPedidosCompra e método LinxPedidosVend a. Danúbia Gattis
196 08/04/2025 Inclusão do novo campo valor_pagar no método
LinxAntecipacoesFinanceiras Danúbia Gattis
197 11/04/2025 Inclusão do novo campo id_produtos_status_compra
no método LinxProdutosDetalhes Danúbia Gattis
198 16/04/2025 Inclusão do novo campo id_antecipacoes_financeiras
no método LinxMovimentoTrocas Danubia Gattis
199 29/04/2025 Inclusão do novo campo timestamp nos métodos
LinxAcoesPromocionais e
LinxMovimentoAcoesPromocionais .
Alteração do tipo ativa para não ser mais obrigatório
no método LinxAcoesPromocionais Danúbia Gattis
200 29/04/2025 Inclusão dos novos campos id_classe_preferencial e
id_subclasse_preferencial no método
LinxClientesFornec e o campo cod_portador no
método LinxPedidosCompra .
Inclusão do novos métodos e parâmetros de
consulta: LinxHistoricosContabeis , LinxPortadores e
LinxPedidosCompraStatus Danúbia Gattis
201 13/05/2025 Inclusão dos novos campos nsu_host e nsu_sitef no
método LinxFaturas Danúbia Gattis
202 19/05/2025 Inclusão do campo motivo_desconto_observacao no
método LinxMovimentoExtensao Juliana
Fandaruff
203 04/06/2025 Inclusão do campo valor_minimo_parcela no método
LinxPlanos Juliana
Fandaruff
204 09/06/2025 Inclusão do campo codigo_adicional_reshop no
método LinxProdutos Juliana
Fandaruff
205 11/06/2025 Inclusão dos novos métodos
LinxDesfazimentosAntecipacoes ;
LinxDesfazimentosAntecipacoesItens ;
LinxDesfazimentosAntecipacoesDocumento
Juliana
Fandaruff
Página 161
Revisão Data Histórico das revisões Revisado por
206 16/06/2025 Inclusão do campo
identificador_faturamento_antecipado no método
LinxAntecipacoesFinanceiras Juliana
Fandaruff
207 20/06/2025 Inclusão de campos nos métodos : LinxProdutos
campo brinde e LinxPedidosVenda campo posicao Juliana
Fandaruff