APIs principales
Empresas
7 endpoints
/api/company/createRegistrar nueva empresa emisora
Registra una empresa emisora vinculada a una cuenta de distribuidor (b2b). Use este endpoint cuando los datos de la empresa ya estén disponibles. Para extracción automática desde el certificado digital, use /api/company/v2/create.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token del distribuidor (b2b — la cuenta debe tener isb2b=true) |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| Identificación | ||
| cnpj * | string | CNPJ de la empresa emisora |
| name * | string | Razón social |
| ie * | string | Inscripción Estatal (Inscrição Estadual) |
| invoice_type * | string | Régimen tributario (ej.: "simples_nacional", "normal") |
| unit * | string | Tipo de unidad |
| string | Correo electrónico de la empresa | |
| Dirección | ||
| cep * | string | Código postal |
| address * | string | Dirección (calle) |
| house_number * | string | Número de dirección |
| town * | string | Barrio |
| city * | string | Ciudad |
| state * | string | UF (sigla del estado) |
| Certificado digital | ||
| cert_content * | string | Contenido del archivo del certificado A1 (.pfx/.p12) en Base64 |
| cert_file | string | Obsoleto — rechazado a partir del 2026-09-01. URL HTTPS del certificado |
| cert_pwd * | string | Contraseña del certificado |
| Numeración y configuración | ||
| serie * | int | Serie de la NF-e |
| number * | int | Número inicial de la numeración |
| Transporte (MDF-e / CT-e / DC-e) | ||
| serie_mdfe | int | Serie del MDF-e |
| number_mdfe | int | Número inicial del MDF-e (donde empieza la numeración) |
| serie_cte | int | Serie del CT-e |
| number_cte | int | Número inicial del CT-e (donde empieza la numeración) |
| serie_dce | int | Serie de la DC-e |
| number_dce | int | Número inicial de la DC-e (donde empieza la numeración) |
| Comunicación (NFCom) | ||
| serie_nfcom | int | Serie de la NFCom |
| number_nfcom | int | Número inicial de la NFCom (donde empieza la numeración) |
| Energía (NF3e) | ||
| serie_nf3e | int | Serie de la NF3e |
| number_nf3e | int | Número inicial de la NF3e (donde empieza la numeración) |
| is_create_category_template | boolean | Crea categorías fiscales por defecto automáticamente. Default: true |
* Campo obligatorio.
/api/company/v2/createRegistrar empresa por certificado
Versión simplificada de /api/company/create: la API valida el certificado digital y extrae automáticamente razón social, IE, dirección y otros datos mediante consulta interna. Solo cnpj, cert_content y cert_pwd son obligatorios.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token del distribuidor (b2b — la cuenta debe tener isb2b=true) |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| cnpj * | string | CNPJ de la empresa emisora |
| cert_content * | string | Contenido del archivo del certificado A1 (.pfx/.p12) en Base64 |
| cert_file | string | Obsoleto — rechazado a partir del 2026-09-01. URL HTTPS del certificado |
| cert_pwd * | string | Contraseña del certificado |
| is_create_category_template | boolean | Crea categorías fiscales por defecto automáticamente. Default: true |
* Campo obligatorio.
/api/company/editEditar datos de la empresa
Actualiza los datos de la empresa emisora. Envíe solo los campos que desea modificar — todos excepto company_id son opcionales. El CNPJ es inmutable: enviarlo devuelve error. Al actualizar cep, el sistema resuelve automáticamente stateCode e ibge. Cuando cert_content y cert_pwd vienen juntos, el certificado se valida antes de guardar.
La empresa se crea con la configuración de NF-e (vía /api/company/create). Para habilitar los demás documentos, complete el registro por aquí: este endpoint también acepta los campos de NFC-e, NFS-e, MDF-e, CT-e y DC-e (ver secciones más abajo). Envíe solo los campos del/de los documento(s) que la empresa va a emitir.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| company_id * | string | ID de la empresa a editar |
| name | string | Razón social |
| invoice_type | string | Régimen tributario |
| ie | string | Inscripción Estatal |
| unit | string | Tipo de unidad |
| string | Correo electrónico | |
| cep | string | Código postal (actualiza automáticamente stateCode e ibge) |
| address | string | Dirección |
| house_number | string | Número |
| town | string | Barrio |
| city | string | Ciudad |
| state | string | UF |
| cert_content | string | Contenido del archivo del certificado A1 (.pfx/.p12) en Base64 |
| cert_file | string | Obsoleto — rechazado a partir del 2026-09-01. URL HTTPS del certificado |
| cert_pwd | string | Nueva contraseña del certificado |
| serie | int | Nueva serie de la NF-e |
| number | int | Nuevo número inicial |
| alias | string | Nombre comercial |
| telefone | string | Teléfono |
| complemento | string | Complemento del domicilio |
| NFC-e | ||
| csc_id | string | ID del CSC (Código de Seguridad del Contribuyente) en la autoridad fiscal |
| csc | string | Token CSC (secreto compartido con la autoridad fiscal) |
| serie_nfce | int | Serie de la NFC-e |
| number_nfce | int | Número inicial de NFC-e |
| NFS-e | ||
| im | string | Inscripción Municipal |
| codigo_municipio_nfse | string | Código IBGE del municipio emisor |
| codigo_servico_nfse | string | Código de servicio por defecto (LC 116) |
| cnae_nfse | string | CNAE de la actividad por defecto |
| serie_nfse | int | Serie inicial de la NFS-e |
| number_nfse | int | Número inicial de la NFS-e |
| regime_especial_tributacao | int | Código del régimen especial de tributación |
| optante_simples_nacional | bool | Optante por Simples Nacional |
| Transporte (MDF-e / CT-e / DC-e) | ||
| serie_mdfe | int | Serie del MDF-e |
| number_mdfe | int | Número inicial del MDF-e (donde empieza la numeración) |
| serie_cte | int | Serie del CT-e |
| number_cte | int | Número inicial del CT-e (donde empieza la numeración) |
| serie_dce | int | Serie de la DC-e |
| number_dce | int | Número inicial de la DC-e (donde empieza la numeración) |
| Comunicación (NFCom) | ||
| serie_nfcom | int | Serie de la NFCom |
| number_nfcom | int | Número inicial de la NFCom (donde empieza la numeración) |
| Energía (NF3e) | ||
| serie_nf3e | int | Serie de la NF3e |
| number_nf3e | int | Número inicial de la NF3e (donde empieza la numeración) |
* Campo obligatorio. Enviar cnpj devuelve error. Todos los demás campos son opcionales — envíe solo los que desea modificar.
/api/company/get_listListar empresas del distribuidor
Lista, con paginación, las empresas emisoras vinculadas a la cuenta de distribuidor (b2b). Parámetros vía query string.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token del distribuidor (b2b — la cuenta debe tener isb2b=true) |
| sign | string | Firma MD5 (path incluye la query string) |
| timestamp | string | Unix timestamp en segundos |
Query string
| Parámetro | Tipo | Descripción |
|---|---|---|
| page * | int | Número de página (≥ 1) |
| page_size * | int | Tamaño de página (1–20) |
* Campo obligatorio.
/api/company/get_detailDetalles de la empresa autenticada
Devuelve los datos completos de la empresa identificada por el header token, incluida la lista de categorías fiscales registradas. No acepta body ni query string.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
/api/company/get_cep_detailConsultar dirección por CEP
Resuelve un CEP brasileño devolviendo UF, código IBGE del municipio y datos de la dirección. Útil para rellenar direcciones de empresas y clientes. Requiere cuenta de distribuidor (b2b).
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token del distribuidor (b2b — la cuenta debe tener isb2b=true) |
| sign | string | Firma MD5 (path incluye la query string) |
| timestamp | string | Unix timestamp en segundos |
Query string
| Parámetro | Tipo | Descripción |
|---|---|---|
| cep * | string | CEP brasileño (8 dígitos, con o sin guion) |
* Campo obligatorio.
/api/company/get_export_invoice_month_filesListar exportaciones mensuales
Devuelve la lista de archivos de exportación mensual ya generados para la empresa en el año actual (timezone America/Sao_Paulo). Cada mes puede tener hasta 4 archivos: 1 planilla Excel (solo estado Success) + 3 XMLs (por estado Success, Canceled y Voided). Solo aparecen los archivos efectivamente exportados — use /api/invoice/get_xml para generar nuevos.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| files[] | array | Lista de archivos disponibles |
| files[].url | string | URL del archivo en OSS |
| files[].year | int | Año del periodo |
| files[].month | string | Mes (1–12) |
| files[].type | string | Tipo de archivo: "xlsx" o "xml" |
| files[].status | string | Estado de las facturas en el archivo: "Success", "Canceled" o "Voided" |
| files[].create | datetime | Cuándo se generó el archivo |