❤
npm
Sign UpSign In

@nodecfdi/cfdi-to-json
TypeScript icon, indicating that this package has built-in type declarations

1.2.3 • Public • Published

@nodecfdi/cfdi-to-json

Source Code Npm Node Version Support Discord Latest Version Software License Build Status Reliability Maintainability Code Coverage Violations Total Downloads

Library to convert CFDI files to JSON.

🇺🇸 The documentation of this project is in spanish as this is the natural language for intented audience.

🇲🇽 La documentación del proyecto está en español porque ese es el lenguaje principal de los usuarios.

Acerca de @nodecfdi/cfdi-to-json

Esta es una herramienta que sigue sus propias convenciones para convertir los archivos de CFDI (XML de SAT) a formato JSON.

Algunas de las convenciones que se siguen son:

  • Los elementos con objetos que contienen los atributos y sus elementos hijos.
  • Los elementos que pueden aparecer más de una vez, son manejados como arreglos.
  • La librería guarda un registro interno de los elementos que pueden aparecer más de una vez.

Libreria inspirada por la versión para php https://github.com/phpcfdi/cfdi-to-json

Instalación

NPM

npm i @nodecfdi/cfdi-to-json --save

YARN

yarn add @nodecfdi/cfdi-to-json --save

PNPM

pnpm add @nodecfdi/cfdi-to-json --save

CDN - Browser

Usa la versión mas reciente publicada cambiando <latest-version> por la última versión. Por ejemplo ...cfdi-to-json@1.2.3/dist...

<script src="https://unpkg.com/@nodecfdi/cfdi-to-json@<latest-version>/dist/cfdi-to-json.global.js"></script>

Uso básico

Convirtiendo de CFDI (string) a JSON (string) - Node Version with xmldom

import { install } from '@nodecfdi/cfdiutils-common';
import {
    DOMImplementation,
    XMLSerializer,
    DOMParser
} from '@xmldom/xmldom';
import { readFileSync } from 'fs';
import { JsonConverter } from '@nodecfdi/cfdi-to-json';

// from version 1.2.x on @nodecfdi/cfdiutils-common required install dom resolution
install(new DOMParser(), new XMLSerializer(), new DOMImplementation());

// Accedemos al contenido en nuestro archivo XML
const xml = readFileSync('archivo-cfdi.xml').toString();
const json = JsonConverter.convertToJson(xml);
console.log(json);

Convirtiendo de Document a Object - Node Version with xmldom

import { Factory } from '@nodecfdi/cfdi-to-json';
import { install } from '@nodecfdi/cfdiutils-common';
import {
    DOMImplementation,
    XMLSerializer,
    DOMParser
} from '@xmldom/xmldom';


// from version 1.2.x on @nodecfdi/cfdiutils-common required install dom resolution
install(new DOMParser(), new XMLSerializer(), new DOMImplementation());

/** const document: Document **/
const factory = new Factory();
const dataConverter = factory.createConverter();
const rootNode = dataConverter.convertXmlDocument(document);
const myObject = rootNode.toRecord();
console.log(myObject);

Convirtiendo de CFDI (string) a JSON (string) - Browser Version

import { JsonConverterBrowser } from '@nodecfdi/cfdi-to-json';
import { install } from '@nodecfdi/cfdiutils-common';

// from version 1.2.x on @nodecfdi/cfdiutils-common required install dom resolution
install(new DOMParser(), new XMLSerializer(), document.implementation);

// Accedemos al contenido en nuestro archivo XML
const xml = 'nuestro xml string';
const json = JsonConverterBrowser.convertToJson(xml);
console.log(json);

Convirtiendo de Document a Object - Browser Version

import { FactoryBrowser } from '@nodecfdi/cfdi-to-json';
import { install } from '@nodecfdi/cfdiutils-common';

// from version 1.2.x on @nodecfdi/cfdiutils-common required install dom resolution
install(new DOMParser(), new XMLSerializer(), document.implementation);

/** const documentXML: Document **/
const factory = new FactoryBrowser();
const dataConverter = factory.createConverter();
const rootNode = dataConverter.convertXmlDocument(documentXML);
const myObject = rootNode.toRecord();
console.log(myObject);

Ejemplo de salida

Note que:

  • Emisor parece una propiedad más del objeto principal, pero el contenido es un objeto y no una cadena de caracteres.
  • Concepto contiene un arreglo de objetos, cada uno es una representación de un nodo concepto.
  • Traslado contiene un arreglo a pesar de que solo contenga un objeto, se conoce que es múltiple.
  • Complemento es un arreglo a pesar de lo definido en el Anexo 20 porque el XSD dice que puede tener múltiples apariciones.
{
 "Certificado": "MIIGH...imAyX",
 "CondicionesDePago": "CONTADO",
 "Fecha": "2018-01-12T08:15:01",
 "Folio": "11541",
 "FormaPago": "04",
 "LugarExpedicion": "76802",
 "MetodoPago": "PUE",
 "Moneda": "MXN",
 "NoCertificado": "00001000000401220451",
 "Sello": "Xt7tK...gdg==",
 "Serie": "H",
 "SubTotal": "1709.12",
 "TipoDeComprobante": "I",
 "Total": "2010.01",
 "Version": "3.3",
 "xsi:schemaLocation": "http://www.sat.gob.mx/cfd/3 http://www.sat.gob.mx/sitio_internet/cfd/3/cfdv33.xsd http://www.sat.gob.mx/implocal http://www.sat.gob.mx/sitio_internet/cfd/implocal/implocal.xsd",
 "Emisor": {
  "Nombre": "PROMOTORA OTIR SA DE CV",
  "RegimenFiscal": "601",
  "Rfc": "POT9207213D6"
 },
 "Receptor": {
  "Nombre": "DAY INTERNATIONAL DE MEXICO SA DE CV",
  "Rfc": "DIM8701081LA",
  "UsoCFDI": "G03"
 },
 "Conceptos": {
  "Concepto": [
   {
    "Cantidad": "2.00",
    "ClaveProdServ": "90111501",
    "ClaveUnidad": "E48",
    "Descripcion": "Paquete",
    "Importe": "1355.67",
    "Unidad": "UNIDAD DE SERVICIO",
    "ValorUnitario": "677.83",
    "Impuestos": {
     "Traslados": {
      "Traslado": [
       {
        "Base": "1355.67",
        "Importe": "216.91",
        "Impuesto": "002",
        "TasaOCuota": "0.160000",
        "TipoFactor": "Tasa"
       }
      ]
     }
    }
   },
   {
    "Cantidad": "1.00",
    "ClaveProdServ": "90101501",
    "ClaveUnidad": "E48",
    "Descripcion": "Restaurante",
    "Importe": "353.45",
    "Unidad": "UNIDAD DE SERVICIO",
    "ValorUnitario": "353.45",
    "Impuestos": {
     "Traslados": {
      "Traslado": [
       {
        "Base": "353.45",
        "Importe": "56.55",
        "Impuesto": "002",
        "TasaOCuota": "0.160000",
        "TipoFactor": "Tasa"
       }
      ]
     }
    }
   }
  ]
 },
 "Impuestos": {
  "TotalImpuestosTrasladados": "273.46",
  "Traslados": {
   "Traslado": [
    {
     "Importe": "273.46",
     "Impuesto": "002",
     "TasaOCuota": "0.160000",
     "TipoFactor": "Tasa"
    }
   ]
  }
 },
 "Complemento": [
  {
   "ImpuestosLocales": {
    "TotaldeRetenciones": "0.00",
    "TotaldeTraslados": "27.43",
    "version": "1.0",
    "TrasladosLocales": [
     {
      "ImpLocTrasladado": "IH",
      "Importe": "27.43",
      "TasadeTraslado": "2.50"
     }
    ]
   },
   "TimbreFiscalDigital": {
    "FechaTimbrado": "2018-01-12T08:17:54",
    "NoCertificadoSAT": "00001000000406258094",
    "RfcProvCertif": "DCD090706E42",
    "SelloCFD": "Xt7tK...gdg==",
    "SelloSAT": "IRy7w...6Zg==",
    "UUID": "CEE4BE01-ADFA-4DEB-8421-ADD60F0BEDAC",
    "Version": "1.1",
    "xsi:schemaLocation": "http://www.sat.gob.mx/TimbreFiscalDigital http://www.sat.gob.mx/sitio_internet/cfd/TimbreFiscalDigital/TimbreFiscalDigitalv11.xsd"
   }
  }
 ]
}

Funcionamiento interno

La conversión parte de un objeto Document que es recorrido nodo a nodo y en cada transformación genera un objeto de tipo Nodes\Node que contiene sus propiedades básicas de nombre, ruta, atributos e hijos. Los hijos (Nodes\Children) son una colección de nodos Nodes\Node.

Al momento de exportar a un Record<key, value> Nodes\Node.toRecord() es cuando se resuelve si los nodos deben agregarse como llaves directas a objetos o bien como arreglos de objetos.

Elementos con múltiples apariciones

Para detectar los elementos con múltiples apariciones esta librería contiene un archivo src/UnboundedOccursPaths.json con el listado de rutas de elementos que pueden aparecer más de una vez.

Nodos con texto

El texto o valor que contenga algún nodo XML es exportado a una llave de cadena vacía en el JSON resultante. Por ejemplo, el siguiente XML:

<detallista:orderIdentification>
    <detallista:referenceIdentification type="ON">3</detallista:referenceIdentification>
</detallista:orderIdentification>

Genera el siguiente JSON:

{
  "orderIdentification": {
    "referenceIdentification": {
      "": "3",
      "type": "ON"
    }
  }
}

Soporte

Puedes obtener soporte abriendo un ticket en Github.

Adicionalmente, esta librería pertenece a la comunidad OcelotlStudio, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.

Compatibilidad

Esta librería se mantendrá compatible con al menos la versión con soporte activo de Node más reciente.

También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.

Contribuciones

Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para más detalles y recuerda revisar el archivo CHANGELOG.

Copyright and License

The @nodecfdi/cfdi-to-json library is copyright © NodeCfdi - OcelotlStudio and licensed for use under the MIT License (MIT). Please see LICENSE for more information.

Readme

Keywords

Package Sidebar

Install

npm i @nodecfdi/cfdi-to-json

Repository

github.com/nodecfdi/cfdi-to-json

Homepage

github.com/nodecfdi/cfdi-to-json

Weekly Downloads

119

Version

1.2.3

License

MIT

Unpacked Size

242 kB

Total Files

13

Last publish

Collaborators

  • luffynando
  • celli33
Try on RunKit
Report malware