Skip to main content

openUBL - Peruvian SUNAT Electronic Documents Library

Project description

openUBL

PyPI npm

Genera, firma y valida documentos electrónicos UBL 2.1 para SUNAT (Perú) — sin complicaciones.

openUBL es una biblioteca Python con API REST incluida. Genera XML válido para facturas, notas de crédito, notas de débito, comunicaciones de baja, resúmenes diarios, percepciones y retenciones. Firma digitalmente con certificados XAdES-EPES y valida contra las reglas SUNAT antes de enviar.

¿Por qué openUBL?

  • Sin dependencias externas — todo en Python. No necesitas servicios de terceros para generar XML.
  • API REST lista para usar — levantas FastAPI y generas documentos vía HTTP.
  • SDK TypeScript — tipos generados desde OpenAPI, con autocompletado completo.
  • Firma digital integrada — firma con certificado PEM sin herramientas externas.
  • Validación SUNAT — detecta errores antes del envío, no después.
  • Documentación completa — guías paso a paso en https://darvin2c.github.io/openUBL

Instalación rápida

Python

pip install openubl
from openubl.models import Invoice, Proveedor, Cliente, DocumentoVentaDetalle

invoice = Invoice(
    serie="F001",
    numero=1,
    proveedor=Proveedor(ruc="20100066603", razonSocial="Softgreen S.A.C."),
    cliente=Cliente(nombre="Carlos", numeroDocumentoIdentidad="12121212121", tipoDocumentoIdentidad="6"),
    detalles=[DocumentoVentaDetalle(descripcion="Item", cantidad=10, precio=100)],
)

xml = invoice.to_xml()
print(xml)  # XML UBL 2.1 listo para firmar

TypeScript / JavaScript

npm install @openubl/sdk
import { client, type Invoice } from "@openubl/sdk";

const invoice: Invoice = {
  serie: "F001",
  numero: 1,
  proveedor: { ruc: "20100066603", razonSocial: "Softgreen S.A.C." },
  cliente: { nombre: "Carlos", numeroDocumentoIdentidad: "12121212121", tipoDocumentoIdentidad: "6" },
  detalles: [{ descripcion: "Item", cantidad: 10, precio: 100 }],
};

const { data } = await client.POST("/api/v1/invoice/create", { body: invoice });
console.log(data?.xml); // XML UBL 2.1 generado

Levantar la API REST

uv run uvicorn openubl.main:app --reload

Abre http://localhost:8000/docs para Swagger UI interactivo.

Documentos soportados

Tipo Código SUNAT Endpoint
Factura 01 POST /api/v1/invoice/create
Boleta 03 POST /api/v1/invoice/create
Nota de Crédito 07 POST /api/v1/credit-note/create
Nota de Débito 08 POST /api/v1/debit-note/create
Comunicación de Baja RA POST /api/v1/voided-documents/create
Resumen Diario RC POST /api/v1/summary-documents/create
Percepción 40 POST /api/v1/perception/create
Retención 20 POST /api/v1/retention/create

Validación de versión

Verifica que tu SDK y la API compartan la misma versión:

from openubl.version import check_api_version

result = check_api_version("http://localhost:8000")
assert result["ok"], f"Desfase: SDK {result['sdk_version']} vs API {result['api_version']}"
import { checkApiVersion } from "@openubl/sdk";

const result = await checkApiVersion("http://localhost:8000");
if (!result.ok) throw new Error(`Desfase: SDK ${result.sdkVersion} vs API ${result.apiVersion}`);

Documentación

Contribuir

Consulta AGENTS.md para el contexto técnico completo del proyecto.

Licencia

MIT © openUBL

Test release flow v2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openubl-0.2.0.tar.gz (728.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openubl-0.2.0-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file openubl-0.2.0.tar.gz.

File metadata

  • Download URL: openubl-0.2.0.tar.gz
  • Upload date:
  • Size: 728.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openubl-0.2.0.tar.gz
Algorithm Hash digest
SHA256 64e6f0b8baca8ef4c96fea5793d59504ace9a78d84fb40918170ab295827b1b6
MD5 15f42a62be2336344054a24b3fc64fa1
BLAKE2b-256 4662d9076c3325bfa0788e106a944562fb0a7787e5dbd060eb1b36c40de41aa5

See more details on using hashes here.

File details

Details for the file openubl-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: openubl-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openubl-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b37478e0ce0b812e8aa52320861a5335bfa8892a039c4dbafac4b8d4e664c0d
MD5 0139266184004c444ed5bbca61bb3c3a
BLAKE2b-256 6796e0854619b32fe3174f2ff19de62ddf3a53585aa4546642847840b7b6ad6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page