Bem vindo(a) ao manual da API REST Figura Fiscal.

Nas abas acima, você encontra todas as possibilidades de integração (via GET e POST) com nossa base tributária. Os resultados dos acessos são retornados através de um JSON (formato compacto, de padrão aberto independente, de troca de dados simples e rápida entre sistemas) para que possam ser tratados e utilizados em seu sistema de retaguarda.
Importante: A API tem o limite máximo de 50.000 requisições por mês (somatório de qualquer uma das funções disponíveis na API).

Conheça abaixo a URL da API e os parametros obrigatórios para acesso aos dados em qualquer função de integração desejada:

Os demais parâmetros, deverão ser incrementados de acordo com a função que irá executar. Devem ser enviados via GET ou POST, informados com mais detalhes em cada aba.

Em caso de dúvidas, fale conosco através do email desenvolvimento@avantfiscal.com.br

Ao utilizar qualquer uma de nossas funções (Revisões, Consultas e Monitoramentos), nossa API irá retornar um JSON contendo o status da solicitação efetuada e no caso de sucesso, retornará um array contendo a tributação de cada um dos itens solicitados. Detalhamos abaixo os campos do JSON de retorno:

A consulta por EAN retorna os dados tributários do produto através do array tributos. A consulta deve ser efetuada via GET, enviando os parâmentros EAN e Descrição do Produto (além dos parâmetros obrigatórios informados na introdução).

Ao efetuar a consulta, caso o EAN não seja encontrado em nossa base, utilizaremos a "descrição do produto" (passada na consulta) para solicitar automaticamente o cadastro deste item. A equipe tributária será informada sobre a necessidade do cadastro do item e efetuará o quanto antes.

Sugestão de usabilidade e integração:

1. No formulário de cadastro de produtos, ao solicitar um novo item (ou na atualização), efetuar a consulta-ean para capturar os tributos do item;
2. Se o produto for encontrado (o array tributos não é nulo), aplicar os tributos na base de dados do cliente automaticamente. Ou informar que existem tributos do site a serem aplicados ao item, criar uma forma de exibir estes tributos e exigir o "aceite" (forma recomendada);
3. Em todas as consultas, sempre retornaremos o idsegmento. Este é o segmento tributário ao qual o produto pertence e deve ser armazenado na base do cliente. Desta forma, quando seu sistema receber atualizações tributárias de um determinado segmento, saberá quais são os produtos vinculados ao mesmo e que precisam sofrer as alterações necessárias;
4. Se o produto não for encontrado (o array tributos é nulo), informar ao cliente que uma solicitação de cadastro foi enviada para a equipe tributária do site;

Fluxograma de funcionamento:

Utilize o formulário abaixo para efetuar testes de consulta em tempo real em nossa API:

A consulta por NCM retorna os dados tributários dos "segmentos" através do array tributos e seus respectivos produtos vinculados (uma lista com até 100 itens listados em ordem aleatória), através do array produtos. A consulta deve ser efetuada via GET, enviando o parâmentro NCM (além dos parâmetros obrigatórios informados na introdução).

Sugestão de usabilidade e integração:

1. Após efetuar a consulta-ean sem sucesso (o item não foi encontrado), é possivel efetuar a consulta via NCM (geralmente já conhecido se a família ou segmento deste produto já estiver cadastrada na base do cliente);
2. Se algum segmento for encontrado (o array tributos não é nulo), sua retaguarda pode exbir uma tela com os segmentos encontrados (e uma lista com aguns itens vinculados a este segmento: array produtos). Assim, o cliente pode decidir se deseja vincular o seu produto a um destes segmentos tributários do site;

Fluxograma de funcionamento:

Utilize o formulário abaixo para efetuar testes de consulta em tempo real em nossa API:

A consulta por DATA retorna as atualizações tributárias ocorridas nos "segmentos" de produtos.
Ex: Digamos que tenhamos 500 produtos dentro de um mesmo segmento. Todos estes produtos tem exatamente a mesma característica tributária. Desta forma, a API irá listar uma única vez os tributos deste segmento e cabe a sua retaguarda atualizar os produtos vinculados a este segmento. Seja pelo idsegmento (mais indicado) ou NCM.

Importante: Esta consulta deve ser processada diariamente por seu sistema de retaguarda (no começo ou no fim do dia, para checar todas as possíveis alterações tributárias). Caso o cliente tenha tido qualquer problema e não tenha conseguido efetuar esta consulta, é possível informar uma data anterior a até "30 dias". Neste caso, a API irá listar todos as atualizações ocorridas a partir da data informada.

Os tributos são retornados através do array tributos. Pode ocorrer a situação onde um produto fazia parte de um segmento e por algum motivo tributário, teve que ser vinculado a outro segmento. Neste caso, listaremos estes itens atualizados através do array produtos_troca_segmento e informaremos qual era o ID/NCM do antigo segmento e ID/NCM do segmento atual a qual pertence. A consulta deve ser efetuada via GET, enviando o parâmentro DATA (além dos parâmetros obrigatórios informados na introdução).

Sugestão de usabilidade e integração:

1. Efetuar esta consulta automaticamente 1x por dia, todos os dias;
2. Em caso de atualizações encontradas ou produto que sofreu troca de segmento, exibir um relatório ao cliente com todos os itens de sua base que foram afetados por essas atualizações;
3. Criar um botão onde o cliente pode manualmente rodar a verificação de atualização. Desta forma, caso tenha ocorrido qualquer problema na função automática, o cliente continua atualizado;

Fluxograma de funcionamento:

Utilize o formulário abaixo para efetuar testes de consulta em tempo real em nossa API:

O recurso de Revisão Fiscal permite verificar e corrigir os tributos de todos os itens da base de dados do cliente. A cada envio de um lote com os itens do cliente, a API retorna os tributos do item através do array tributos. Em cada item, caso o NCM, ICMS, Pis ou Cofins seja informado, um campo no retorno identifica se houve divergencia entre os tributos no cadastro do cliente e o informado pelo site. Caso algum item não seja encontrado na base do site, uma solicitação de cadastro sera enviada automaticamente para nossa equipe tributária, que providenciará o cadastro o quanto antes.

Após o termino do envio de todos os itens da base do cliente, sua retaguarda pode chamar nossa URL, para que o cliente tenha acesso a um relatório listando todos os itens revisados neste processo, as divergências encontradas, etc.

Sugestão de usabilidade e integração:

1. Cada envio para a API deve conter um lote de até 300 itens por vez. Após o retorno da API, envie mais 300 e repita o processo até revisar toda a base de produtos do cliente;
2. A API irá retornar os dados tributários de cada item no array tributos. Caso você tenha enviado o NCM, ICMS, PIS ou COFINS e alguma dessas informações estejam diferentes da base do site, o campo divergencia será igual a 1;
3. Em todas as consultas, sempre retornaremos o idsegmento. Este é o segmento tributário ao qual o produto pertence e deve ser armazenado na base do cliente. Desta forma, quando seu sistema receber atualizações tributárias de um determinado segmento, saberá quais são os produtos vinculados ao mesmo e que precisam sofrer as alterações necessárias;
4. Os itens não encontrados na base do site ficarão na listagem de pendência da equipe tributária e serão cadastrados o quanto antes;
5. A cada retorno, a API exibirá o campo idrevisao, que passado junto ao token do cliente dá acesso ao relatório de revisão Fiscal em nosso site;
6. URL relatório de Revisao: https://figurafiscal.com.br/v2.0/?direcionador=revisao-fiscal/relatorio.asp?id=idrevisao&token=token

Fluxograma de funcionamento:

Utilize o formulário abaixo para efetuar testes de consulta em tempo real em nossa API:

Nosso sistema oferece aos seus clientes o recurso de Monitoramento de Vendas em Tempo Real. Desta forma, caso o cliente efetue vendas no PDV com alguma informação tributária incorreta, nós monitoramos e notificamos sobre os itens que apresentaram problemas na última venda. Desta forma, o cadastro pode ser corrigido e na próxima venda o erro não ocorrerá.

É o fim das vendas com divergências tributárias!

Nesta função, listamos a tributação correta de todos os itens que apresentaram divergências no monitoramento dentro da última hora. Desta forma, é possível atualizar o cadastro do seu cliente e nas próximas vendas, todos os tributos estarão corrigidos. Automatizamos o processo, o cliente não precisará efetuar estas correções manualmente e estes itens não apresentarão mais divergências.

Sugestão de usabilidade e integração:

1. Efetuar esta consulta de hora em hora;
2. Atualizar os tributos no cadastro do cliente através do Código de Barras e informar em sua base o nosso idsegmento (sempre importante para futuras chegagens de atualizações tributárias);

Fluxograma de funcionamento:

Utilize o formulário abaixo para efetuar testes de consulta em tempo real em nossa API: