APIs principais
NCM
2 endpoints
/api/ncm/getConsultar NCM
Devolve um item da nomenclatura NCM oficial pelo código, com a cadeia de descrições do capítulo até o próprio código, a alíquota vinda da tabela de IPI e os CEST em que o código aparece. O código pode ser enviado com ou sem ponto, no código completo de 8 dígitos ou em capítulo (2 dígitos), posição (4 dígitos) e níveis intermediários (5 a 7 dígitos). Esta rota é gratuita.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa emissora |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| ncm | string | Sim | 2, 4, 5, 6, 7 ou 8 dígitos, por exemplo "8517.13.00" ou "85171300" |
Somente o código de 8 dígitos pode constar no item da nota (valido_para_nota igual a true); os níveis de 2 a 7 dígitos são etapas de classificação, úteis para navegar e filtrar, mas não válidos em documento.
A nomenclatura oficial traz código, descrição e vigência, nunca alíquota. O campo ipi vem da tabela de IPI, e excecoes traz as alíquotas de exceção do mesmo código; cest vem da lista de substituição tributária, e constar nessa lista significa que a mercadoria está no alcance em que a substituição pode incidir — se incide de fato depende do acordo entre os dois estados envolvidos.
A descricao de uma folha costuma ser um fragmento como "Outras", ilegível fora do contexto. Prefira descricao_completa ou monte o texto a partir de hierarquia.
A nomenclatura muda de versão a cada ato oficial publicado. Recomenda-se armazenar em cache por versao e ressincronizar quando esse valor mudar.
/api/ncm/listLista de NCM (paginada)
Devolve a nomenclatura NCM oficial página a página. O resultado pode ser recortado por prefixo de código, pesquisado por palavra-chave ou limitado aos códigos de 8 dígitos, os únicos aceitos em nota. Os filtros vão no corpo JSON; todos são opcionais e combináveis, e o corpo vazio ({}) devolve a nomenclatura inteira (mais de quinze mil itens), uma página por vez. Os itens saem sempre em ordem crescente de código. Esta rota é gratuita.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa emissora |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | int | Não | Número da página, a partir de 1; padrão 1 |
| page_size | int | Não | Itens por página; padrão 50, máximo 200 |
| prefixo | string | Não | Prefixo do código, que recorta uma subárvore: 2, 4, 5, 6, 7 ou 8 dígitos. "8517", por exemplo, devolve todos os códigos daquela posição |
| termo | string | Não | Palavra-chave procurada na descrição completa; mínimo de 2 caracteres. A busca percorre a cadeia inteira, então, quando a palavra está no título de um nível superior, toda a subárvore volta; use prefixo ou somente_folhas para estreitar |
| somente_folhas | string | Não | Envie "1" para devolver apenas os códigos de 8 dígitos, único nível aceito no item da nota |
| incluir_extintos | string | Não | Envie "1" para incluir códigos já extintos; por padrão só voltam os vigentes |
| incluir_impostos | string | Não | Envie "0" para omitir ipi e cest e reduzir a resposta; por padrão vêm incluídos |
| incluir_hierarquia | string | Não | Envie "0" para omitir hierarquia e reduzir a resposta; por padrão vem incluída |
Somente o código de 8 dígitos pode constar no item da nota (valido_para_nota igual a true); os níveis de 2 a 7 dígitos são etapas de classificação, úteis para navegar e filtrar, mas não válidos em documento.
A nomenclatura oficial traz código, descrição e vigência, nunca alíquota. O campo ipi vem da tabela de IPI, e excecoes traz as alíquotas de exceção do mesmo código; cest vem da lista de substituição tributária, e constar nessa lista significa que a mercadoria está no alcance em que a substituição pode incidir — se incide de fato depende do acordo entre os dois estados envolvidos.
A descricao de uma folha costuma ser um fragmento como "Outras", ilegível fora do contexto. Prefira descricao_completa ou monte o texto a partir de hierarquia.
A nomenclatura muda de versão a cada ato oficial publicado. Recomenda-se armazenar em cache por versao e ressincronizar quando esse valor mudar.