Desarrolladores Api Orzame

Facturas

Automatiza el proceso de creación y consulta de facturas de tus clientes.

Crear una factura proforma o borrador

Este endpoint permite la creación de una nueva factura proforma/borrador en tu aplicación.

Petición HTTP

POST/invoices

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Obligatorio	Nombre de la factura
contact_id	Entero / Obligatorio	Identificador de contacto
due_date_id	Entero / Obligatorio	Identificador de vencimiento
payment_method_id	Entero / Obligatorio	Identificador de método de pago
date	Fecha / Opcional / yyyy-mm-dd	Fecha de la factura en formato yyyy-mm-dd Si no se envía se establecerá hoy
lang	Cadena / Obligatorio	Idioma de la factura Idiomas disponibles en *data.options.langs* del endpoint: /info.
currency	Cadena / Obligatorio	Moneda de la factura Monedas disponibles en *data.options.currencies* del endpoint: /info.
date_format	Cadena / Obligatorio	Formato de fecha de la factura Formatos de fecha disponibles en *data.options.date_formats* del endpoint: /info.
money_format	Cadena / Obligatorio	Formato de moneda de la factura Formatos de moneda disponibles en *data.options.money_formats* del endpoint: /info.
notes	Cadena / Opcional	Notas privadas en la factura
intro_texts	Textos / Opcional	Array de objetos texto, se añadirán al principio de la factura¹
close_texts	Textos / Opcional	Array de objetos texto, se añadirán al final de la factura¹
lines	Array / Opcional	Array de objetos línea²
template	Plantilla / Opcional	Objeto plantilla³

Texto¹

Nombre	Tipo	Descripción
label	Cadena / Obligatorio	Nombre identificativo del texto
text	Cadena / Obligatorio / Máximo 5000 caracteres	Texto, admite formato básico en markdown, puede contener variables de sustitución

Los textos pueden contener variables de sustitución. Se pueden consultar las mismas en cualquier editor de textos en la aplicación.

Línea²

Nombre	Tipo	Descripción
product_id	Entero / Opcional	Identificador de producto Si se envía `product_id´ se establecerán los datos del producto y no es necesario enviar más datos
quantity	Entero / Obligatorio si no se envía `product_id´	Cantidad
price	Número hasta 2 decimales / Obligatorio si no se envía `product_id´	Precio / Puede contener un signo negativo como "-100.05"
description	Cadena / Obligatorio si no se envía `product_id´ / Máximo 500 caracteres	Descripción del producto o servicio
discount	Número hasta 2 decimales / Obligatorio si no se envía `product_id´ / Min:0 Max:100	Porcentaje de descuento aplicado al producto o servicio
taxes	Array / Opcional	Array de identificadores de impuestos que se aplicarán al producto o servicio

Plantilla de impresión³

Nombre	Tipo	Descripción
id	Entero / Obligatorio si se envía `template´	Identificador de plantilla. Identificadores de plantilla disponibles en *data.options.invoice_templates* del endpoint: /info.
options	Objeto / Obligatorio si se envía `template´	Objeto de opciones de plantilla⁴

Opciones de plantilla⁴

Nombre	Tipo	Descripción
use_company_color	Boolean / Obligatorio / true, false	Establece si se usa el color corporativo en al plantilla
include_texts_before	Boolean / Obligatorio / true, false	Establece si se incluyen los `intro_texts´ en la impresión
include_texts_after	Boolean / Obligatorio / true, false	Establece si se incluyen los `close_texts´ en la impresión

Datos petición

{
    "name": "Development and services invoice",
    "contact_id": 70,
    "due_date_id": 42,
    "payment_method_id": 58,
    "date": "2024-12-01",
    "lang":"gl",
    "currency": "ARS",
    "date_format": "yyyy-mm-dd",
    "money_format": "symbol_before,none,point",
    "notes" : "Automatically created invoice via API",
    "intro_texts": [
        {
            "label": "Header",
            "text": "# Invoice \n{document_title}"
        },
        {
            "label": "subheader",
            "text": "Invoice for development and services developed in the current year"
        }
    ],
    "close_texts": [
        {
            "label": "Thanks",
            "text": "#### Thank you very much for hiring our services.\n\nSincerely the ***dev team***."
        },
        {
            "label": "Link",
            "text": "If you have any questions, [visit our website](https:\/\/www.orzame.com) for more information."
        }
    ],
    "lines": [
        {
            "quantity": 1,
            "description": "Development and services",
            "price": 1800,
            "discount": 0,
            "taxes": [119,116]
        },{
            "product_id": 2932
        }
    ],
        "template": {
        "id": 3,
        "options": {
            "use_company_color": true,
            "include_texts_before": true,
            "include_texts_after": false
        }
    }
}

201Respuesta

{
    "data": {
        "id": 324,
        "name": "Development and services invoice",
        "type_id": 2,
        "serie": {
            "id": null,
            "name": null
        },
        "number": null,
        "e_invoicing": null,
        "date": "2024-12-01",
        "due_date": "2024-12-11",
        "payment_method": "Bank transfer to account number XXXX-XXXX-XXXX-XXXX-XXXX",
        "rectification_invoice_id": null,
        "issued_by": {
            "name": "Acme Inc. S.A.",
            "vat": "B00000000",
            "address": "Gran Via 1",
            "population": "Madrid",
            "province_state": "Madrid",
            "country": "ES",
            "zip": "28080"
        },
        "issued_to": {
            "id": 99,
            "name": "Acme S.L.",
            "number": "ESB2700001",
            "address": "Acme address nº 99",
            "population": "My City",
            "province_state": "My Province",
            "country": "ES",
            "zip": "55555"
        },
        "payed_at": null,
        "currency": "ARS",
        "lang": "gl",
        "date_format": "yyyy-mm-dd",
        "money_format": "symbol_before,none,point",
        "template": {
            "id": 3,
            "options": {
                "use_company_color": true,
                "include_texts_before": true,
                "include_texts_after": false
            }
        },
        "intro_texts": [
            {
                "label": "Header",
                "text": "# Invoice\n\nDevelopment and services invoice"
            },
            {
                "label": "subheader",
                "text": "Invoice for development and services developed in the current year"
            }
        ],
        "lines": [
            {
                "sku": "CS200010005",
                "product_id": 2932,
                "description": "Consulting with discount 5%",
                "quantity": 1,
                "price": 2250,
                "discount": 5,
                "business_line_id": 45,
                "subtotal": 2250,
                "total_discount": 112.5,
                "total_before_taxes": 2137.5,
                "taxes": [
                    {
                        "id": 116,
                        "name": "IVA (21%)",
                        "percentage": 21,
                        "total": 448.88
                        "version": "be9644a9-3bda-4d4a-9063-c371b8c01d3a",
                    }
                ],
                "total_taxes": 448.88,
                "total_with_taxes": 2586.38
            },
            {
                "sku": null,
                "product_id": null,
                "description": "Development and services",
                "quantity": 1,
                "price": 1800,
                "discount": 0,
                "business_line_id": null,
                "subtotal": 1800,
                "total_discount": 0,
                "total_before_taxes": 1800,
                "taxes": [
                    {
                        "id": 119,
                        "name": "IRPF (-15%)",
                        "percentage": -15,
                        "total": -270
                        "version": "50c63575-1e85-43b7-b7a3-5d8ad8fd4e51",
                    },
                    {
                        "id": 116,
                        "name": "IVA (21%)",
                        "percentage": 21,
                        "total": 378
                        "version": "be9644a9-3bda-4d4a-9063-c371b8c01d3a",
                    }
                ],
                "total_taxes": 108,
                "total_with_taxes": 1908
            }
        ],
        "close_texts": [
            {
                "label": "Thanks",
                "text": "#### Thank you very much for hiring our services.\n\nSincerely the ***dev team***."
            },
            {
                "label": "Link",
                "text": "If you have any questions, [visit our website](https:\/\/www.orzame.com) for more information."
            }
        ],
        "notes": "Automatically created invoice via API",
        "total_before_taxes": 3937.5,
        "total_taxes": 556.88,
        "total_with_taxes": 4494.38,
        "created_at": "2024-12-01T12:33:44+00:00",
        "updated_at": "2024-12-01T12:33:44+00:00"
    }
}

Listar facturas

Este endpoint permite la consulta de las facturas de tu aplicación.

No se obtienen todos los datos de una factura, para una consulta de datos completos es necesario usar el endpoint de petición de factura individual.

Petición HTTP

GET/invoices

Parámetros GET

Nombre	Tipo	Descripción
page	Entero / Opcional / Min:1	Página
per_page	Entero / Opcional / Min:1 Max:100	Elementos por página
type_id	Entero / Opcional	Filtrar por identificador de tipo de factura. Los identificadores de tipo de factura están disponibles en *data.options.invoice_types* del endpoint: /info.
contact_id	Entero / Opcional	Filtrar por identificador contacto
serie_id	Entero / Opcional	Filtrar por identificador de serie de factura
from	Fecha / Opcional / yyyy-mm-dd	Filtrar con fecha desde con formato yyyy-mm-dd, ejemplo: 2022-09-21
to	Fecha / Opcional / yyyy-mm-dd	Filtrar con fecha hasta con formato yyyy-mm-dd, ejemplo: 2022-09-21
unpaid	Boolean / Opcional / true	Mostrar las facturas impagadas. Esta opción hará que `type_id` siempre sea 1 (facturas ordinarias), el valor establecido en `type_id` será ignorado.
search	Cadena / Opcional / Min:3	Buscar por cadena de al menos 3 caracteres
order	Cadena / Opcional	Ordenar por un campo de forma ascendente o descendente, descendente por defecto, en formato "{field},desc" o "{field},asc" donde {field} puede ser: `id, name, date, due_date, total_before_taxes, total_taxes, total_with_taxes`

200 Respuesta

{
    "data": [
        {
            "id": 400,
            "name": "F1 corrective invoice dated (03\/10\/2024)",
            "type_id": 3,
            "serie": {
                "id": 2,
                "name": "R"
            },
            "number": 1,
            "e_invoicing": null,
            "date": "2024-03-10",
            "due_date": null,
            "payment_method": null,
            "rectification_invoice_id": 355,
            "issued_by": {
                "name": "Acme Inc. S.A.",
                "vat": "B00000000",
                "address": "Gran Via 1",
                "population": "Madrid",
                "province_state": "Madrid",
                "country": "ES",
                "zip": "28080"
            },
            "issued_to": {
                "id": 99,
                "name": "Acme S.L.",
                "number": "ESB2700001",
                "address": "Acme address nº 99",
                "population": "My City",
                "province_state": "My Province",
                "country": "ES",
                "zip": "55555"
            },
            "payed_at": null,
            "currency": "€",
            "lang": "en",
            "date_format": "mm\/dd\/yyyy",
            "money_format": "symbol_before,none,point",
            "total_before_taxes": -1350,
            "total_taxes": -283.5,
            "total_with_taxes": -1633.5,
            "created_at": "2024-03-09T16:31:28+00:00",
            "updated_at": "2024-03-09T16:31:28+00:00"
        },
        {
            "id": 300,
            "name": "Invoice for services provided",
            "type_id": 1,
            "serie": {
                "id": 1,
                "name": "F"
            },
            "number": 1,
            "e_invoicing": null,
            "date": "2024-03-10",
            "due_date": "2024-03-20",
            "payment_method": "Bank transfer to account number XXXX-XXXX-XXXX-XXXX-XXXX",
            "rectification_invoice_id": null,
            "issued_by": {
                "name": "Acme Inc. S.A.",
                "vat": "B00000000",
                "address": "Gran Via 1",
                "population": "Madrid",
                "province_state": "Madrid",
                "country": "ES",
                "zip": "28080"
            },
            "issued_to": {
                "id": 99,
                "name": "Acme S.L.",
                "number": "ESB2700001",
                "address": "Acme address nº 99",
                "population": "My City",
                "province_state": "My Province",
                "country": "ES",
                "zip": "55555"
            },
            "payed_at": "2024-03-15",
            "currency": "€",
            "lang": "en",
            "date_format": "mm\/dd\/yyyy",
            "money_format": "symbol_before,none,point",
            "total_before_taxes": 1350,
            "total_taxes": 283.5,
            "total_with_taxes": 1633.5,
            "created_at": "2024-03-09T16:31:23+00:00",
            "updated_at": "2024-03-09T16:31:23+00:00"
        },
        {
            "id": 200,
            "name": "Proforma invoice",
            "type_id": 2,
            "serie": {
                "id": null,
                "name": null
            },
            "number": null,
            "e_invoicing": null,
            "date": "2024-03-10",
            "due_date": "2024-03-20",
            "payment_method": "Bank transfer to account number XXXX-XXXX-XXXX-XXXX-XXXX",
            "rectification_invoice_id": null,
            "issued_by": {
                "name": "Acme Inc. S.A.",
                "vat": "B00000000",
                "address": "Gran Via 1",
                "population": "Madrid",
                "province_state": "Madrid",
                "country": "ES",
                "zip": "28080"
            },
            "issued_to": {
                "id": 99,
                "name": "Acme S.L.",
                "number": "ESB2700001",
                "address": "Acme address nº 99",
                "population": "My City",
                "province_state": "My Province",
                "country": "ES",
                "zip": "55555"
            },
            "payed_at": null,
            "currency": "€",
            "lang": "en",
            "date_format": "mm\/dd\/yyyy",
            "money_format": "symbol_before,none,point",
            "total_before_taxes": 1350,
            "total_taxes": 283.5,
            "total_with_taxes": 1633.5,
            "created_at": "2024-03-09T16:30:27+00:00",
            "updated_at": "2024-03-09T16:31:13+00:00"
        }
    ],
    "links": {
        "first": "http:\/\/api.orzame.com\/v1\/invoices?page=1",
        "last": "http:\/\/api.orzame.com\/v1\/invoices?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/api.orzame.com\/v1\/invoices",
        "per_page": 100,
        "to": 3,
        "total": 3
    }
}

Obtener una factura

Este endpoint permite la consulta de una factura completa de tu aplicación.

Los textos formateados son devueltos en formato markdown.

Petición HTTP

GET/invoices/{id}

200 Respuesta

{
    "data": {
        "id": 1234,
        "name": "Invoice design and printing",
        "type_id": 1,
        "serie": {
            "id": 1,
            "name": "F"
        },
        "number": 50,
        "e_invoicing": null,
        "date": "2024-03-10",
        "due_date": "2024-03-20",
        "payment_method": "Bank transfer to account XXXX-XXXX-XXXX-XXXX-XXXX",
        "rectification_invoice_id": null,
        "issued_by": {
            "name": "Acme Inc. S.A.",
            "vat": "B00000000",
            "address": "Gran Via 1",
            "population": "Madrid",
            "province_state": "Madrid",
            "country": "ES",
            "zip": "28080"
        },
        "issued_to": {
            "id": 99,
            "name": "Acme S.L.",
            "number": "ESB2700001",
            "address": "Acme address nº 99",
            "population": "My City",
            "province_state": "My Province",
            "country": "ES",
            "zip": "55555"
        },
        "payed_at": null,
        "currency": "€",
        "lang": "es",
        "date_format": "dd\/mm\/yyyy",
        "money_format": "symbol_before,none,point",
        "template": {
            "id": 1,
            "options": {
                "use_company_color": false,
                "include_texts_before": true,
                "include_texts_after": true
            }
        },
        "intro_texts": [
            {
                "label": "Name",
                "text": "Invoice design and printing"
            },
            {
                "label": "Details",
                "text": "Below you will **see the details** of the invoice."
            }
        ],
        "lines": [
            {
                "sku": "IM232323",
                "product_id": 2911,
                "description": "Producto one",
                "quantity": 1,
                "price": 2015,
                "discount": 10,
                "business_line_id": 43,
                "subtotal": 2015,
                "total_discount": 201.5,
                "total_before_taxes": 1813.5,
                "taxes": [
                    {
                        "id" : 115,
                        "name": "IVA 4 (4%)",
                        "percentage": 4,
                        "total": 72.54
                        "version": "10865ab8-2f4e-42f0-b051-6c121eddf37d",
                    }
                ],
                "total_taxes": 72.54,
                "total_with_taxes": 1886.04
            },
            {
                "sku": null,
                "product_id": null,
                "description": "Service two",
                "quantity": 1,
                "price": 2500,
                "discount": 15,
                "business_line_id": null,
                "subtotal": 2500,
                "total_discount": 375,
                "total_before_taxes": 2125,
                "taxes": [
                    {
                        "id" : 116,
                        "name": "IVA (21%)",
                        "percentage": 21,
                        "total": 446.25
                        "version": "be9644a9-3bda-4d4a-9063-c371b8c01d3a",
                    },
                    {
                        "id" : 119,
                        "name": "IRPF (-15%)",
                        "percentage": -15,
                        "total": -318.75
                        "version": "b6ec55ed-cbe6-4f76-9143-b27742cf1500",
                    }
                ],
                "total_taxes": 127.5,
                "total_with_taxes": 2252.5
            }
        ],
        "close_texts": [
            {
                "label": "Thanks",
                "text": "#### Thank you very much for hiring our services.\n\nSincerely the ***printing team***."
            },
            {
                "label": "Link",
                "text": "If you have any questions, [visit our website](https:\/\/www.orzame.com) for more information."
            }
        ],
        "notes": "Private note: invoice created from api",
        "total_before_taxes": 3938.5,
        "total_taxes": 200.04,
        "total_with_taxes": 4138.54,
        "created_at": "2024-03-10T16:43:47+00:00",
        "updated_at": "2024-03-10T20:32:55+00:00"
    }
}

Descargar una factura

Este endpoint permite la descarga de una factura de la aplicación.

La factura se generará en formato pdf basándose en las preferencias de la configuración de la aplicación.

Petición HTTP

GET/invoices/{id}/download

200 Respuesta

Descarga de factura en formato PDF.

Actualizar una factura

Este endpoint permite la actualización de una factura de tu aplicación.

Tanto los datos del emisor como del destinatario de la factura, se establecen con los datos que existen en el momento de creación de la factura y permanecen inmutables a no ser que se fuerce la recarga de los mismos.

La recarga se fuerza pasando el parámetro `reload_issued_by` a `true` para recargar los datos del emisor y pasando el parámetro `contact_id` para recargar los datos del destinatario.

Si tu configuración incluye la integración con una plataforma gubernamental de emisión de facturas —como Verifactu en España—, ten en cuenta que, una vez emitida una factura, ciertos datos no se pueden modificar. Estos incluyen los importes, la fecha de emisión, los datos del emisor y del cliente, así como la moneda utilizada.

Si intentas modificar alguno de estos datos, la API rechazará la solicitud y devolverá un error.

Petición HTTP

PATCH/invoices/{id}

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Opcional	Nombre de la factura
contact_id	Entero / Opcional	Identificador de contacto Si se envía se recargaran los datos el destinatario de la factura
due_date_id	Entero / Opcional	Identificador de vencimiento
payment_method_id	Entero / Opcional	Identificador de método de pago
date	Fecha / Opcional / yyyy-mm-dd	Fecha de la factura en formato yyyy-mm-dd Debe ser una fecha de facturación válida para la serie y número de factura
payed_at	Fecha de pago / Opcional / yyyy-mm-dd	Fecha de abono de la factura por el cliente en formato yyyy-mm-dd Pasando este valor a `null´ se eliminará la fecha de pago
lang	Cadena / Opcional	Idioma de la factura Idiomas disponibles en *data.options.langs* del endpoint: /info.
currency	Cadena / Opcional	Moneda de la factura Monedas disponibles en *data.options.currencies* del endpoint: /info.
date_format	Cadena / Opcional	Formato de fecha de la factura Formatos de fecha disponibles en *data.options.date_formats* del endpoint: /info.
money_format	Cadena / Opcional	Formato de moneda de la factura Formatos de moneda disponibles en *data.options.money_formats* del endpoint: /info.
notes	Cadena / Opcional	Notas privadas en la factura
reload_issued_by	Boolean / Opcional / true	Fuerza la recarga y establecimiento de los datos del emisor de la factura Datos disponibles en *data.app.owner* del endpoint: /info.
intro_texts	Textos / Opcional	Array de objetos texto, se añadirán al principio de la factura¹ Pasar un array vacío `[]´ eliminará los textos actuales No pasar este parámetro no hará ninguna modificación
close_texts	Textos / Opcional	Array de objetos texto, se añadirán al final de la factura¹ Pasar un array vacío `[]´ eliminará los textos actuales No pasar este parámetro no hará ninguna modificación
lines	Array / Opcional	Array de objetos línea² Pasar un array vacío `[]´ eliminará las líneas actuales No pasar este parámetro no hará ninguna modificación
template	Plantilla / Opcional	Objeto plantilla³

Texto¹

Nombre	Tipo	Descripción
label	Cadena / Obligatorio	Nombre identificativo del texto
text	Cadena / Obligatorio / Máximo 5000 caracteres	Texto, admite formato básico en markdown, puede contener variables de sustitución

Los textos pueden contener variables de sustitución. Se pueden consultar las mismas en cualquier editor de textos en la aplicación.

Línea²

Nombre	Tipo	Descripción
product_id	Entero / Opcional	Identificador de producto Si se envía `product_id´ se establecerán los datos del producto y no es necesario enviar más datos
quantity	Entero / Obligatorio si no se envía `product_id´	Cantidad
price	Número hasta 2 decimales / Obligatorio si no se envía `product_id´	Precio / Puede contener un signo negativo como "-100.05"
description	Cadena / Obligatorio si no se envía `product_id´ / Máximo 500 caracteres	Descripción del producto o servicio
discount	Número hasta 2 decimales / Obligatorio si no se envía `product_id´ / Min:0 Max:100	Porcentaje de descuento aplicado al producto o servicio
taxes	Array / Opcional	Array de identificadores de impuestos que se aplicarán al producto o servicio

Plantilla de impresión³

Nombre	Tipo	Descripción
id	Entero / Obligatorio si se envía `template´	Identificador de plantilla. Identificadores de plantilla disponibles en *data.options.invoice_templates* del endpoint: /info.
options	Objeto / Obligatorio si se envía `template´	Objeto de opciones de plantilla⁴

Opciones de plantilla⁴

Nombre	Tipo	Descripción
use_company_color	Boolean / Obligatorio / true, false	Establece si se usa el color corporativo en al plantilla
include_texts_before	Boolean / Obligatorio / true, false	Establece si se incluyen los `intro_texts´ en la impresión
include_texts_after	Boolean / Obligatorio / true, false	Establece si se incluyen los `close_texts´ en la impresión

Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.

Datos petición

{
    "name": "Development and services",
    "payed_at": "2024-12-12",
    "currency": "$",
    "lang": "en",
    "notes": "",
    "close_texts": []
}

200 Respuesta

{
    "data": {
        "id": 324,
        "name": "Development and services",
        "type_id": 1,
        "serie": {
            "id": 62,
            "name": "F"
        },
        "number": 6,
        "e_invoicing": null,
        "date": "2024-12-01",
        "due_date": "2024-12-11",
        "payment_method": "Bank transfer to account number XXXX-XXXX-XXXX-XXXX-XXXX",
        "rectification_invoice_id": null,
        "issued_by": {
            "name": "Acme Inc. S.A.",
            "vat": "B00000000",
            "address": "Gran Via 1",
            "population": "Madrid",
            "province_state": "Madrid",
            "country": "ES",
            "zip": "28080"
        },
        "issued_to": {
            "id": 99,
            "name": "Acme S.L.",
            "number": "ESB2700001",
            "address": "Acme address nº 99",
            "population": "My City",
            "province_state": "My Province",
            "country": "ES",
            "zip": "55555"
        },
        "payed_at": "2024-12-12",
        "currency": "$",
        "lang": "en",
        "date_format": "yyyy-mm-dd",
        "money_format": "symbol_before,none,point",
        "template": {
            "id": 3,
            "options": {
                "use_company_color": true,
                "include_texts_before": true,
                "include_texts_after": false
            }
        },
        "intro_texts": [
            {
                "label": "Header",
                "text": "# Invoice\n\nDevelopment and services invoice"
            },
            {
                "label": "subheader",
                "text": "Invoice for development and services developed in the current year"
            }
        ],
        "lines": [
            {
                "sku": "CS200010005",
                "product_id": 2932,
                "description": "Consulting with discount 5%",
                "quantity": 1,
                "price": 2250,
                "discount": 5,
                "business_line_id": 45,
                "subtotal": 2250,
                "total_discount": 112.5,
                "total_before_taxes": 2137.5,
                "taxes": [
                    {
                        "id": 116,
                        "name": "IVA (21%)",
                        "percentage": 21,
                        "total": 448.88
                        "version": "be9644a9-3bda-4d4a-9063-c371b8c01d3a",
                    }
                ],
                "total_taxes": 448.88,
                "total_with_taxes": 2586.38
            },
            {
                "sku": null,
                "product_id": null,
                "description": "Development and services",
                "quantity": 1,
                "price": 1800,
                "discount": 0,
                "business_line_id": null,
                "subtotal": 1800,
                "total_discount": 0,
                "total_before_taxes": 1800,
                "taxes": [
                    {
                        "id": 119,
                        "name": "IRPF (-15%)",
                        "percentage": -15,
                        "total": -270
                        "version": "50c63575-1e85-43b7-b7a3-5d8ad8fd4e51",
                    },
                    {
                        "id": 116,
                        "name": "IVA (21%)",
                        "percentage": 21,
                        "total": 378
                        "version": "be9644a9-3bda-4d4a-9063-c371b8c01d3a",
                    }
                ],
                "total_taxes": 108,
                "total_with_taxes": 1908
            }
        ],
        "close_texts": [],
        "notes": "",
        "total_before_taxes": 3937.5,
        "total_taxes": 556.88,
        "total_with_taxes": 4494.38,
        "created_at": "2024-12-01T12:33:44+00:00",
        "updated_at": "2024-12-01T12:33:44+00:00"
    }
}

Eliminar una factura

Este endpoint permite la eliminación de una factura de tu aplicación.

Solamente es posible eliminar la última factura creada en una serie. Cualquier factura proforma puede ser eliminada. Las facturas ya emitidas no se pueden eliminar en sistemas integrados con plataformas gubernamentales, como Verifactu, debido a las restricciones legales y de integridad fiscal.

Petición HTTP

DELETE/invoices/{id}

204 Respuesta

Respuesta sin cuerpo.

Factura electrónica "e_invoicing"

Información sobre la integración de la aplicación con plataformas de facturación electrónica.

Si la aplicación está enviando facturas a un sistema externo de facturación electrónica gubernamental (o similar), el campo "e_invoicing" en las respuestas puede incluir información relacionada con dicho proceso de envío.

...
"e_invoicing": {
    "system": "VERIFACTU",
    "country": "ES",
    "processed": true,
    "on_error": false,
    "external_link": "https://prewww2.aeat.es/wlpl/TIKE-CONT/ValidarQR?nif=B12345678&numserie=F1000%2F52&fecha=15-05-2025&importe=5297.01"
},
...

Emitir una factura

Este endpoint permite la emisión de una factura final en tu aplicación.

Petición HTTP

POST/invoices/{id}/issue

Parámetros

Nombre	Tipo	Descripción
date	Fecha / Obligatorio / yyyy-mm-dd	Fecha de la factura en formato yyyy-mm-dd Fecha válida de emisión de la factura en la serie seleccionada
serie_id	Entero / Obligatorio	Identificador de serie de factura
delete_proforma	Boolean / Opcional	Indica si se debe eliminar la proforma/borrador al emitir la factura. Si no se envía este parámetro o es `false´, la proforma/borrador no se eliminará

Datos petición

{
    "date": "2025-10-03",
    "serie_id": "208",
    "delete_proforma": false
}

201Respuesta

La respuesta contendrá el identificador de la nueva factura generada.

{
    "data": {
        "issue_invoice_id": 555,
        "e_invoicing": {
            "system": "VERIFACTU",
            "country": "ES",
            "processed": false,
            "on_error": false,
            "external_link": "https://prewww2.aeat.es/wlpl/TIKE-CONT/ValidarQR?nif=B123456789&numserie=VT3&fecha=03-10-2025&importe=135.52"
        }
    }
}

Rectificar una factura

Este endpoint permite la rectificación de una factura en tu aplicación.

Petición HTTP

POST/invoices/{id}/rectify

Parámetros

Nombre	Tipo	Descripción
date	Fecha / Obligatorio / yyyy-mm-dd	Fecha de la factura en formato yyyy-mm-dd Fecha válida de emisión de la factura en la serie seleccionada
serie_id	Entero / Obligatorio	Identificador de serie de factura

Datos petición

{
    "date": "2025-10-04",
    "serie_id": "201"
}

201Respuesta

La respuesta contendrá el identificador de la nueva factura generada.

{
    "data": {
        "rectification_invoice_id": 556,
        "e_invoicing": {
          "system": "VERIFACTU",
          "country": "ES",
          "processed": false,
          "on_error": false,
          "external_link": "https://prewww2.aeat.es/wlpl/TIKE-CONT/ValidarQR?nif=B27346063&numserie=R2&fecha=04-10-2025&importe=-135.52"
        }
    }
}

Facturas

Crear una factura proforma o borrador

Petición HTTP

Parámetros

Texto1

Línea2

Plantilla de impresión3

Opciones de plantilla4

Datos petición

201Respuesta

Listar facturas

Petición HTTP

Parámetros GET

200 Respuesta

Obtener una factura

Petición HTTP

200 Respuesta

Descargar una factura

Petición HTTP

200 Respuesta

Actualizar una factura

Petición HTTP

Parámetros

Texto1

Línea2

Plantilla de impresión3

Opciones de plantilla4

Datos petición

200 Respuesta

Eliminar una factura

Petición HTTP

204 Respuesta

Factura electrónica "e_invoicing"

Emitir una factura

Petición HTTP

Parámetros

Datos petición

201Respuesta

Rectificar una factura

Petición HTTP

Parámetros

Datos petición

201Respuesta

Texto¹

Línea²

Plantilla de impresión³

Opciones de plantilla⁴

Texto¹

Línea²

Plantilla de impresión³

Opciones de plantilla⁴