API Cadastro de Item Fiscal

Desenho do Fluxo

Cenário Atual

Se trata do WebService padrão do Linx ERP.

Credenciais de Acesso

Responses

Code	Description	Links
200	Success	No links
500	Server Error	No links

Curl

Request URL

v1/CadastroItemFiscal

GE

Cadastro de Item Fiscal

Apresentando os campos da API Cadastro de Item Fiscal

Nome	Obrigatório	Tipo	Chave Primária	Descrição
itemDescricao	Sim	Varchar (80)	Não	Informe uma descrição para o item fiscal a ser cadastrado.
codigoItem	Sim	Varchar (50)	Sim	Informe um código para o item fiscal a ser cadastrado.
unidade	Não	Varchar (5)	Não	Informe a unidade do item fiscal a ser cadastrado.
preçoUnitario	Não	Numeric (9)	Não	Informe o preço unitário do item fiscal a ser cadastrado.
comissaoItem	Não	Numeric (9)	Não	Informe a comissão do item fiscal a ser cadastrado.
comissaoItemGerente	Não	Numeric (9)	Não	Informe a comissão do gerente do item fiscal a ser cadastrado.
itemFiscalGrupo	Não	Char (4)	Não	Preencha este campo, caso o item fiscal esteja enquadrado em algum grupo de item fiscal. As opções disponíveis para seleção devem ser previamente cadastradas na tela 100127 - Cadastro de Grupo de Itens Fiscais
rateioCentroCusto	Não	Varchar (15)	Não	Este campo permite o cadastramento de um rateio de filial. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009011 - Rateio de Centro de Custo
classifFiscal	Não	Char (10)	Não	Informe a classificação fiscal. As opções disponíveis para seleção devem ser previamente cadastradas na tela 003006 - Classificações Fiscais e IPI.
contaContabil	Não	Varchar (20)	Não	Informe a conta contábil para o item fiscal a ser cadastrado. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009007 - Conta Contábil Analítica.
indicadorCfop	Não	Tinyint (1)	Não	Indica o tipo de CFOP, para o cadastro de item fiscal para Ativo, utilize o código 20.
idExcecaoGrupo	Não	Int (4)	Não	Preencha este campo, caso o item fiscal esteja enquadrado em algum grupo de exceção fiscal.
rateioFilial	Não	Varchar (15)	Não	Este campo permite o cadastramento de um rateio de filial. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009012 - Rateio de Filial
tributOrigem	Não	Varchar (15)	Não	Indica o tipo de tributação origem.
tributItemSped	Não	Datetime (8)	Não	As informações preenchidas nestes campos serão utilizadas na geração do arquivo Sped.
inativo	Não	Bit (1)	Não	Ao selecionar esta opção, o item não será exibido para utilização.
naturezaReceita	Não	Char (3)	Não	As informações preenchidas nestes campos serão utilizadas na geração do arquivo Sped.
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.
codAliquotaPisCofins	Não	Varchar (9)	Não	As informações referem-se a aliquota Pis e Cofins do item.
classeImobilizado	Não	Char (15)	Não	Informe a Classe e Subclasse do Item fiscal. As opções disponíveis para seleção devem ser previamente cadastradas na tela 013005 - Cadastro de Classe e Subclasse
sublicasseImobilizado	Não	Char (15)	Não	Informe a Classe e Subclasse do Item fiscal. As opções disponíveis para seleção devem ser previamente cadastradas na tela 013005 - Cadastro de Classe e Subclasse
tipoReceitaComunicacao	Não	Char (1)	Não	As informações referem-se a receita comunicação.
lxStatusRegistro	Não	Int (4)	Não	Status do Registro na tabela
identUtilizacaoImob	Não	Char (1)	Não	As informações de utilização da utilização do imobilizado.
idCestNcm	Não	Int (4)	Não	As informações referem-se a id da ncm.
codServicoReinf	Não	Varchar (9)	Não	Escolha o código serviço utilizado na EFD-REINF. Apenas deve ser preenchido para itens fiscais de serviço.
codigoServico	Não	Varchar (10)	Não	As informações referem-se ao código do Serviço.
participaintegracao	Não	Bit (1)	Não	Possibilita via tela a seleção de quais registros que irão ser incluídos ou não na integração da API do ERP Linx com os sistemas externos.

Na Api é carregado informações referente a Classificação Fiscal seguem os campos:

Nome	Obrigatório	Tipo	Chave Primária	Descrição
classifFiscal	Sim	Char (6)	Sim	Este campo estabelece a classificação fiscal do produto.
ipi	Não	Numeric (5)	Não	Informe a alíquota utilizada conforme o produto. Um produto pode ser tanto isento quanto ter uma alíquota variada. Normalmente os produtos considerados supérfluos (bebidas, cigarro, perfumes, automóveis, etc.) possuem uma alíquota mais alta e os produtos de primeira necessidade (alimentícios, vestuário, calçados, etc.) possuem uma alíquota mais baixa.
descClassificacao	Não	Varchar (40)	Não	O conteúdo deste campo descreve a classificação fiscal do produto de acordo com o código preenchido no campo Classif. Fiscal.
classifReduzida	Não	Char (6)	Não	Utiliza o código como sendo a classificação fiscal reduzida.
abaterIcmsNoMedio	Não	Bit (1)	Não	O conteúdo deste campo habilita o abatimento do imposto na base de cálculo do custo médio. Portanto este é um imposto estadual, ou seja, somente os Governos dos Estados do Brasil e do Distrito Federal têm competência para instituí-lo.
abaterIpiNoMedio	Não	Bit (1)	Não	O conteúdo deste campo habilita o abatimento do imposto na base de cálculo do custo médio. Este é um imposto que incidi sobre produtos industrializados, estrangeiros e nacionais.
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.
timestamp	Não	Numeric (9)	Não	Representa um ponto específico na linha do tempo e leva em consideração o fuso horário em questão ( UTC ).
abaterPisNoMedio	Não	Bit (1)	Não	O conteúdo deste campo habilita o abatimento do imposto na base de cálculo do custo médio. Esta é uma contribuição social de natureza tributária, devida pelas pessoas jurídicas.
passivelReducaoBaseIcms	Não	Tinyint (1)	Não	Será passível de Redução Base ICMS.
abaterCofinsNoMedio	Não	Bit (1)	Não	O conteúdo deste campo habilita o abatimento do imposto na base de cálculo do custo médio. Esta é uma contribuição federal, de natureza tributária, incidente sobre a receita bruta das empresas em geral, destinada a financiar a seguridade social.
reteFuente	Não	Numeric (9)	Não	Representa o cálculo de retenção na fonte.
reteIva	Não	Numeric (9)	Não	Representa o cálculo de IVA.
reteIca	Não	Numeric (9)	Não	Representa o cálculo de ICA.
codigoServico	Não	Varchar (15)	Não	Código do serviço utilizado em algumas obrigações acessórias, como a Nota Fiscal Paulistana, por exemplo.
codGeneroSped	Não	Char (2)	Não	Representa o código Genero Sped.
codigoContribuicaoReceitaBruta	Não	Varchar (8)	Não	Os dados desse campo devem ser inseridos para que sejam apresentados no registro P100 da EFD Contribuições.
idServicoTipo	Não	Int (4)	Não	Id's de Serviço utilizados no Sped, previamente cadastrados na tela 012312 - Cadastro de Tipo de Serviço.
Inativo	Não	Bit (1)	Não	Informa se a classificação fiscal está ativa ou inativa.

Na Api é carregado informações referente a Centro de Custo e Rateio

Nome	Obrigatório	Tipo	Chave Primária	Descrição
desRateioCentroCusto	Sim	Char (40)	Sim	Informe a descrição para o rateio.
inativo	Não	Bit (1)	Não	Quando marcado, o rateio não estará disponível para seleção nos pontos do sistema em que puder ser selecionado. Esse campo poderá ser marcado automaticamente pelo sistema quando ao menos um centro de custo que ele contenha for inativado.
rateioCentroCusto	Sim	Varchar (15)	Não	Este campo permite o cadastramento de um rateio de filial. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009011 - Rateio de Centro de Custo
rateioEntrarEmLista	Não	Bit (1)	Não	Quando marcado, esse campo indica que o rateio estará disponível para seleção durante a inclusão de documentos a pagar ou a receber.
codMatrizContabil	Não	Varchar (6)	Não	Com a matriz contábil indicada para o rateio de centro de custo.

Na Api é carregado informações referente a Conta Plano.

Nome	Obrigatório	Tipo	Chave Primária	Descrição
agencia	Não	Char (5)	Não	Informe o código de uma agência.
banco	Não	Char (5)	Não	Informe o código de um banco.
codigoHistorico	Não	Char (4)	Não	O histórico padrão, cadastrado na tela 009004, é utilizado como informação complementar ao lançamento contábil, em funcionalidades como o cadastro ou baixa de títulos a receber, avisos de crédito e débito, entre outras.
codigoResumo	Não	Char (5)	Não	Quando informado representa o código Resumo.
codClifor	Não	Char (6)	Não	Informe o código do cliente fornecedor.
contaContabil	Não	Varchar (20)	Não	Informe a conta contábil para o item fiscal a ser cadastrado. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009007 - Conta Contábil Analítica.
contaCorrente	Não	Bit (1)	Não	Informe o código de uma conta corrente.
contaPortadora	Não	Bit (1)	Não	Se marcada esta opção, será indicada que é uma conta contábil portadora. O objetivo é facilitar a localização de um título de acordo com a carteira de cobrança.
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.
desConta	Não	Varchar (40)	Não	Informe a descrição da Conta
desContaReduzida	Não	Varchar (20)	Não	Informe a descrição da Conta Reduzidamente.
desDetalhada	Não	Varchar (250)	Não	Informe a descrição da Conta Detalhadamente.
exportacaoContaContabil	Não	Varchar (20)	Não	Informe a exportação da contabilidade para outros sistemas.
exportacaoTipo	Não	Char (1)	Não	Inclui o número do último cheque utilizado, para usar o sequencial na geração da emissão de cheque. Clique no botão Inserir, localizado à esquerda da grade e selecione uma das opções disponíveis na tela para seleção.
idCarteiraCobranca	Não	Int (4)	Não	Se a opção Portadora estiver marcada, será obrigatório informar a carteira. Selecione ou preencha a carteira. Cada conta portadora possui apenas uma carteira de cobrança associada.
inativa	Não	Bit (1)	Não	Informa se o plano de contas está ativa ou inativa.
lxGrupoFluxo	Não	Char (3)	Não	Informe o grupo de fluxo.
Moeda	Não	Char (3)	Não	Informe a moeda em que serão expressos os valores lançados na conta.
numeroContaCorrente	Não	Varchar (20)	Não	Informe o número de Conta Corrente.
rateioCentroCusto	Não	Varchar (15)	Não	Este campo permite o cadastramento de um rateio de filial. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009011 - Rateio de Centro de Custo
tipoConta	Não	Varchar (10)	Não	Exibe para seleção a lista de tipos previamente cadastrada na tela 009001 - Tipos de Conta. Essa tela define uma associação entre conta contábil e lançamentos em que ela pode ser utilizada.
ultimoCheque	Não	Varchar (10)	Não	O preenchimento do campo Último Cheque será obrigatório se for utilizada a emissão de cheque via sistema.
lxGrupoContabil	Não	Char (3)	Não	Informo o Grupo Contábil.
lancamentoPadrao	Não	Int (4)	Não	Informe o lançamento padrão.
lacamentoPadraoDeflacao	Não	Int (4)	Não	Informe o lançamento padrão de deflação.
limiteContaCorrente	Não	Numeric (9)	Não	No campo Limite de Crédito, pode-se informar o valor do limite de crédito da conta para compor o saldo disponível.
saldoBloqContaCorrente	Não	Numeric (9)	Não	O campo Saldo Bloqueado, serão utilizados na tela 009071 - Consulta de conta corrente. Ao incluir um valor de saldo bloqueado ou uma previsão de despesas (tarifas, por exemplo), esses valores serão levados para a tela 009071 e farão parte da composição do saldo.
previsaoDespesa	Não	Numeric (9)	Não	O campo Previsão de Despesas serão utilizados na tela 009071 - Consulta de conta corrente. Ao incluir um valor de saldo bloqueado ou uma previsão de despesas (tarifas, por exemplo), esses valores serão levados para a tela 009071 e farão parte da composição do saldo.
idImposto	Não	Tinyint (1)	Não	Selecione o imposto, caso haja necessidade.
codFilial	Não	Char (6)	Não	Utilizado para vínculo de filial quando a conta analítica for uma conta corrente.
indicaConsolidacao	Não	Bit (1)	Não	Marque esta opção, caso a conta contábil deva ser considerada no processamento da consolidação de empresas.
indicaCtrlOrcamento	Não	Bit (1)	Não	Ao determinar o campo Valor Atual como: SIM – será impedida a inclusão ou a alteração de um lançamento contábil que supere o valor do orçamento. NÃO – não irá validar o valor do orçamento.
convenio	Não	Varchar (20)	Não	Informe um convênio.
contaContabilSuperior	Não	Varchar (20)	Não	Opção habilitada somente quando selecionada a opção Subconta no campo Grupo. Exibe a lista de contas associadas ao tipo de conta selecionada.
naturezaSubconta	Não	Char (2)	Não	Opção habilitada somente quando selecionada a opção Subconta no campo Grupo. Exibe opções pré-cadastradas que serão validadas na geração do Registro I053, na geração dos Livros Z e R da ECD - Escrituração Contábil

Na Api é carregado informações referente a Filial Rateio.

Nome	Obrigatório	Tipo	Chave Primária	Descrição
descRateioFilial	Sim	Varchar (40)	Não	Informe a descrição de um Rateio de Filial.
inativo	Não	Bit (1)	Não	Informa se o filial rateio está ativa ou inativa.
rateioFilial	Sim	Varchar (15)	Sim	Este campo permite o cadastramento de um rateio de filial. As opções disponíveis para seleção devem ser previamente cadastradas na tela 009012 - Rateio de Filial
rateioEntraremLista	Não	Bit (1)	Não	Informa a lista de todos que serão gerados os impostos.
codMatrizContabil	Não	Varchar (6)	Não	Informe a matriz contábil

Na Api é carregado informações referente a Indicador CFOP.

Nome	Obrigatório	Tipo	Chave Primária	Descrição
descIndicadorCfop	Não	Varchar (40)	Não	Informe a descrição de um Indicador CFOP.
indicadorCfop	Sim	Tinyint (1)	Sim	Informa um indicador de CFOP.
inativo	Não	Bit (1)	Não	Informa se o indicador cfop está ativa ou inativa.
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.

Na Api é carregado informações referente a Grupo de Exceções.

Nome	Obrigatório	Tipo	Chave Primária	Descrição
idExcecaoGrupo	Não	Int (4)	Não	Gera um id do grupo de exceções.
descExcecaoGrupo	Sim	Varchar (40)	Não	Informa a descrição de grupo de exceção.
obsExcecaoGrupo	Não	Varchar (40)	Não	Informa a observação de grupo de exceção
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.
lxStatusRegistro	Não	Int (4)	Não	Informe o Status do Registro.

Na Api é carregado informações referente a Tributação Origem.

Nome	Obrigatório	Tipo	Chave Primária	Descrição
tributOrigem	Sim	Char (3)	Sim	Informa da tributação origem.
descricao	Não	Varchar (150)	Não	Informa a descrição da tributação origem.
dataParaTransferencia	Não	Datetime (8)	Não	Data atual do cadastro.
inativo	Não	Bit (1)	Não	Informa se a tributação de origem está ativa ou inativa.
lxStatusRegistro	Não	Int(4)	Não	Informe o Status do Registro.

Árvore de páginas