APIs principales
NFC-e
15 endpoints
/api/nfce/company/createRegistrar empresa para NFC-e
Registra (o actualiza) una empresa para la emisión de NFC-e. Razón social, IE, dirección y otros datos se extraen automáticamente vía SintegraWS a partir del CNPJ. Si el CNPJ ya existe para el usuario, se actualizan los campos NFC-e y se devuelve la empresa existente.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token del distribuidor (b2b) |
| 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 |
| 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 |
| telefone | string | Teléfono de la empresa |
* Campo obligatorio. Los demás datos (nombre, IE, dirección, etc.) se extraen automáticamente vía SintegraWS desde el CNPJ.
/api/nfce/company/updateActualizar empresa NFC-e
Actualiza la empresa NFC-e identificada por el header token. Todos los campos del body son opcionales — envíe solo los que desee modificar. 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.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body (todos los campos opcionales — envíe ≥ 1)
| Campo | Tipo | Descripción |
|---|---|---|
| Identificación | ||
| name | string | Razón social |
| alias | string | Nombre comercial |
| ie | string | Inscripción Estatal |
| invoice_type | string | Régimen tributario |
| string | Correo electrónico | |
| telefone | string | Teléfono |
| Dirección | ||
| cep | string | Código postal (actualiza automáticamente stateCode e ibge) |
| address | string | Dirección |
| house_number | string | Número |
| complemento | string | Complemento |
| town | string | Barrio |
| city | string | Ciudad |
| state | string | UF |
| NFC-e | ||
| csc_id | string | ID del CSC |
| csc | string | Token CSC |
| serie_nfce | int | Serie |
| number_nfce | int | Próximo número |
| 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 |
Al menos 1 campo en el body es obligatorio. CNPJ es inmutable.
/api/nfce/company/getConsultar empresa NFC-e
Devuelve los datos de la empresa NFC-e identificada por el header token. Atención: el método es POST pero no hay campos en el body — la empresa se resuelve solo por el token.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
Vacío. Puede enviarse {}.
Gestión de Categorías Fiscales NFC-e
Las categorías fiscales definen las reglas tributarias aplicadas a los productos al emitir NFC-e. A diferencia de la NFe, la NFC-e solo opera con ventas intraestatales, por lo que la estructura es simplificada: un solo objeto por impuesto, sin necesidad de múltiples escenarios.
token, sign y timestamp.
/api/nfce/category/createCrear categoría fiscal NFC-e
Crea una categoría fiscal NFC-e. Cada categoría tiene un único escenario (salida interna) y usa objetos planos para ICMS, PIS, COFINS e IBS/CBS (sin array, ya que NFC-e no permite múltiples escenarios por categoría). No incluye IPI.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body (raíz)
| Campo | Tipo | Descripción |
|---|---|---|
| descricao * | string | Descripción de la categoría |
| codigo_cfop * | string | Código CFOP (ej.: 5102, 5405) |
| icms * | object | Configuración de ICMS (objeto plano) |
| pis * | object | Configuración de PIS (objeto plano) |
| cofins * | object | Configuración de COFINS (objeto plano) |
| ibs_cbs | object | Configuración de IBS/CBS (Reforma Tributaria, opcional) |
| desconta_icms_pis_cofins | boolean | Descuenta el ICMS antes de calcular PIS/COFINS — tributa (importe − ICMS), estándar actual en Brasil; por defecto false (sin descuento, impuesto mayor) |
icms
| Campo | Tipo | Descripción |
|---|---|---|
| situacao_tributaria * | string | CST/CSOSN (ej.: 102, 500) |
| aliquota_reducao | decimal | Porcentaje de reducción de base |
| aliquota_reducao_st | decimal | Porcentaje de reducción de la base del ICMS-ST |
| aliquota_credito | decimal | Alícuota de crédito del Simples Nacional en % (CSOSN 101, 201, 900) |
| aliquota_diferimento | decimal | Porcentaje de diferimiento del ICMS (CST 51) |
| motivo_desoneracao | string | Código del motivo de exoneración |
| ad_rem_icms | decimal | ICMS monofásico — alícuota ad rem en R$/unidad (CST 02, 15, 53) |
| ad_rem_icms_ret | decimal | ICMS monofásico — ad rem retenido en R$/unidad (CST 15, 61) |
| p_dif_mono | decimal | ICMS monofásico — porcentaje de diferimiento (CST 53) |
| q_bc_mono | decimal | ICMS monofásico — cantidad tributada (litros/kg); 0 usa la cantidad del ítem (CST 02, 15, 53) |
| valor_desoneracao | decimal | Valor del ICMS exonerado en BRL — emite vICMSDeson (CST 40, 41, 50, 90) |
| v_bc_st_ret | decimal | Base de cálculo del ICMS-ST retenido en la operación anterior (informado, no calculado — CST 60, CSOSN 500) |
| p_st | decimal | Alícuota soportada por el consumidor final en % (informado, no calculado — CST 60, CSOSN 500) |
| v_icms_st_ret | decimal | Valor del ICMS-ST retenido en la operación anterior (informado, no calculado — CST 60, CSOSN 500) |
| v_icms_substituto | decimal | Valor del ICMS propio del sustituto (informado, no calculado — CST 60, CSOSN 500) |
| v_bc_fcp_st_ret | decimal | Base de cálculo del FCP retenido por ST (informado, no calculado — CST 60, CSOSN 500) |
| p_fcp_st_ret | decimal | Alícuota del FCP retenido por ST en % (informado, no calculado — CST 60, CSOSN 500) |
| v_fcp_st_ret | decimal | Valor del FCP retenido por ST (informado, no calculado — CST 60, CSOSN 500) |
| aliquota_icms | array | Alícuotas por estado: [{ "estado": "SP", "aliquota": 18.00 }] |
| aliquota_icms_st | array | Alícuota ICMS-ST por estado: [{ "estado": "SP", "aliquota": 18.00 }] |
| aliquota_mva | array | MVA/IVA-ST por estado: [{ "estado": "SP", "aliquota": 40.00 }] |
| aliquota_fcp | array | FCP por estado: [{ "estado": "SP", "aliquota": 0.00 }] |
| aliquota_fcp_st | array | FCP-ST por estado: [{ "estado": "SP", "aliquota": 0.00 }] |
| beneficio_fiscal | array | Beneficio fiscal por estado: [{ "estado": "SP", "codigo": "SP800001" }] |
pis / cofins
| Campo | Tipo | Descripción |
|---|---|---|
| situacao_tributaria * | string | CST PIS/COFINS |
| aliquota * | string | Alícuota porcentual (ej.: "0.00", "1.65", "7.60") |
| valor_unidade | string | PIS/COFINS por cantidad — valor en R$/unidad; v = cantidad × valor (CST 03 y demás formas por cantidad) |
ibs_cbs (opcional)
| Campo | Tipo | Descripción |
|---|---|---|
| situacao_tributaria * | string | CST IBS/CBS |
| classificacao_tributaria * | string | Código de clasificación tributaria |
| p_ibs_uf | string | Alícuota del IBS estatal en % (opcional; vacío usa el valor por defecto de transición, 0,10 en 2026). Acepta punto o coma |
| p_ibs_mun | string | Alícuota del IBS municipal en % (opcional; por defecto 0 en 2026) |
| p_cbs | string | Alícuota de la CBS en % (opcional; por defecto 0,90 en 2026) |
| p_red_aliq | string | Porcentaje de reducción de alícuota (CST 011, 200, 515) |
| p_dif | string | Porcentaje de diferimiento (CST 510, 515) |
| p_red_bc | string | Porcentaje de reducción de la base de cálculo (CST 222) |
| proporcao | string | Proporción de la operación en % (CST 221) |
| aliquota_cbs_mono | string | CBS monofásica — alícuota en % sobre la base; prevalece sobre valor_unidade_cbs (CST 620) |
| aliquota_ibs_mono | string | IBS monofásico — alícuota en % sobre la base; prevalece sobre valor_unidade_ibs (CST 620) |
| valor_unidade_cbs | string | CBS monofásica — ad rem en R$/unidad; solo se usa cuando no hay alícuota porcentual (CST 620) |
| valor_unidade_ibs | string | IBS monofásico — ad rem en R$/unidad; solo se usa cuando no hay alícuota porcentual (CST 620) |
| valor_deducao_legal | string | Valor de la deducción legal de la base en R$ (CST 830) |
* Campo obligatorio.
/api/nfce/category/get_detailObtener categoría fiscal NFC-e
Devuelve los datos completos de una categoría fiscal NFC-e (descripción, CFOP, ICMS, PIS, COFINS y IBS/CBS).
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Query string
| Campo | Tipo | Descripción |
|---|---|---|
| category_id * | string | ID de la categoría NFC-e |
* Campo obligatorio.
/api/nfce/category/get_listListar categorías fiscales NFC-e
Devuelve una lista paginada de categorías fiscales NFC-e registradas para la empresa autenticada.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Query string
| Campo | Tipo | Descripción |
|---|---|---|
| page * | int | Número de página (mínimo 1) |
| page_size * | int | Ítems por página (1 a 50) |
* Campo obligatorio.
/api/nfce/category/editEditar categoría fiscal NFC-e
/api/nfce/category/create, con el campo adicional obligatorio category_id. Los campos icms, pis, cofins y ibs_cbs se reemplazan íntegramente (no se fusionan).
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Campo adicional
| Campo | Tipo | Descripción |
|---|---|---|
| category_id * | string | ID de la categoría a editar |
* Campo obligatorio.
/api/nfce/category/deleteEliminar categoría fiscal NFC-e
Elimina una categoría fiscal NFC-e. Operación irreversible. Los productos vinculados a esta categoría seguirán referenciando el category_id eliminado — actualícelos primero.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5 |
| timestamp | string | Unix timestamp en segundos |
Body
| Campo | Tipo | Descripción |
|---|---|---|
| category_id * | string | ID de la categoría NFC-e a eliminar |
* Campo obligatorio.
/api/nfce/createEmitir NFC-e
Emite una NFC-e (modelo 65, siempre salida interna al estado, sin flete). Diferencias clave respecto al endpoint de NFe: el objeto del consumidor se llama client (no cliente); el número del domicilio es client.number; el consumidor es opcional; no existen impostos.ipi, shipping_address, delivery_address ni transportation. El campo de valor en pag_info se llama amount.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa NFC-e |
| sign | string | Firma MD5: MD5(token + path + body + timestamp) |
| timestamp | string | Unix timestamp en segundos (ventana de 5 minutos) |
Body (raíz)
| Campo | Tipo | Descripción |
|---|---|---|
| nature_of_operation * | string | Naturaleza de la operación (ej.: "Venta de mercadería") |
| issuance_type * | string | Tipo de emisión: "1" (normal), "9" (contingencia off-line NFC-e) |
| ambiente * | string | "1" producción, "2" homologación |
| products * | array | Lista de productos (ver detalles abajo) |
| id | string | Identificador externo |
| ind_pres | string | Presencia del comprador: "1" presencial (default), "4" entrega a domicilio, "5" presencial fuera del establecimiento, "9" no aplica |
| ind_intermed | string | "0" sin intermediario, "1" marketplace. Obligatorio cuando ind_pres = 2, 3 o 4 |
| total_discount_amount | decimal | Descuento total de la factura |
| troco | decimal | Valor del vuelto |
| seguro | decimal | Valor del seguro |
| outras_despesas | decimal | Otros gastos accesorios |
| informacoes_complementares | string | Información complementaria al consumidor |
| informacoes_fisco | string | Información de interés fiscal |
| client | object | Datos del consumidor (opcional — ver tabla) |
| pag_info | array | Pagos (default: dinero al contado — ver tabla) |
client (opcional)
Complete solo si el consumidor está identificado. CPF o CNPJ deben enviarse solo con dígitos.
| Campo | Tipo | Descripción |
|---|---|---|
| cpf | string | CPF (define persona física) |
| cnpj | string | CNPJ (persona jurídica) |
| ie | string | Inscripción estatal |
| name | string | Nombre / razón social |
| endereco | string | Dirección |
| number | string | Número del domicilio (atención: distinto de la NFe, que usa numero) |
| complemento | string | Complemento |
| bairro | string | Barrio |
| city | string | Ciudad |
| uf | string | UF (validada por el CEP, si se informa) |
| cep | string | Código postal (solo dígitos) |
| telefone | string | Teléfono |
| string |
products[] (cada ítem)
| Campo | Tipo | Descripción |
|---|---|---|
| name * | string | Nombre del producto (caracteres CJK se eliminan) |
| ncm * | string | NCM (8 dígitos) |
| count * | decimal | Cantidad |
| unit * | string | Unidad comercial (ej.: "UN", "KG") |
| unit_price * | decimal | Precio unitario |
| total_price * | decimal | Valor total del ítem |
| origem * | int | Origen de la mercadería (0..8) |
| indicador_total * | int | 1 = compone el total de la factura; 0 = no compone |
| category_id ⚠ | string | ID de categoría fiscal NFC-e (obligatorio si no envía impostos) |
| impostos ⚠ | object | Impuestos manuales (alternativa a category_id; sin IPI) |
| codigo | string | Código interno del producto |
| cest | string | CEST |
| gtin | string | GTIN/EAN comercial |
| gtin_tributavel | string | GTIN tributable |
| discount_price | decimal | Descuento del ítem |
| nItemPed | int | Ítem del Pedido de Compra (I61). Número secuencial del ítem dentro del pedido referenciado en xPed (viene de id de raíz). Valores válidos: 1–999999. Default: omitido. |
pag_info[] (cada ítem)
| Campo | Tipo | Descripción |
|---|---|---|
| payment_indicator * | string | "0" contado, "1" a crédito |
| payment_method * | string | Forma de pago (01=efectivo, 03=tarjeta crédito, 04=tarjeta débito, 17=PIX, 99=otros, etc.) |
| amount | decimal | Monto pagado en esta forma |
| card_info.integration_type | string | "1" integrado, "2" no integrado (obligatorio para tarjeta 03/04) |
| card_info.brand_code | string | Marca de la tarjeta (obligatorio para tarjeta 03/04) |
| card_info.acquirer_cnpj | string | CNPJ del adquirente |
| card_info.authorization_code | string | Código de autorización |
* Campo obligatorio. ⚠ category_id o impostos, uno de los dos es obligatorio.
Campos de la respuesta (data)
| Campo | Tipo | Descripción |
|---|---|---|
| uuid | string | Identificador interno de la NFC-e. Úselo en las consultas siguientes (/api/nfce/get_detail, /api/nfce/get_danfe) |
| status | string | Situación: "Success" (autorizada), "Failed" (rechazada/fallo), "Contingencia" (emitida en contingencia offline, pendiente de transmisión) |
| motivo | string | Mensaje oficial de la autoridad fiscal según el cStat (formato bilingüe PT / 中文) |
| nfce | int | Número de la NFC-e emitida (atención: el campo se llama nfce, no nfe) |
| serie | int | Serie de la NFC-e |
| chave | string | Clave de acceso de 44 dígitos (vacía cuando la nota no fue autorizada) |
| modelo | string | Modelo del documento: "nfce" |
| xml | string | URL del XML autorizado |
| danfe | string | URL del DANFE NFC-e — vacío en la emisión; genérelo bajo demanda con /api/nfce/get_danfe |
issuance_type = "9" o autoridad fiscal indisponible), la respuesta viene con status: "Contingencia" y los campos extra contingencia: true y tpEmis: 9; la nota debe transmitirse a la autoridad fiscal después.
Respuesta — rechazo / error
success es false y data.motivo indica el motivo; la chave vuelve vacía. Los errores de validación de campos (antes de llegar a la autoridad fiscal) devuelven success: false con el mensaje en message, sin el objeto data.
{
"success": false,
"data": {
"uuid": "65f8b9a1c2d3e4f5a6b7c8d9",
"status": "Failed",
"motivo": "Rejeição 226: Código da UF do Emitente diverge da UF autorizadora / 拒绝 226: 发件人所在州代码与授权州不一致",
"nfce": 5,
"serie": 1,
"chave": "",
"modelo": "nfce",
"xml": "",
"danfe": ""
}
}/api/nfce/cancelCancelar NFC-e
Cancela una NFC-e ya autorizada. A diferencia de la NFe, aquí el motivo de la cancelación lo proporciona el cliente y se envía a la autoridad fiscal. La ventana de cancelación en la autoridad fiscal es corta (normalmente 15-30 minutos tras la autorización).
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 |
|---|---|---|
| chave * | string | Clave de 44 dígitos de la NFC-e (atención: aquí es chave, no uuid como en otros endpoints) |
| motivo * | string | Justificación de la cancelación (mínimo 15 caracteres por exigencia autoridad fiscal) |
* Campo obligatorio.
Campos de la respuesta (data)
| Campo | Tipo | Descripción |
|---|---|---|
| motivo | string | Mensaje oficial de la autoridad fiscal para el evento de cancelación |
| status | string | Situación: "Canceled" (cancelada) |
| nfce | int | Número de la NFC-e cancelada |
| serie | int | Serie de la NFC-e |
| chave | string | Clave de acceso de 44 dígitos |
| modelo | string | Modelo del documento: "nfce" |
| cStat | int | Código del evento en la autoridad fiscal: 135 o 155 = cancelación homologada. Si la NFC-e ya estaba cancelada, la respuesta de éxito viene sin cStat |
Respuesta — error
success es false y data viene con status: "Failed" y el cStat del rechazo. Los errores de validación (chave/motivo ausentes, motivo con menos de 15 caracteres, NFC-e no encontrada, contingencia aún no transmitida) devuelven success: false con el mensaje en message, sin el objeto data.
{
"success": false,
"data": {
"motivo": "Rejeição: Pedido de Cancelamento intempestivo",
"status": "Failed",
"nfce": 5,
"serie": 1,
"chave": "35210112345678901234650010000000051234567890",
"modelo": "nfce",
"cStat": 501
}
}/api/nfce/returnDevolver NFC-e
Emite la devolución de una NFC-e autorizada. La devolución es una NF-e de entrada (modelo 55) que referencia en su XML la clave de acceso de la NFC-e original; la NFC-e no cuenta con un documento de devolución propio. El documento original se localiza entre los registros de NFC-e por uuid o chave, y los artículos y campos tributarios se toman de él. /api/invoice/return solo busca entre las NF-e y responde "la factura no existe" para cualquier NFC-e; utilice esta ruta.
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 | Obligatorio | Descripción |
|---|---|---|---|
| uuid | string | No | uuid de la NFC-e original. Indique este campo o chave |
| chave | string | No | Clave de acceso de 44 dígitos de la NFC-e original. Indique este campo o uuid |
| cfop | string | Sí | CFOP de la devolución; habitualmente 1202 dentro del estado y 2202 entre estados |
| natureza_operacao | string | No | Naturaleza de la operación. Valor predeterminado Devolução de Mercadoria |
| cliente | object | No | Destinatario, es decir, el comprador del documento original. Campos: cpf, cnpj, name, endereco, numero, complemento, bairro, city, uf, cep, email, telefone. Los campos enviados sustituyen a los del original; los omitidos se conservan |
La devolución es una NF-e y la dirección del destinatario es obligatoria, mientras que la NFC-e normalmente no registra la dirección del comprador. Cuando el XML original no contiene dirección, cliente debe incluir endereco, bairro, city, uf y cep; la ruta indica cuáles faltan.
Solo puede devolverse una NFC-e autorizada. El entorno (producción o pruebas) sigue al del documento original y no se envía como parámetro.
Las llamadas repetidas no emiten dos veces: si ya existe una devolución para el mismo original en el mismo entorno, se devuelve ese documento.
La devolución es total. Los artículos, cantidades y campos tributarios provienen del original; los tributos se resuelven primero por la categoría fiscal y, a falta de ella, se copian del CST y las alícuotas del XML original.
Campos de la respuesta (data)
| Campo | Tipo | Descripción |
|---|---|---|
| uuid | string | Identificador del documento de devolución |
| status | string | Success autorizado, Failed rechazado |
| motivo | string | Mensaje devuelto por la autoridad fiscal |
| nfe | int | Número del documento de devolución |
| serie | int | Serie del documento de devolución |
| chave | string | Clave de acceso de 44 dígitos del documento de devolución |
| modelo | string | Siempre nfe: la devolución es una NF-e |
| epec | boolean | Si la emisión se realizó en contingencia |
| xml | string | URL del XML del documento de devolución |
Respuesta — error
success es false, el motivo viene en message y no hay data. Cuando la autoridad fiscal rechaza el documento, success también es false, pero data está presente con status igual a Failed y el motivo en motivo. {
"success": false,
"message": "A devolução é uma NF-e e exige o endereço do comprador; a NFC-e original não o traz. Informe em cliente: endereco, bairro, city, uf, cep / 退货票是 NF-e,必须有买方地址,原 NFC-e 没有。请在 cliente 里传:endereco、bairro、city、uf、cep"
}/api/nfce/get_detailConsultar detalles de la NFC-e
Devuelve los detalles de una NFC-e específica por UUID. Incluye URLs del XML y del DANFE (cupón térmico), además de los datos del cliente cuando se proporcionan.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa emisora |
| sign | string | Firma MD5 (path incluye la query string) |
| timestamp | string | Unix timestamp en segundos |
Query string
| Parámetro | Tipo | Descripción |
|---|---|---|
| uuid * | string | UUID de la NFC-e |
* Campo obligatorio.
/api/nfce/get_danfeObtener DANFE de la NFC-e
Devuelve la URL del DANFE NFC-e (cupón fiscal electrónico) en PDF, con código QR para consulta en la autoridad fiscal. Generación bajo demanda con caché por hash (clave + estado); las llamadas repetidas devuelven la URL existente.
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 |
|---|---|---|
| uuid * | string | UUID de la NFC-e (atención: aquí es uuid, a diferencia de cancel que usa chave) |
* Campo obligatorio.
/api/nfce/get_listListar NFC-e (paginado)
Lista las NFC-e de la empresa con paginación. Los parámetros se pasan por query string (no en el body). El filtro de tiempo es opcional, pero si se envía requiere tanto start_create_time como end_create_time.
Headers obligatorios
| Header | Tipo | Descripción |
|---|---|---|
| token | string | Token de la empresa emisora |
| 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–50) |
| start_create_time | long | Unix timestamp en milisegundos — inicio (requiere end_create_time) |
| end_create_time | long | Unix timestamp en milisegundos — fin |
| status | string | Filtrar por estado. Valores: "Success" (autorizada), "Canceled" (cancelada), "Processing" (en proceso), "Failed" (falló), "Unknown" (desconocida) |
* Campo obligatorio.
/api/nfce/exportExportar NFC-e en lote
Exporta en lote las NFC-e de producción de la empresa por período (las notas de homologación no entran). La generación es asíncrona: la primera llamada dispara la exportación y responde "status": "Processing"; repita la misma llamada (mismo body) hasta recibir "status": "Success" con la url de descarga. XML y PDF salen en .zip (un archivo por nota); la planilla sale en .xlsx o .csv. El resultado vale por 10 días: en ese plazo, los mismos parámetros devuelven el mismo archivo (las notas emitidas después de la generación no entran — use otro período para generar un archivo nuevo).
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 |
|---|---|---|
| type * | string | "xml" (ZIP de XMLs), "pdf" (ZIP de DANFEs) o "sheet" (planilla) |
| start_create_time | string | Fecha inicial dd/MM/yyyy, hora de Brasilia — el período comienza a las 00:00:00 de ese día |
| end_create_time | string | Fecha final dd/MM/yyyy — el día final entra completo (hasta las 23:59:59) |
| month | int | Alternativa al período: mes completo (1–12, hora de Brasilia); mes mayor que el actual = año pasado |
| status | string | "all" (predeterminado), "emitida", "cancelada" o "contingencia" |
| pattern | string | Para sheet: "xlsx" (predeterminado) o "csv". Para pdf: ancho del cupón en mm — "80" (predeterminado), "72" o "50" |
* Campo obligatorio. Informe el período con start_create_time + end_create_time o con month.
Ejemplo 1 — Venta Presencial (sin destinatario)
{
"nature_of_operation": "Venda de mercadoria",
"ambiente": "2",
"ind_pres": "1",
"products": [
{
"codigo": "001",
"name": "Refrigerante 350ml",
"ncm": "22021000",
"count": 3,
"unit": "matriz",
"unit_price": 5.50,
"total_price": 16.50,
"category_id": "BEBIDAS_PADRAO",
"origem": "0",
"indicador_total": "1",
"cfop": "5102"
}
],
"pag_info": [
{ "payment_indicator": "0", "payment_method": "17" }
]
}Ejemplo 2 — Entrega a Domicilio (con destinatario)
{
"nature_of_operation": "Venda de mercadoria",
"ambiente": "2",
"ind_pres": "4",
"client": {
"cpf": "12345678900",
"name": "Maria Silva",
"endereco": "Rua das Flores",
"number": "456",
"bairro": "Jardim Primavera",
"city": "São Paulo",
"uf": "SP",
"cep": "04567000"
},
"products": [
{
"codigo": "PIZZA01",
"name": "Pizza Grande Marguerita",
"ncm": "19059090",
"count": 1,
"unit": "matriz",
"unit_price": 45.90,
"total_price": 45.90,
"category_id": "ALIMENTOS",
"origem": "0",
"indicador_total": "1",
"cfop": "5102"
}
],
"pag_info": [
{ "payment_indicator": "0", "payment_method": "03" }
],
"frete": 8.00,
"informacoes_complementares": "Entrega em até 40 minutos"
}