API – Documentation

Autenticación

Tipo

Clave API — CLAVE API

Ubicación

consulta / parámetro: clave de API

Respaldo mediante el parámetro de consulta/cuerpo "apikey"

OBTENER /sendsms/?apikey=SU_CLAVE_API

Gestión de facturas

/factura/añadir • Métodos: CORREO

Agregar un encabezado de factura de ventas

Crea un nuevo encabezado de factura en estado BORRADOR. El punto final registra toda la información del proveedor y del cliente, las fechas de emisión, las condiciones de pago y los detalles de entrega. Los datos del proveedor se cargan automáticamente desde el registro de su clave API (customer_api).

CORREO /factura/añadir • Tasa: 60 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Su clave API de Peppox (de su cuenta de proveedor registrada).
`red`	cadena	No		Identificador de red opcional (Peppol por defecto).
`inv_id`	cadena	No		Número de factura interna opcional.
`fecha de asunto`	cadena	Sí		Fecha de emisión de la factura (AAAA-MM-DD).
`fecha de vencimiento`	cadena	No		Fecha de vencimiento de la factura (AAAA-MM-DD).
`código_tipo_factura`	cadena	No	380	Código de tipo de factura de Peppol (por ejemplo, 380 = Factura, 381 = Nota de crédito).
`divisa`	cadena	No	euros	Código de moneda ISO.
`costo contable`	cadena	No		Referencia del código de contabilidad interna.
`referencia del comprador`	cadena	No		Referencia del comprador / Número de orden de compra.
`código de medios de pago`	cadena	No	1	Medios de pago (lista de códigos Peppol).
`pago.id_pago`	cadena	No		Identificador/referencia de pago.
`pago.iban`	cadena	No		IBAN del beneficiario.
`pago.nombre_de_cuenta`	cadena	No		Nombre del titular de la cuenta del beneficiario.
`pago.bic`	cadena	No		Código BIC/SWIFT del beneficiario.
`nota sobre términos de pago`	cadena	No		Nota sobre condiciones de pago.
`fecha de entrega`	cadena	No		Fecha de entrega.
`esquema de ubicación de entrega`	cadena	No	0088	Identificador del esquema de ubicación de entrega.
`entrega.location_id`	cadena	No		ID de ubicación de entrega.
`entrega.calle`	cadena	No		Dirección de entrega calle.
`entrega.ciudad`	cadena	No		Ciudad dirección de entrega.
`entrega postal`	cadena	No		Código postal de la dirección de entrega.
`país de entrega`	cadena	No		Código de país de la dirección de entrega.
`entrega.nombre_de_la_fiesta`	cadena	No		Nombre del grupo de entrega.
`cliente.endpoint_scheme`	cadena	No	0208	ID del plan Peppol del cliente.
`cliente.id del punto final`	cadena	No		ID de participante de Peppol del cliente.
`nombre del cliente`	cadena	No		Nombre del cliente.
`cliente.calle`	cadena	No		Calle del cliente.
`cliente.ciudad`	cadena	No		Ciudad del cliente.
`cliente.postal`	cadena	No		Código postal del cliente.
`cliente.país`	cadena	No		Código de país del cliente.
`cliente.vat_id`	cadena	No		Número de IVA del cliente.
`cliente.esquema_id_empresa`	cadena	No	0208	Esquema de identificación de la empresa del cliente.
`cliente.id_de_empresa`	cadena	No		ID de la empresa del cliente (número nacional).
`teléfono del cliente`	cadena	No		Teléfono de contacto del cliente.
`cliente.correo electrónico`	cadena	No		Correo electrónico de contacto del cliente.

Solicitar ejemplos

RIZO

PITÓN

curl -X POST "https://api.peppox.com/invoice/add/" \ -H "Autorización: Portador YOUR_API_KEY" \ -H "Tipo de contenido: application/json" \ -d "{ "fecha_de_emisión": "2025-10-17", "fecha_de_vencimiento": "2025-11-17", "cliente": { "id_de_punto_final": "9915:BE0123456789", "nombre": "ACME SPRL", "país": "BE" }, "pago": { "iban": "BE12345678901234", "bic": "GEBABEBB", "nombre_de_cuenta": "Proveedor de Peppox" } }"

Respuestas

Estado: 200 — Factura creada exitosamente (borrador).

JSON

{ "ok": verdadero, "invoice_guid": "inv-8c3b4a99-2025-10-17", "status": "BORRADOR" }

Estado: 400 — Campos inválidos o faltantes.

Estado: 401 — Clave API no válida o caducada.

Estado: 500 — Error interno del servidor o de la base de datos.

/línea_de_factura/añadir • Métodos: CORREO

Agregar una línea de factura a una factura existente

Añade una nueva línea a una factura existente (identificada por invoice_guid). Admite códigos de unidad, cantidad, precio, categoría de IVA y de identificación del producto.

CORREO /línea_de_factura/añadir • Tasa: 60 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Su clave API de Peppox (necesaria para la autenticación).
`guía de factura`	cadena	Sí		El GUID de factura único devuelto desde /invoice/add.
`id de línea`	cadena	No		Identificador de línea interno opcional (predeterminado: GUID generado).
`cantidad`	número	Sí		Cantidad del artículo o servicio.
`código de unidad`	cadena	No		Código de unidad según la Recomendación 20 de la CEPE (por ejemplo, H87 para “pieza”).
`precio_monto`	número	Sí		Precio unitario (sin impuestos).
`descripción del artículo`	cadena	No		Descripción del artículo o servicio.
`nombre_del_artículo`	cadena	No		Nombre o título del artículo.
`ID del artículo del vendedor`	cadena	No		ID de artículo interno del vendedor o SKU.
`esquema de id. de elemento estándar`	cadena	No	0088	Identificación de esquema estándar para identificación de artículos (por ejemplo, GTIN).
`id_del_elemento_estándar`	cadena	No		ID de artículo estandarizado (GTIN, EAN, etc.).
`país de origen`	cadena	No		País de origen (ISO 3166-1 alpha-2).
`categoría_de_impuesto`	cadena	No		Código de categoría de IVA (por ejemplo, S, Z, AE).
`porcentaje de impuestos`	número	No		Porcentaje de tasa de IVA (por ejemplo 21,00).

Solicitar ejemplos

RIZO

PITÓN

curl -X POST "https://api.peppox.com/invoice_line/add/" \ -H "Autorización: Portador YOUR_API_KEY" \ -H "Tipo de contenido: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "cantidad": 2, "código_unidad": "H87", "precio_importe": 49.99, "nombre_artículo": "Servicio de consultoría", "porcentaje_de_impuestos": 21 }"

Respuestas

Estado: 200 — Línea de factura agregada exitosamente.

JSON

{ "ok": verdadero, "line_guid": "line-2b4fa3c1-2025-10-17" }

Estado: 400 — Parámetros no válidos (factura_guid faltante o campos numéricos no válidos).

Estado: 401 — Clave API no válida o caducada.

Estado: 500 — Error interno de la base de datos o del servidor.

/factura_adjuntar_pdf/añadir • Métodos: CORREO

Adjuntar un PDF a una factura existente

Adjunta un documento PDF (mediante carga, Base64 o URL remota) a una factura existente identificada por invoice_guid. Solo se almacena un archivo adjunto por factura; cualquier archivo anterior se reemplaza.

CORREO /factura_adjuntar_pdf/añadir • Tasa: 30 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Su clave API de Peppox (autenticación).
`guía de factura`	cadena	Sí		El GUID de la factura a la que adjuntar el PDF.
`id_doc`	cadena	No		Identificador de documento opcional (por defecto, ID de factura o un UUID generado).
`Nombre del archivo`	cadena	No	archivo adjunto.pdf	Nombre del archivo adjunto (por ejemplo, factura.pdf).
`mímica`	cadena	No	solicitud/pdf	Tipo MIME del archivo.
`base de contenido64`	cadena	No		Contenido PDF como cadena Base64. Acepta el formato URI de datos.
`URL del archivo`	cadena	No		URL HTTPS remota de un PDF para descargar y adjuntar.
`archivo`	archivo	No		Campo de carga de archivos (multipart/form-data).

Solicitar ejemplos

RIZO

curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorización: Portador YOUR_API_KEY" \ -F "invoice_guid=inv-8c3b4a99-2025-10-17" \ -F "file=@invoice.pdf"

curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorización: Portador YOUR_API_KEY" \ -H "Tipo de contenido: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "filename": "invoice.pdf", "content_base64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdl..." }"

curl -X POST "https://api.peppox.com/invoice_attach_pdf/add/" \ -H "Autorización: Portador YOUR_API_KEY" \ -H "Tipo de contenido: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17", "file_url": "https://example.com/invoice-2025.pdf" }"

Respuestas

Estado: 200 — PDF adjunto exitosamente a la factura.

JSON

{ "ok": verdadero, "invoice_guid": "inv-8c3b4a99-2025-10-17", "doc_id": "DOC-1452", "filename": "invoice-2025-10.pdf", "mime": "application/pdf", "size_bytes": 184527 }

Estado: 400 — Parámetros no válidos o contenido faltante (sin Base64, archivo o URL).

Estado: 401 — Clave API no válida o caducada.

Estado: 404 — Factura no encontrada.

Estado: 500 — Error interno del servidor o de la base de datos.

Generación de XML

/xml/generar • Métodos: CORREO

Generar un archivo XML UBL para una factura o nota de crédito.

Combina el encabezado, las líneas y el PDF adjunto (si lo hay) de la factura/nota de crédito en un documento XML UBL 3.0 compatible con Peppol. Devuelve la ruta local al archivo generado y actualiza el estado de la factura/nota de crédito a XML_BUILT.

CORREO /xml/generar • Tasa: 30 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Descripción
`clave de API`	cadena	Sí	Su clave API de Peppox para autenticación.
`guía de factura`	cadena	Sí	El identificador único de la factura a convertir a XML.
`guía`	cadena	No	Clave alternativa para invoice_guid.

Solicitar ejemplos

RIZO

PITÓN

curl -X POST "https://api.peppox.com/xml/generate/" \ -H "Autorización: Portador YOUR_API_KEY" \ -H "Tipo de contenido: application/json" \ -d "{ "invoice_guid": "inv-8c3b4a99-2025-10-17" }"

Respuestas

Estado: 200 — XML generado y almacenado exitosamente en el servidor.

JSON

{ "ok": verdadero, "estado": "XML_BUILT", "ruta_xml": "/var/www/vhosts/peppox.com/httpdocs/invoices_xml/inv-8c3b4a99-2025-10-17.xml" }

Estado: 400 — Faltan facturas_guid o líneas de factura.

Estado: 401 — Clave API no válida o caducada.

Estado: 404 — Factura no encontrada.

Estado: 500 — Error interno de generación o escritura de XML.

Notas de crédito

/nota de crédito/agregar • Métodos: CORREO

Agregar un encabezado de nota de crédito

Crea un nuevo encabezado de nota de crédito en estado BORRADOR. Los datos del proveedor se cargan automáticamente desde la cuenta de clave API, mientras que los campos de cliente, pago y entrega se obtienen de la solicitud.

CORREO /nota de crédito/agregar • Tasa: 60 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Tu clave API de Peppox.
`red`	cadena	No		Identificador de red opcional.
`ID de la nota de crédito`	cadena	No		Número/identificador de nota de crédito preferido.
`cn_id`	cadena	No		Alias alternativo para el ID de la nota de crédito.
`ID de nota de crédito`	cadena	No		Alias alternativo para el ID de la nota de crédito.
`inv_id`	cadena	No		Identificador heredado alternativo.
`fecha de asunto`	cadena	Sí		Fecha de emisión de la nota de crédito (AAAA-MM-DD).
`fecha de vencimiento`	cadena	No		Fecha de vencimiento (AAAA-MM-DD).
`código_tipo_factura`	cadena	No	381	Código de tipo de documento. Predeterminado 381 = Nota de crédito.
`divisa`	cadena	No	euros	Código de moneda ISO.
`costo contable`	cadena	No		Referencia contable interna.
`referencia del comprador`	cadena	No		Referencia del comprador / Referencia del pedido del cliente.
`código de medios de pago`	cadena	No	1	El pago significa código.
`pago.id_pago`	cadena	No		Referencia de pago.
`pago.iban`	cadena	No		IBAN del beneficiario.
`pago.nombre_de_cuenta`	cadena	No		Nombre de la cuenta del beneficiario.
`pago.bic`	cadena	No		Código BIC/SWIFT del beneficiario.
`nota sobre términos de pago`	cadena	No		Nota sobre condiciones de pago.
`fecha de entrega`	cadena	No		Fecha de entrega.
`esquema de ubicación de entrega`	cadena	No	0088	Esquema de ubicación de entrega.
`entrega.location_id`	cadena	No		Identificador del lugar de entrega.
`entrega.calle`	cadena	No		Calle de reparto.
`entrega.ciudad`	cadena	No		Ciudad de entrega.
`entrega postal`	cadena	No		Código postal de entrega.
`país de entrega`	cadena	No		Código del país de entrega.
`entrega.nombre_de_la_fiesta`	cadena	No		Nombre del grupo de entrega.
`proveedor.esquema_punto_final`	cadena	No	0208	Esquema del punto final del proveedor. Los valores del proveedor se cargan desde la cuenta de la API.
`cliente.endpoint_scheme`	cadena	No	0208	Esquema de punto final del cliente.
`cliente.id del punto final`	cadena	No		ID del punto final del cliente.
`nombre del cliente`	cadena	No		Nombre legal del cliente.
`cliente.calle`	cadena	No		Calle del cliente.
`cliente.ciudad`	cadena	No		Ciudad del cliente.
`cliente.postal`	cadena	No		Código postal del cliente.
`cliente.país`	cadena	No		Código de país del cliente.
`cliente.vat_id`	cadena	No		Número de IVA del cliente.
`cliente.esquema_id_empresa`	cadena	No	0208	Esquema de identificación de la empresa del cliente.
`cliente.id_de_empresa`	cadena	No		Identificación de la empresa del cliente.
`teléfono del cliente`	cadena	No		Teléfono del cliente.
`cliente.correo electrónico`	cadena	No		Correo electrónico del cliente.

Solicitar ejemplos

RIZO

PITÓN

curl -X POST "https://api.peppox.com/creditnote/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_id": "CN-2025-001", "issue_date": "2025-10-17", "currency": "EUR", "customer": { "endpoint_id": "9915:BE0123456789", "name": "ACME SPRL", "country": "BE" } }"

Respuestas

Estado: 200 — Nota de crédito creada con éxito.

JSON

{ "ok": true, "invoice_guid": "cn-8c3b4a99-2025-10-17", "document_type": "CREDIT_NOTE", "status": "BORRADOR" }

Estado: 400 — Campos inválidos o faltantes.

Estado: 401 — Clave API no válida o caducada.

Estado: 500 — Error interno del servidor o de la base de datos.

/línea_nota_crédito/agregar • Métodos: CORREO

Agregue una línea de nota de crédito

Agrega una línea a una nota de crédito existente. Acepta automáticamente alias para creditnote_guid y calcula tax_category a partir de tax_percent cuando sea posible.

CORREO /línea_nota_crédito/agregar • Tasa: 60 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Tu clave API de Peppox.
`guía_de_nota_de_crédito`	cadena	Sí		El GUID de la nota de crédito objetivo.
`guía de factura`	cadena	No		Alias para creditnote_guid.
`guía`	cadena	No		Alias para creditnote_guid.
`id de línea`	cadena	No		Identificador de línea interna opcional.
`ID de línea de pedido`	cadena	No		Alias para line_id.
`cantidad`	número	Sí		Cantidad de línea.
`cantidad`	número	No		Alias para cantidad.
`q`	número	No		Alias para cantidad.
`código de unidad`	cadena	No		Código de unidad.
`unidad`	cadena	No		Alias para unit_code.
`tú`	cadena	No		Alias para unit_code.
`precio_monto`	número	Sí		Importe del precio unitario.
`precio`	número	No		Alias para price_amount.
`precio_unitario`	número	No		Alias para price_amount.
`descripción del artículo`	cadena	No		Descripción de la línea.
`descripción`	cadena	No		Alias para item_description.
`descripción`	cadena	No		Alias para item_description.
`nombre_del_artículo`	cadena	No		Nombre/título del artículo.
`nombre`	cadena	No		Alias para item_name.
`título`	cadena	No		Alias para item_name.
`ID del artículo del vendedor`	cadena	No		ID del artículo del vendedor / SKU.
`ID del vendedor`	cadena	No		Alias para seller_item_id.
`sku`	cadena	No		Alias para seller_item_id.
`esquema de id. de elemento estándar`	cadena	No	0088	Esquema estándar de identificación de artículos.
`esquema estándar`	cadena	No		Alias para std_item_id_scheme.
`esquema`	cadena	No		Alias para std_item_id_scheme.
`id_del_elemento_estándar`	cadena	No		Identificador estándar del artículo (EAN, GTIN, etc.).
`gtin`	cadena	No		Alias para std_item_id.
`ean`	cadena	No		Alias para std_item_id.
`país de origen`	cadena	No		País natal.
`país`	cadena	No		Alias para el país de origen.
`categoría_de_impuesto`	cadena	No		Código de categoría de IVA. Se asigna automáticamente a S o Z según el porcentaje de impuestos.
`gato de impuestos`	cadena	No		Alias para tax_category.
`categoría_IVA`	cadena	No		Alias para tax_category.
`porcentaje de impuestos`	número	No		Porcentaje de IVA.
`tasa_de_IVA`	número	No		Alias para tax_percent.
`impuesto`	número	No		Alias para tax_percent.
`tina`	número	No		Alias para tax_percent.

Solicitar ejemplos

RIZO

PITÓN

curl -X POST "https://api.peppox.com/creditnote_line/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "quantity": 2, "unit_code": "H87", "price_amount": 49.99, "item_name": "Servicio de consultoría devuelto", "tax_percent": 21 }"

Respuestas

Estado: 200 — Línea de nota de crédito añadida correctamente.

JSON

{ "ok": verdadero, "line_guid": "line-2b4fa3c1-2025-10-17" }

Estado: 400 — Faltan valores obligatorios como creditnote_guid, cantidad o importe del precio.

Estado: 401 — Clave API no válida o caducada.

Estado: 500 — Error interno de la base de datos.

/adjuntar nota de crédito_pdf/agregar • Métodos: CORREO

Adjunte un PDF a una nota de crédito.

Adjunta un documento PDF a una nota de crédito existente mediante carga multiparte, carga útil Base64 o URL remota. El archivo adjunto anterior se reemplaza.

CORREO /adjuntar nota de crédito_pdf/agregar • Tasa: 30 solicitudes/min • Se requiere autorización

Parámetros

Nombre	Tipo	Requerido	Por defecto	Descripción
`clave de API`	cadena	Sí		Tu clave API de Peppox.
`guía_de_nota_de_crédito`	cadena	Sí		El GUID de la nota de crédito al que se adjuntará el PDF.
`guía de factura`	cadena	No		Alias para creditnote_guid.
`guía`	cadena	No		Alias para creditnote_guid.
`id_doc`	cadena	No		Identificador de documento opcional. Por defecto, se utiliza inv_id o un UUID generado.
`Nombre del archivo`	cadena	No	archivo adjunto.pdf	Nombre del archivo adjunto.
`mímica`	cadena	No	solicitud/pdf	Tipo MIME del archivo adjunto.
`base de contenido64`	cadena	No		Contenido PDF codificado en Base64.
`pdf_base64`	cadena	No		Alias para content_base64.
`URL del archivo`	cadena	No		URL HTTP/HTTPS del PDF que se debe descargar y adjuntar.
`URL del PDF`	cadena	No		Alias para file_url.
`archivo`	archivo	No		Archivo subido en varias partes.

Solicitar ejemplos

RIZO

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -F "creditnote_guid=cn-8c3b4a99-2025-10-17" -F "file=@creditnote.pdf"

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "filename": "creditnote.pdf", "content_base64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdl..." }"

curl -X POST "https://api.peppox.com/creditnote_attach_pdf/add/" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{ "creditnote_guid": "cn-8c3b4a99-2025-10-17", "file_url": "https://example.com/creditnote-2025.pdf" }"

Respuestas

Estado: 200 — El archivo PDF se ha adjuntado correctamente a la nota de crédito.

JSON

{ "ok": true, "creditnote_guid": "cn-8c3b4a99-2025-10-17", "doc_id": "CN-2025-001", "filename": "creditnote.pdf", "mime": "application/pdf", "size_bytes": 184527 }

Estado: 400 — Solicitud no válida: falta creditnote_guid, Base64 no válido, URL no válida o no se ha proporcionado contenido.

Estado: 401 — Clave API no válida o caducada.

Estado: 404 — Nota de crédito no encontrada.

Estado: 500 — Error interno de la base de datos o del manejo de archivos.

Webhooks

No hay webhooks documentados.

SDK

No hay SDK listados.

Catálogo de errores

No hay errores definidos.

Registro de cambios

Aún no hay lanzamientos