Skip to content
BranchesTags

Repository files navigation

FiscalAPI SDK para Node.js

FiscalAPILicense

SDK oficial de FiscalAPI para Node.js, la API de facturación CFDI y otros servicios fiscales en México. Simplifica la integración con los servicios de facturación electrónica, eliminando las complejidades del SAT y facilitando la generación de facturas, notas de crédito, complementos de pago, nómina, carta porte, y más. ¡Factura sin dolor!

📋 Facturación CFDI 4.0

  • Soporte completo para CFDI 4.0 con todas las especificaciones oficiales
  • Timbrado de facturas de ingreso con validación automática
  • Timbrado de notas de crédito (facturas de egreso)
  • Timbrado de complementos de pago en MXN, USD y EUR
  • Timbrado de facturas de nómina
  • Timbrado de facturas de carta porte
  • Timbrado de facturas de comercio exterior
  • Consulta del estatus de facturas en el SAT en tiempo real
  • Cancelación de facturas
  • Generación de archivos PDF de las facturas con formato profesional
  • Personalización de logos y colores en los PDF generados
  • Envío de facturas por correo electrónico automatizado
  • Descarga de archivos XML con estructura completa
  • Almacenamiento y recuperación de facturas por 5 años.
  • Dos modos de operación: Por valores o Por referencias

📥 Descarga Masiva

  • Acceso a catálogos de descarga masiva del SAT
  • Descarga de CFDI y Metadatos en lotes grandes
  • Descarga masiva XML con filtros personalizados
  • Reglas de descarga automática por RFC
  • Solicitudes de descarga via API y Dashboard.
  • Automatización de solicitudes de descarga

👥 Gestión de Personas

  • Administración de personas (emisores, receptores, clientes, usuarios, etc.)
  • Gestión de certificados CSD y FIEL (subir archivos .cer y .key a FiscalAPI)
  • Configuración de datos fiscales (RFC, domicilio fiscal, régimen fiscal)
  • Datos de empleado (agrega/actualiza/elimina datos de empleado a una persona. CFDI Nómina)
  • Datos de empleador (agrega/actualiza/elimina datos de empleador a una persona. CFDI Nómina)

🎖️ Gestión de Timbres

  • Gestión de folios fiscales Compra timbres a fiscalapi y transfiere/retira a las personas de tu organizacion segun tus reglas de negocio.

🛍️ Gestión de Productos/Servicios

  • Gestión de productos y servicios con catálogo personalizable
  • Administración de impuestos aplicables (IVA, ISR, IEPS)

📚 Consulta de Catálogos SAT

  • Consulta en catálogos oficiales del SAT actualizados
  • Consulta en catálogos oficiales de Descarga masiva del SAT actualizados
  • Búsqueda de información en catálogos del SAT con filtros avanzados
  • Acceso y búsqueda en catálogos completos

📖 Recursos Adicionales

  • Cientos de ejemplos de código disponibles en múltiples lenguajes de programación
  • Documentación completa con guías paso a paso
  • Ejemplos prácticos para casos de uso comunes
  • Soporte técnico especializado
  • Actualizaciones regulares conforme a cambios del SAT

📦 Instalación

Compatible con múltiples versiones de Node.js ( Node.js 12.0.0 o superior)

npm:

npm install fiscalapi

yarn:

yarn add fiscalapi

⚙️ Configuración

Puedes usar el SDK tanto en aplicaciones Node.js tradicionales como en frameworks modernos (Express, NestJS, Next.js, etc.). A continuación se describen ambas formas:

A) Aplicaciones Node.js tradicionales

  1. Crea tu objeto de configuración con tus credenciales:

    // CommonJSconst{ FiscalapiClient }=require('fiscalapi');// o ESMimport{FiscalapiClient}from'fiscalapi';constsettings={apiUrl: "https://test.fiscalapi.com",// https://live.fiscalapi.com (producción)apiKey: "<tu_api_key>",tenant: "<tenant>"};

  2. Crea la instancia del cliente:

    constfiscalApi=FiscalapiClient.create(settings);

Para ejemplos completos, consulta ejemplos Express, ejemplos NestJs o más ejemplos en NodeJs.

B) Aplicaciones con Frameworks Modernos (Express, NestJS, etc.)

  1. Agrega la configuración en tu archivo de variables de entorno (.env):

    FISCALAPI_API_KEY=<api_key>
FISCALAPI_TENANT=<tenant>
FISCALAPI_API_URL=https://test.fiscalapi.com

  2. Crea y registra el cliente (por ejemplo, en un servicio o módulo):

    // services/fiscalapi.service.tsimport{FiscalapiClient}from'fiscalapi'importconfigfrom'../config/config';exportconstcreateFiscalApiClient=()=>{returnFiscalapiClient.create({apiUrl: config.fiscalapiSettings.apiUrl,apiKey: config.fiscalapiSettings.apiKey,tenant: config.fiscalapiSettings.tenant});};

En Express:

// En tu controlador o routerimport{createFiscalApiClient}from'../services/fiscalapi.service';constfiscalapi=createFiscalApiClient();app.post('/invoices',async(req,res)=>{try{constresponse=awaitfiscalapi.invoices.create(req.body);res.json(response);}catch(error){res.status(500).json({error: error.message});}});

Para más ejemplos, revisa ejemplos Express, ejemplos NestJs o más ejemplos en NodeJs.

🔄 Modos de Operación

FiscalAPI admite dos modos de operación:

  • Por Referencias: Envía solo IDs de objetos previamente creados en el dashboard de FiscalAPI.
    Ideal para integraciones ligeras.

  • Por Valores: Envía todos los campos requeridos en cada petición, con mayor control sobre los datos.
    No se requiere configuración previa en el dashboard.

📝 Ejemplos de Uso

A continuación se muestran algunos ejemplos básicos para ilustrar cómo utilizar el SDK. Puedes encontrar más ejemplos en la documentación oficial.

1. Crear una Persona (Emisor o Receptor)

constfiscalApi=FiscalApiClient.create(settings);constrequest={legalName: "Persona de Prueba",email: "someone@somewhere.com",password: "YourStrongPassword123!",};try{constapiResponse=awaitfiscalApi.persons.create(request);console.log(apiResponse.data);}catch(error){console.error(error);}

2. Subir Certificados CSD

Descarga certificados de prueba

constfiscalApi=FiscalApiClient.create(settings);constcertificadoCsd={personId: "984708c4-fcc0-43bd-9d30-ec017815c20e",base64File: "MIIFsDCCA5igAwIBAgI...==",// Certificado .cer codificado en Base64fileType: "CertificateCsd",password: "12345678a",tin: "EKU9003173C9"};constclavePrivadaCsd={personId: "984708c4-fcc0-43bd-9d30-ec017815c20e",base64File: "MIIFDjBABgkqhkiG9w0BBQ0...==",// Llave privada .key codificada en Base64fileType: "PrivateKeyCsd",password: "12345678a",tin: "EKU9003173C9"};try{constapiResponseCer=awaitfiscalApi.taxFiles.create(certificadoCsd);constapiResponseKey=awaitfiscalApi.taxFiles.create(clavePrivadaCsd);console.log(apiResponseCer.data,apiResponseKey.data);}catch(error){console.error(error);}

3. Crear un Producto o Servicio

constfiscalApi=FiscalApiClient.create(settings);constrequest={description: "Servicios contables",unitPrice: 100,satUnitMeasurementId: "E48",satTaxObjectId: "02",satProductCodeId: "84111500"};try{constapiResponse=awaitfiscalApi.products.create(request);console.log(apiResponse.data);}catch(error){console.error(error);}

4. Actualizar Impuestos de un Producto

constfiscalApi=FiscalApiClient.create(settings);constrequest={id: "310301b3-1ae9-441b-b463-51a8f9ca8ba2",description: "Servicios contables",unitPrice: 100,satUnitMeasurementId: "E48",satTaxObjectId: "02",satProductCodeId: "84111500",productTaxes: [{rate: 0.16,taxId: "002",taxFlagId: "T",taxTypeId: "Tasa"},// IVA 16%{rate: 0.10,taxId: "001",taxFlagId: "R",taxTypeId: "Tasa"},// ISR 10%{rate: 0.10666666666,taxId: "002",taxFlagId: "R",taxTypeId: "Tasa"}// IVA 2/3 partes]};try{constapiResponse=awaitfiscalApi.products.update(request.id,request);console.log(apiResponse.data);}catch(error){console.error(error);}

5. Crear una Factura de Ingreso (Por Referencias)

constfiscalApi=FiscalApiClient.create(settings);constinvoice={versionCode: "4.0",series: "SDK-F",date: newDate(),paymentFormCode: "01",currencyCode: "MXN",typeCode: "I",expeditionZipCode: "42501",issuer: {id: "<id-emisor-en-fiscalapi>"},recipient: {id: "<id-receptor-en-fiscalapi>"},items: [{id: "<id-producto-en-fiscalapi>",quantity: 1,discount: 10.85}],paymentMethodCode: "PUE",};try{constapiResponse=awaitfiscalApi.invoices.create(invoice);console.log(apiResponse.data);}catch(error){console.error(error);}

6. Crear la Misma Factura de Ingreso (Por Valores)

constfiscalApi=FiscalApiClient.create(settings);// Agregar sellos CSD, Emisor, Receptor, Items, etc.constinvoice={versionCode: "4.0",series: "SDK-F",date: newDate(),paymentFormCode: "01",currencyCode: "MXN",typeCode: "I",expeditionZipCode: "42501",issuer: {tin: "EKU9003173C9",legalName: "ESCUELA KEMPER URGATE",taxRegimeCode: "601",taxCredentials: [{base64File: "certificate_base64...",fileType: "CertificateCsd",password: "12345678a"},{base64File: "private_key_base64...",fileType: "PrivateKeyCsd",password: "12345678a"}]},recipient: {tin: "EKU9003173C9",legalName: "ESCUELA KEMPER URGATE",zipCode: "42501",taxRegimeCode: "601",cfdiUseCode: "G01",email: "someone@somewhere.com"},items: [{itemCode: "01010101",quantity: 9.5,unitOfMeasurementCode: "E48",description: "Invoicing software as a service",unitPrice: 3587.75,taxObjectCode: "02",discount: 255.85,itemTaxes: [{taxCode: "002",// IVAtaxTypeCode: "Tasa",taxRate: 0.16,taxFlagCode: "T"}]}],paymentMethodCode: "PUE",};try{constapiResponse=awaitfiscalApi.invoices.create(invoice);console.log(apiResponse.data);}catch(error){console.error(error);}

7. Búsqueda en Catálogos del SAT

try{// Busca los registros que contengan 'inter' en el catalogo 'SatUnitMeasurements' (pagina 1, tamaño pagina 10)constapiResponse=awaitfiscalApi.catalogs.searchCatalog("SatUnitMeasurements","inter",1,10);if(apiResponse.succeeded){apiResponse.data.items.forEach(item=>{console.log(`Unidad: ${item.description}`);});}else{console.log(apiResponse.message);}}catch(error){console.error(error);}

📂 Más Ejemplos

📋 Operaciones Principales

  • Facturas (CFDI) - Ingreso, egreso, pago, nómina, cancelaciones, PDF/XML
  • Personas - Emisores, receptores, certificados CSD
  • Productos - Catálogo de productos/servicios
  • Timbres - Transferencias y retiros

🤝 Contribuir

  1. Haz un fork del repositorio.
  2. Crea una rama para tu feature: git checkout -b feature/AmazingFeature.
  3. Realiza commits de tus cambios: git commit -m 'Add some AmazingFeature'.
  4. Sube tu rama: git push origin feature/AmazingFeature.
  5. Abre un Pull Request en GitHub.

🐛 Reportar Problemas

  1. Asegúrate de usar la última versión del SDK.
  2. Verifica si el problema ya fue reportado.
  3. Proporciona un ejemplo mínimo reproducible.
  4. Incluye los mensajes de error completos.

📄 Licencia

Este proyecto está licenciado bajo la Licencia MPL-2.0. Consulta el archivo LICENSE para más detalles.

🔗 Enlaces Útiles

Desarrollado con ❤️ por Fiscalapi

About

SDK oficial de fiscalapi para consumo desde aplicaciones JavaScript

Resources

Readme
MPL-2.0 license
Activity
Custom properties

Stars

42 stars

Watchers

0 watching

Forks

3 forks
Report repository

Releases

Packages

Used by

Contributors

Languages