Saltar al contenido principal

Guía rápida de la API de a3factura

Atención

Todas las peticiones a la API han de tener informado en la cabecera:

  • Ocp-Apim-Subscription-Key: valor fijo con la API key que os hemos facilitado.
  • Authorization: es un applicationToken válido.

Documentación de interés

Para crear facturas de forma óptima se deben tener una serie de entidades configuradas en la empresa:

  1. Tener una actividad creada en la empresa
  2. Tener una serie de facturación creada en la empresa
  3. Tener clientes creados en la empresa (no es obligatorio en facturas simplificadas)
  4. Tener productos creados en la empresa (no es obligatorio en las líneas de factura)
  5. Informar los datos de cabecera de factura (SaleInvocies)
  6. Informar los datos de línea de factura (SaleInvoicesLine)
  7. Informar los id de entidades maestras como PaymentType, PaymentMethod, etc…

Actividades

MétodoDescripción
GET api/activitiesObtiene la lista de actividades de una empresa.
GET api/activities/{id}Obtiene una actividad.
GET api/activitiesCrea una nueva actividad.
GET api/activities/{id}/antifraud/configModifica la configuración de antifraude de una actividad existente.

Series

MétodoDescripción
GET api/seriesObtiene la lista de series de una empresa.
GET api/series/{id}Obtiene una serie.
POST api/seriesCrea una nueva serie.
PUT api/series/{id}/antifraud/configModifica la configuración de antifraude de una serie existente.

Empresas

MétodoDescripción
GET api/companyObtiene la información de una empresa.
GET api/company/settingsObtiene la configuración de una empresa.
PATCH api/companyModifica alguna/s propiedad/es de la información de una empresa.
PATCH api/company/settingsModifica alguna/s propiedad/es de la configuración de una empresa.

Clientes

MétodoDescripción
GET api/customersObtiene la lista de clientes de una empresa.
GET api/customers/{id}Obtiene un cliente.
GET api/customers/newObtiene un nuevo cliente con valores por defecto de la empresa.
POST api/customersCrea un nuevo cliente.
PATCH api/customers/{id}Modifica alguna/s propiedad/es de un cliente.

Productos

MétodoDescripción
GET api/productsObtiene la lista de productos/servicios de una empresa.
GET api/products/{id}Obtiene un producto/servicio.
GET api/products/newObtiene un nuevo producto/servicio con valores por defecto de la empresa.
POST api/productsCrea un nuevo producto/servicio.
PATCH api/products/{id}Modifica alguna/s propiedad/es de un producto.

Facturas de venta

MétodoDescripción
GET api/saleInvoicesObtiene la lista de facturas de una empresa.
GET api/saleInvoices/{id}Obtiene una factura.
GET api/saleInvoices/newObtiene una nueva factura con valores por defecto de la empresa.
- Indicando customerId (opcional)
GET api/saleInvoices/newLineObtiene una nueva línea de factura con valores por defecto de la empresa.
- Indicando customerId (opcional)
- Indicando productId (opcional)
POST api/saleInvoicesCrea una nueva factura.
PUT api/saleInvoicesModifica una factura.
GET api/saleInvoices/{id}/pdfObtiene el pdf impreso de una factura.

En la respuesta del POST de api/saleInvoices se devuelve la siguiente estructura que incluye el endpoint para descargar el QR generado para Veri*factu de la factura creada:

{
"qrUrl": "https://a3factura.wolterskluwer.es/services/api/registeredInvoices/e7e71d2b-9bac-47ae-ba68-ecf56618765f2/footPrint",
"invoiceUtcGenerationDate": "2025-06-05T13:29:00.4+00:00",
"ok": true,
"result": "611710f1-3a76-48a4-b2d0-0b5b6654yuj5",
"messages": []
}

Métodos Veri*factu

MétodoDescripción
GET api/registeredInvoices/{id}/footPrintObtiene el QR de Veri*factu de una factura.
GET api/registeredInvoices/{id}/xmlObtiene el XML de Veri*factu de una factura.
GET api/registeredInvoices/{id}/sendResponseObtiene la respuesta de Veri*factu al envío de una factura.
Webhook InvoiceStatusDevuelve el cambio de estado de Veri*factu del envío de una factura. La acción a utilizar es Update
El estado Veri*factu de una factura también se puede recuperar con el método sendResponse de registeredInvoices.

Método exportación SUENLACE

MétodoDescripción
POST api/export/suenlaceExportación asíncrona de un periodo en formato SUENLACE.
Devuelve el identificador del proceso iniciado.
Webhook SuenlaceExportComunica la finalización del proceso de exportación del fichero SUENLACE. La acción a utilizar es Update