APIs principales
CFOP
2 endpoints
/api/cfop/getConsultar CFOP
Devuelve un código de la tabla oficial de CFOP publicada por el Portal de la NF-e (Informe Técnico 2023.002), con todas las columnas: título y nota explicativa de la autoridad fiscal, vigencia, los nueve indicadores de la tabla, además de tipo (entrada o salida), alcance y grupo. La plataforma mantiene la tabla: cuando la autoridad fiscal publica una versión nueva, la actualización se aplica sin cambios en la integración, y el campo versao indica la versión en uso. Parámetro enviado en el body en JSON. Los códigos extintos siguen consultables, con ativo = false. Consulta gratuita.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa emisora |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| cfop * | string | Código de 4 dígitos, con o sin punto ("5101" o "5.101") |
* Campo obligatorio.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| cfop | string | Código de 4 dígitos, sin punto |
| descricao | string | "Título do CFOP" de la tabla oficial (portugués) |
| nota_explicativa | string | "Descrição (nota explicativa)" de la tabla oficial: qué se clasifica en el código (portugués) |
| serie | int | Primer dígito: 1, 2, 3 (entradas) o 5, 6, 7 (salidas) |
| tipo | string | entrada o saida (salida) |
| abrangencia | string | intraestadual (mismo estado; series 1 y 5), interestadual (2 y 6) o exterior (3 y 7) |
| grupo | string | Grupo de la tabla oficial (5.100, 5.200, 5.400...) |
| grupo_descricao | string | Título oficial del grupo (portugués) |
| vigencia_inicio | string | Inicio de vigencia (aaaa-mm-dd) |
| vigencia_fim | string | Fin de vigencia (aaaa-mm-dd); vacío = sin fin previsto |
| ind_nfe | int | 1 = código admitido en la NF-e (modelo 55) |
| ind_comunica | int | 1 = prestación de servicio de comunicación |
| ind_transp | int | 1 = prestación de servicio de transporte |
| ind_devol | int | 1 = devolución de mercancía |
| ind_retor | int | 1 = retorno de mercancía enviada anteriormente |
| ind_anula | int | 1 = anulación de valor |
| ind_remes | int | 1 = remesa de mercancía |
| ind_comb | int | Indicador de combustibles y lubricantes de la tabla oficial (0 = no; 1 y 2 según el Informe Técnico) |
| ind_exc_ibscbs | int | Indicador IBS/CBS de la tabla oficial (0 o 1), tal como fue publicado |
| ativo | bool | false = código extinto (vigencia terminada o retirado de la tabla); se mantiene para documentos antiguos |
| versao | string | Versión de la tabla en uso (versión del Informe Técnico) |
| fonte | string | Nombre de la fuente oficial |
/api/cfop/listListar CFOP
Devuelve la tabla oficial de CFOP, con filtros opcionales por serie (primer dígito), tipo y alcance, enviados en el body en JSON. Todos los filtros son opcionales y combinables; body vacío ({}) devuelve la tabla completa (unos 620 códigos, con todas las columnas), adecuada para poblar un desplegable o una caché local, actualizada cuando cambie versao. Los items salen siempre en orden creciente de CFOP. La serie ya determina tipo y alcance (la serie 5 es siempre salida dentro del estado), por lo que los tres filtros se superponen; una combinación contradictoria devuelve lista vacía. Por defecto solo códigos activos. Consulta gratuita.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa emisora |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| serie | string | Primer dígito: "1", "2", "3", "5", "6" o "7" |
| tipo | string | "entrada" o "saida" (salida) |
| abrangencia | string | "intraestadual", "interestadual" o "exterior" |
| incluir_inativos | string | "1" para devolver también los códigos extintos (ativo = false) |
Todos los campos son opcionales. Sin ninguno de ellos, envíe {}.
Cada item tiene los mismos campos que /api/cfop/get, incluida la nota explicativa completa, siempre en orden creciente de CFOP. versao y fonte identifican la versión de la tabla en uso; total es la cantidad de items devueltos.