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
- Documentación del flujo de onboarding del escenario 2.
- Documentación del flujo de pedidos de licencias de a3factura.
- Documentación de enpoints funcionales de a3factura.
- Documentación del sistema de webhooks de a3factura.
Para crear facturas de forma óptima se deben tener una serie de entidades configuradas en la empresa:
- Tener una actividad creada en la empresa
- Tener una serie de facturación creada en la empresa
- Tener clientes creados en la empresa (no es obligatorio en facturas simplificadas)
- Tener productos creados en la empresa (no es obligatorio en las líneas de factura)
- Informar los datos de cabecera de factura (SaleInvocies)
- Informar los datos de línea de factura (SaleInvoicesLine)
- Informar los
id
de entidades maestras como PaymentType, PaymentMethod, etc…
Actividades
Método | Descripción |
---|---|
GET api/activities | Obtiene la lista de actividades de una empresa. |
GET api/activities/{id} | Obtiene una actividad. |
GET api/activities | Crea una nueva actividad. |
GET api/activities/{id}/antifraud/config | Modifica la configuración de antifraude de una actividad existente. |
Series
Método | Descripción |
---|---|
GET api/series | Obtiene la lista de series de una empresa. |
GET api/series/{id} | Obtiene una serie. |
POST api/series | Crea una nueva serie. |
PUT api/series/{id}/antifraud/config | Modifica la configuración de antifraude de una serie existente. |
Empresas
Método | Descripción |
---|---|
GET api/company | Obtiene la información de una empresa. |
GET api/company/settings | Obtiene la configuración de una empresa. |
PATCH api/company | Modifica alguna/s propiedad/es de la información de una empresa. |
PATCH api/company/settings | Modifica alguna/s propiedad/es de la configuración de una empresa. |
Clientes
Método | Descripción |
---|---|
GET api/customers | Obtiene la lista de clientes de una empresa. |
GET api/customers/{id} | Obtiene un cliente. |
GET api/customers/new | Obtiene un nuevo cliente con valores por defecto de la empresa. |
POST api/customers | Crea un nuevo cliente. |
PATCH api/customers/{id} | Modifica alguna/s propiedad/es de un cliente. |
Productos
Método | Descripción |
---|---|
GET api/products | Obtiene la lista de productos/servicios de una empresa. |
GET api/products/{id} | Obtiene un producto/servicio. |
GET api/products/new | Obtiene un nuevo producto/servicio con valores por defecto de la empresa. |
POST api/products | Crea un nuevo producto/servicio. |
PATCH api/products/{id} | Modifica alguna/s propiedad/es de un producto. |
Facturas de venta
Método | Descripción |
---|---|
GET api/saleInvoices | Obtiene la lista de facturas de una empresa. |
GET api/saleInvoices/{id} | Obtiene una factura. |
GET api/saleInvoices/new | Obtiene una nueva factura con valores por defecto de la empresa. - Indicando customerId (opcional) |
GET api/saleInvoices/newLine | Obtiene una nueva línea de factura con valores por defecto de la empresa. - Indicando customerId (opcional) - Indicando productId (opcional) |
POST api/saleInvoices | Crea una nueva factura. |
PUT api/saleInvoices | Modifica una factura. |
GET api/saleInvoices/{id}/pdf | Obtiene 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étodo | Descripción |
---|---|
GET api/registeredInvoices/{id}/footPrint | Obtiene el QR de Veri*factu de una factura. |
GET api/registeredInvoices/{id}/xml | Obtiene el XML de Veri*factu de una factura. |
GET api/registeredInvoices/{id}/sendResponse | Obtiene la respuesta de Veri*factu al envío de una factura. |
Webhook InvoiceStatus | Devuelve 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étodo | Descripción |
---|---|
POST api/export/suenlace | Exportación asíncrona de un periodo en formato SUENLACE. Devuelve el identificador del proceso iniciado. |
Webhook SuenlaceExport | Comunica la finalización del proceso de exportación del fichero SUENLACE. La acción a utilizar es Update |