facturacion-open-api 1.0.0

package/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# facturacion-open-api
+
+Facturación Open API es un proyecto de facturación electrónica para Ecuador compatible con la ficha técnica para comprobantes electrónicos emitido por el SRI.
+
+Está publicada como librería y la puedes utilizar simplemente instalándola como dependencia en tu proyecto de Node o Bun.
+
+### Funciones
+
+La librería cuenta actualmente con las siguientes funciones:
+
+- Tipado de campos para factura electrónica de acuerdo a las especificaciones del SRI.
+- Generación de archivo JSON con formato de factura electrónica.
+- Generación de XML con formato de factura electrónica.
+- Firmado de XML con archivo .p12 (Compatible con Security Data y Banco Central)
+- Envío de documento a endpoint de recepción del SRI
+- Autorización de documento en endpoint del SRI
+- Cargar Firma electrónica desde archivo local o URL
+- Cargar XML desde archivo local o URL
+
+### Ejemplo
+
+Aquí puedes ver un ejemplo de cómo utilizar las funciones principales:
+
+```
+import {
+  generateInvoice,
+  generateInvoiceXml,
+  getP12FromUrl,
+  signXml,
+} from "facturacion-open-api";
+
+const { invoice, accessKey }  = generateInvoice({
+  infoTributaria: {
+    ...
+  },
+  infoFactura: {
+    ...
+  },
+  detalles: {
+    ...
+  },
+  reembolsos: {
+    ...
+  },
+  retenciones: {
+    ...
+  },
+  infoSustitutivaGuiaRemision: {
+    ...
+  },
+  otrosRubrosTerceros: {
+    ...
+  },
+  tipoNegociable: { correo: "correo0" },
+  maquinaFiscal: {
+    ...
+  },
+  infoAdicional: {
+    ...
+  },
+});
+
+const invoiceXml = generateInvoiceXml(invoice);
+
+const signature: ArrayBuffer = await getP12FromUrl("yoururl");
+const password = "yourpassword";
+
+const signedInvoice = await signXml(sign, password, invoiceXml);
+
+const receptionResult = await documentReception(
+  signedInvoice,
+  process.env.SRI_RECEPTION_URL!
+);
+
+const authorizationResult = await documentAuthorization(
+  accessKey,
+  process.env.SRI_AUTHORIZATION_URL!
+);
+```
+
+Un ejemplo completo lo puedes encontrar en la carpeta `tests`
+Ejemplos de los archivos generados los encuentras en `src/example`
+
+### Endpoints del SRI
+
+El SRI ha habilitado dos endpoints para cada ambiente (pruebas, producción).
+
+**Producción**
+
+```
+SRI_RECEPTION_URL="https://cel.sri.gob.ec/comprobantes-electronicos-ws/RecepcionComprobantesOffline?wsdl"
+SRI_AUTHORIZATION_URL="https://cel.sri.gob.ec/comprobantes-electronicos-ws/AutorizacionComprobantesOffline?wsdl"
+```
+
+**Pruebas**
+
+```
+SRI_RECEPTION_URL="https://celcer.sri.gob.ec/comprobantes-electronicos-ws/RecepcionComprobantesOffline?wsdl"
+SRI_AUTHORIZATION_URL="https://celcer.sri.gob.ec/comprobantes-electronicos-ws/AutorizacionComprobantesOffline?wsdl"
+```
+
+**Ten en cuenta que para poder utilizar estos endpoints con tu RUC debes activar el ambiente de pruebas/producción en tu cuenta del SRI. [Aquí un tutorial de cómo hacerlo](https://www.factureromovil.com/pasos-para-habilitar-el-ambiente-de-produccion-en-sri)**
+
+### Contribuir
+
+Si deseas contribuir a este proyecto, crea un Pull Request con los cambios que pienses que pueden aportar para que el proyecto siga creciendo.