APIs principais
CFOP
2 endpoints
/api/cfop/getConsultar CFOP
Devolve um código da tabela oficial de CFOP publicada pelo Portal da NF-e (Informe Técnico 2023.002), com todas as colunas: título e nota explicativa do Fisco, vigência, os nove indicadores da tabela, além de tipo (entrada ou saída), abrangência e grupo. A tabela é mantida pela plataforma: quando o Fisco publica versão nova, a atualização entra sem mudança na integração, e o campo versao indica a versão em uso. Parâmetro passado no body em JSON. Códigos extintos continuam consultáveis, com ativo = false. Consulta 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 | Descrição |
|---|---|---|
| cfop * | string | Código com 4 dígitos, com ou sem ponto ("5101" ou "5.101") |
* Campo obrigatório.
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| cfop | string | Código com 4 dígitos, sem ponto |
| descricao | string | "Título do CFOP" da tabela oficial, em português |
| nota_explicativa | string | "Descrição (nota explicativa)" da tabela oficial: o que se classifica no código |
| serie | int | Primeiro dígito: 1, 2, 3 (entradas) ou 5, 6, 7 (saídas) |
| tipo | string | entrada ou saida |
| abrangencia | string | intraestadual (séries 1 e 5), interestadual (2 e 6) ou exterior (3 e 7) |
| grupo | string | Grupo da tabela oficial (5.100, 5.200, 5.400...) |
| grupo_descricao | string | Título oficial do grupo |
| vigencia_inicio | string | Início de vigência do código (aaaa-mm-dd) |
| vigencia_fim | string | Fim de vigência (aaaa-mm-dd); vazio = sem fim previsto |
| ind_nfe | int | 1 = código admitido na NF-e (modelo 55) |
| ind_comunica | int | 1 = prestação de serviço de comunicação |
| ind_transp | int | 1 = prestação de serviço de transporte |
| ind_devol | int | 1 = devolução de mercadoria |
| ind_retor | int | 1 = retorno de mercadoria remetida anteriormente |
| ind_anula | int | 1 = anulação de valor |
| ind_remes | int | 1 = remessa de mercadoria |
| ind_comb | int | Indicador de combustíveis e lubrificantes da tabela oficial (0 = não; 1 e 2 conforme o Informe Técnico) |
| ind_exc_ibscbs | int | Indicador IBS/CBS da tabela oficial (0 ou 1), repassado como publicado |
| ativo | bool | false = código extinto (fim de vigência no passado ou retirado da tabela); mantido para documentos antigos |
| versao | string | Versão da tabela em uso (versão do Informe Técnico) |
| fonte | string | Nome da fonte oficial |
/api/cfop/listListar CFOP
Devolve a tabela oficial de CFOP, com filtros opcionais por série (primeiro dígito), tipo e abrangência, passados no body em JSON. Todos os filtros são opcionais e combináveis; body vazio ({}) devolve a tabela inteira (cerca de 620 códigos, com todas as colunas), adequada para montar um dropdown ou um cache local, atualizado quando versao mudar. Os itens saem sempre em ordem crescente de CFOP. A série já determina tipo e abrangência (série 5 é sempre saída dentro do estado), então os três filtros se sobrepõem; uma combinação contraditória devolve lista vazia. Por padrão só códigos ativos. Consulta 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 | Descrição |
|---|---|---|
| serie | string | Primeiro dígito: "1", "2", "3", "5", "6" ou "7" |
| tipo | string | "entrada" ou "saida" |
| abrangencia | string | "intraestadual", "interestadual" ou "exterior" |
| incluir_inativos | string | "1" para devolver também os códigos extintos (ativo = false) |
Todos os campos são opcionais. Sem nenhum deles, envie {}.
Cada item tem os mesmos campos de /api/cfop/get, com a nota explicativa completa, sempre em ordem crescente de CFOP. versao e fonte identificam a versão da tabela em uso; total é a quantidade de itens devolvidos.