Documentação Geral

Vale a pena relembrar


    Vale a pena relembrar

     

    API

    API NCM – Como realizar a consulta

    Por Pedro Silva

     

    A API NCM permite realizar consultas das NCM que estão na tabela TIPI,  utilizando a NCM (nomenclatura comum do mercosul)  como chave primária para busca, ao realizar a chamada a API retornará todas as informações disponíveis na tabela TIPI, como vigências, alíquotas, exceções e informações complementares da legislação.

    Como realizar a chamada?

    1. O usuário deverá realizar a autenticação da API via Bearer Token, utilizando o usuário e senha fornecidos pela Systax.

     

    1. Após a autenticação, a chamada é realizada no formato JSON, a consulta é realizada por NCM, a tag “vigência_em”, deverá ser preenchida caso esteja buscando a partir de uma data específica, já a tag “ex_tipi” deve ser preenchida caso você queira buscar somente a exceção, se ela não for preenchida, o sistema vai retornar todos os registros para a NCM informada com ou sem exceção.

     

    1. A API vai retornar uma mensagem de sucesso, e a quantidade de registros para a NCM informada.

     

     

    1. Abaixo do campo data, a API detalha todas as informações dos registros cadastrados para aquela NCM, o campo “ID”, traz o número do registro correspondente da tabela TIPI interna da Systax, o campo “ex_tipi” informa a exceção conforme tabela TIPI, o campo “vigência_de” e “vigência_ate”, informam as datas de vigência da legislação conforme tabela TIPI, no campo “aliquota”, é informada a alíquota do IPI, depois temos o campo “descrição”, que traz um descritivo da NCM, e o último campo “nota” é utilizado caso tenha alguma informação complementar referente à legislação.

     


    URL da documentação:

    https://documentacao.systax.com.br/PublicView2/Index/0c79038da86fb7b859b279f2f/66654

     

    A importância deste documento é demonstrar, de forma prática, como realizar uma consulta às informações da NCM, de acordo com a tabela TIPI.

    Voltar


Versão do documento: 43 Publicação: 9/8/2023 7