cfdi-sat-nodejs v1.0.0

PAQUETE CFDI SAT PARA NODEJS

EN CONSTRUCCIÓN

Si la librería te ha servido, podrias hacermelo saber invitandome un café :)

Librería generadora de XML y creación de CFDI impreso, permite crear XML de tipo Ingreso, Egreso y Traslado, generar Carta Porte, Nominas, etc. Incluye catálogos en JSON.

Tabla de contenido

• Instalación
• Importación
• Factura de tipo ingreso
  • Método crearEmisor
  • Método crearReceptor
  • Método certificado
  • Método esGlobal
  • Método crearConceptos
  • Método generarXml
  • Método generarXmlSellado
• Factura de tipo Egreso
  • Nota de crédito
  • Devolución
• Catálogos

Instalación

npm install --save cfdi-sat-nodejs

Importación

Para crear cualquier tipo de XML necesitas importar la librerÍa y una vez crear una nueva instancia.

const { FacturaCFDI } = require("cfdi-sat-nodejs");

const nuevaFactura = new FacturaCFDI();

Factura de tipo ingreso

Aquí se te explica los diversos métodos para generar el XML y los requisitos que solicitan cada uno de estos métodos.

Método crearEmisor

nuevaFactura.crearEmisor(RFC, Nombre, RegimenFiscal);

se recibe 3 argumentos:

Método crearReceptor

nuevaFactura.crearReceptor(RFC, Nombre, RegimenFiscal, CodigoPostal, UsoCFDI);

se recibe estos argumentos:

Método certificado

En este método debes cargar la ruta del certificado en su formato base sin convertir ya que la librería se encarga de ese proceso.

nuevaFactura.certificado(PathCertificado);

se recibe este único argumento:

Método esGlobal

Si necesitas generar facturas globales, llama al método esGlobal con los parámetros correspondientes a la periodicidad, meses y año.

nuevaFactura.esGlobal(Periocidad, Meses, Año);

Método crearConceptos

const array = [
  {
    ClaveProdServ: 1234567890, // obligatorio
    Cantidad: 1, // obligatorio
    ClaveUnidad: "H87", // obligatorio
    Unidad: "Pieza", // obligatorio
    Descripcion: "Producto", // obligatorio
    ValorUnitario: 125, // obligatorio
    Importe: 125, // obligatorio
    ObjetoImp: "02", // obligatorio
    NoIdentificacion: 567384983723, // opcional
    Descuento: 25, // opcional
    Impuesto: {
      Impuesto: "002", // obligatorio
      TipoFactor: "Tasa", // obligatorio
      TasaOCuota: "0.16", // obligatorio
    },
    /// EN CASO QUE EL PRODUCTO O SERVICIO APLIQUE RETENCIONES
    Retenciones: [
      {
        Impuesto: "001", // obligatorio
        TipoFactor: "Tasa", // obligatorio
        TasaOCuota: "0.10", // obligatorio
      },
    ],
  },
];

nuevaFactura.crearConceptos(array);

Es muy importante que en este método se envié la información acorde a lo requerido por la librería debido a que si los nombres de las propiedades son distintas a los esperados se retornara un error.

El método recibe un array como argumento, dentro debe contender los objetos correspondientes a los productos o servicios a facturar. Al ser el único método relacionado con los conceptos, es necesario incluir los datos del impuesto y retenciones (en caso de aplicar) dentro de cada objeto junto al resto de datos tal cual se muestran arriba.

NOTA: Si ObjetoImp es "01" no es necesario incluir el objeto Impuesto ni el array Retenciones.

Estos argumentos aplican tanto para el objeto Impuesto como al array Retenciones

En caso de tener un TipoFactor como "Exento" puede omitir el valor de TasaOCuota ya que la librería no lo toma en cuenta.

Método crearSello

En caso de querer generar un XMl ya sellado y listo para timbrar puede usar el siguiente método.

nuevaFactura.crearSello(PathLlavePrivada, Contraseña);

NOTA: La llave privada debe de estar en su formato base no convertida ya que la librería se encarga de convertirla.

Método generarXml

const atributos = [
    Serie: 'F',                       // opcional (valor por defecto "F")
    Folio: 1,                         // obligatorio
    Fecha: '2022-01-27T11:49:48',     // opcional (valor por defecto "Hora actual")
    FormaPago: '02',                  // obligatorio
    CondicionesDePago: '3 meses',     // opcional (valor por defecto "")
    TipoDeComprobante: 'I',           // opcional (valor por defecto "I")
    MetodoPago: 'PUE',                // obligatorio
    LugarExpedicion: '00000',         // obligatorio
    Subtotal: 4545,                   // obligatorio
    Total: 4545,                      // obligatorio
    Moneda: 'MXN',                    // opcional (valor por defecto "MXN")
    Exportacion: "01",                // opcional (valor por defecto "01")
    Descuento: 0                      // opcional (valor por defecto "0")
];

const xml = nuevaFactura.generarXml(atributos)

En este método nos retorna el XML sin sellar. en caso de requerir el XML sellado vea el siguiente método.

Método generarXmlSellado

Para crear el XML sellado, es necesario que el método generarXmlSellado sea llamado de manera asincrónica. Esto se puede lograr utilizando async/await o la cadena de promesas con .then() y .catch().

const xmlSellado = await nuevaFactura.generarXmlSellado(atributos);

// Tambien puedes usar:

nuevaFactura
  .generarXmlSellado(atributos)
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.log(error);
  });

Para generar el XML sellado es necesario incluir el método crearSello antes del método generarXmlSellado de lo contrario retorna un error.

Factura de tipo Egreso

Nota de crédito

Para crear un XML de nota de crédito puede utilizar los métodos para la creación de un CFDI de tipo ingreso, los únicos que debe cambiar es el tipo de comprobante de Ingreso ("I") a Egreso ("E") y la serie.

EJEMPLO:

const atributos = [
    Serie: 'NC',
    TipoDeComprobante: 'E'
    // el resto de valores
];

Devolución

Para crear un XML de devolución puede utilizar los métodos para la creación de un CFDI de tipo ingreso, los únicos que debe cambiar es el tipo de comprobante de Ingreso ("I") a Egreso ("E") y la serie.

EJEMPLO:

const atributos = [
    Serie: 'AC',
    TipoDeComprobante: 'E'
    // el resto de valores
];

Catálogos

La librería cuenta con todos los catálogos proporcionados por el SAT actualizados, todos en formato JSON. Se proporciona un método para obtener todo el contenido de cada catalogo asi como un método para obtener específicamente un registro de un catálogo en especifico.

A continuación se colocan todos los métodos disponibles

/// Importar la clase y crear una nueva instancia
const { CatalogosSAT } = require("cfdi-sat-nodejs");
const catalogos = new CatalogosSAT();

/// Obtener un solo registro de un catálogo
catalogos.buscarEnCatalogo(Valor, Clave, NombreCatalogo);

/// Ejemplo de salida correcta
/*
{
  status: true,
  data: {
    clave: 'G01',
    descripcion: 'Adquisición de mercancías.',
    fisica: 'Sí',
    moral: 'Sí',
    regimen_receptor: '601, 603, 606, 612, 620, 621, 622, 623, 624, 625,626'
  }
}
*/

/// Ejemplo de salida errónea
/*
{ 
  status: false,
  data: null,
  message: 'Clave "G001" no encontrada en el catálogo "UsoCfdi"'
}
*/

/// Obtener todos los registros de cada catálogo
catalogos.obtenerCatalogo(NombreCatalogo);

/// Ejemplo de salida correcta
/*
{
  status: true,
  data: [
    {
      clave: 'G01',
      descripcion: 'Adquisición de mercancías.',
      fisica: 'Sí',
      moral: 'Sí',
      regimen_receptor: '601, 603, 606, 612, 620, 621, 622, 623, 624, 625,626'
    },
    {
      clave: 'G02',
      descripcion: 'Devoluciones, descuentos o bonificaciones.',
      fisica: 'Sí',
      moral: 'Sí',
      regimen_receptor: '601, 603, 606, 612, 620, 621, 622, 623, 624, 625,626'
    },
    ...
  ]
}
*/

/// Ejemplo de salida errónea
/*
{ 
  status: false,
  data: null,
  message: 'El catálogo "usocfdi" no existe'
}
*/

LISTA DE CATALOGOS DISPONIBLES

• FormaPago
• Moneda
• TipoDeComprobante
• Exportacion
• MetodoPago
• CodigoPostalParteUno
• CodigoPostalParteDos
• Periodicidad
• Meses
• TipoRelacion
• RegimenFiscal
• Pais
• UsoCfdi
• ClaveProdServ
• ClaveUnidad
• ObjetoImpuesto
• Impuesto
• TipoFactor
• TasaOCuota
• Aduana
• NumPedimentoAduana
• PatenteAduanal
• ColoniaParteUno
• ColoniaParteDos
• ColoniaParteTres
• Estado
• Localidad
• Municipio
• RegimenAduanero
• ClaveTransporte
• TipoEstacion
• Estaciones
• ClaveUnidadPeso
• ClaveProdServCp
• MaterialPeligroso
• TipoEmbalaje
• TipoPermiso
• SectorCofepris
• FormaFarmaceutica
• CondicionesEspeciales
• TipoMateria
• DocumentoAduanero
• ParteTransporte
• FiguraTransporte
• ConfigAutotransporte
• SubtipoRemolque
• RegistroIstmo
• ConfigMaritima
• ClaveTipoCarga
• ContenedorMaritimo
• NumAutorizacionNaviero
• CodigoTransporteAereo
• TipoDeServicio
• DerechosDePaso
• TipoCarro
• Contenedor
• TipoTrafico