Orzame Api Developers

Invoices

Automate the process of creating and consulting invoices from your clients.

Create a proforma or draft invoice

This endpoint allows the creation of a new proforma/draft invoice in your application.

HTTP Request

POST/invoices

Parameters

Name	Type	Description
name	String / Required	Invoice name
contact_id	Integer / Required	Contact identifier
due_date_id	Integer / Required	Due date identifier
payment_method_id	Integer / Required	Payment method identifier
date	Date / Optional / yyyy-mm-dd	Invoice date in format yyyy-mm-dd If not sent, today will be set
lang	String / Required	Invoice language Languages available in *data.options.langs* of the endpoint: /info.
currency	String / Required	Invoice currency Currencies available in *data.options.currencies* of the endpoint: /info.
date_format	String / Required	Invoice date format Date formats available in *data.options.date_formats* of the endpoint: /info.
money_format	String / Required	Invoice currency format Currency formats available in *data.options.money_formats* of the endpoint: /info.
notes	String / Optional	Private notes in the invoice
intro_texts	Texts / Optional	Array of text objects, they will be added at the beginning of the invoice¹
close_texts	Texts / Optional	Array of text objects, they will be added at the end of the invoice¹
lines	Array / Optional	Array of line objects²
template	Plantilla / Optional	Template object³

Text¹

Name	Type	Description
label	String / Required	Identifying name of the text
text	String / Required / Maximum 5000 characters	Text, supports basic markdown format, can contain substitution variables

Texts can contain substitution variables. They can be consulted in any text editor in the application.

Line²

Name	Type	Description
product_id	Integer / Optional	Product identifier If `product_id´ is sent, the product data will be set and it is not necessary to send more data
quantity	Integer / Required if `product_id´ is not sent	Quantity
price	Number up to 2 decimals / Required if `product_id´ is not sent	Price / Can contain a negative sign as "-100.05"
description	String / Required if `product_id´ is not sent / Maximum 500 characters	Product or service description
discount	Number up to 2 decimals / Required if `product_id´ is not sent / Min:0 Max:100	Discount percentage applied to the product or service
taxes	Array / Optional	Array of tax identifiers that will be applied to the product or service

Print template³

Name	Type	Description
id	Integer / Required if `template´ is sent	Template identifier. Template identifiers available in *data.options.invoice_templates* of the endpoint: /info.
options	Object / Required if `template´ is sent	Template options object⁴

Template options⁴

Name	Type	Description
use_company_color	Boolean / Required / true, false	Set if the corporate color is used in the template
include_texts_before	Boolean / Required / true, false	Set if the `intro_texts´ are included in the print
include_texts_after	Boolean / Required / true, false	Set if the `close_texts´ are included in the print

Playload

{
    "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
        }
    }
}

201Response

{
    "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"
    }
}

List invoices

This endpoint allows the consultation of invoices from your application.

Not all the data of an invoice is obtained, for a complete data query it is necessary to use the individual invoice request endpoint.

HTTP Request

GET/invoices

GET Parameters

Name	Type	Description
page	Integer / Optional / Min:1	Page
per_page	Integer / Optional / Min:1 Max:100	Items per page
type_id	Integer / Optional	Filter by invoice type identifier. Invoice type identifiers are available in *data.options.invoice_types* of the endpoint: /info.
contact_id	Integer / Optional	Filter by contact identifier
serie_id	Integer / Optional	Filter by invoice series identifier
from	Date / Optional / yyyy-mm-dd	Filter with date from format yyyy-mm-dd, example: 2022-09-21
to	Date / Optional / yyyy-mm-dd	Filter with date until format yyyy-mm-dd, example: 2022-09-21
unpaid	Boolean / Optional / true	Show unpaid invoices. This option will make `type_id` always be 1 (ordinary invoices), the value set in `type_id` will be ignored.
search	String / Optional / Min:3	Search by string of at least 3 characters
order	String / Optional	Order by a field in ascending or descending, descending by default, in format "{field},desc" or "{field},asc" where {field} can be: `id, name, date, due_date, total_before_taxes, total_taxes, total_with_taxes`

200 Response

{
    "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
    }
}

Get an invoice

This endpoint allows the consultation of a complete invoice from your application.

Formatted texts are returned in markdown format.

HTTP Request

GET/invoices/{id}

200 Response

{
    "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"
    }
}

Download an invoice

This endpoint allows the download of an invoice from the application.

The invoice will be generated in pdf format based on the preferences of the application configuration.

HTTP Request

GET/invoices/{id}/download

200 Response

Download invoice in PDF format.

Update an invoice

This endpoint allows the update of an invoice from your application.

Both the data of the issuer and the recipient of the invoice are established with the data that exists at the time of creation of the invoice and remain unchanged unless they are forced to be recharged.

The recharge is forced by passing the parameter `reload_issued_by` to `true` to reload the data of the issuer and passing the parameter `contact_id` to reload the data of the recipient.

If your setup includes integration with a government-issued invoicing platform —such as Verifactu in Spain—, please note that once an invoice has been issued, certain details cannot be modified. These include financial information, issue date, issuer and customer information, as well as the currency used.

If you attempt to modify any of this data, the API will reject the request and return an error.

HTTP Request

PATCH/invoices/{id}

Parameters

Name	Type	Description
name	String / Optional	Invoice name
contact_id	Integer / Optional	Contact identifier If sent, the data of the recipient of the invoice will be reloaded
due_date_id	Integer / Optional	Due date identifier
payment_method_id	Integer / Optional	Payment method identifier
date	Date / Optional / yyyy-mm-dd	Invoice date in format yyyy-mm-dd It must be a valid billing date for the series and invoice number
payed_at	Payment date / Optional / yyyy-mm-dd	Payment date of the invoice by the client in format yyyy-mm-dd Passing this value to `null´ will delete the payment date
lang	String / Optional	Invoice language Languages available in *data.options.langs* of the endpoint: /info.
currency	String / Optional	Invoice currency Currencies available in *data.options.currencies* of the endpoint: /info.
date_format	String / Optional	Invoice date format Date formats available in *data.options.date_formats* of the endpoint: /info.
money_format	String / Optional	Invoice currency format Currency formats available in *data.options.money_formats* of the endpoint: /info.
notes	String / Optional	Private notes in the invoice
reload_issued_by	Boolean / Optional / true	Forces the reload and establishment of the data of the issuer of the invoice Datos disponibles en *data.app.owner* del endpoint: /info.
intro_texts	Texts / Optional	Array of text objects, they will be added at the beginning of the invoice¹ Passing an empty array `[]´ will delete the current texts Not passing this parameter will not make any changes
close_texts	Texts / Optional	Array of text objects, they will be added at the end of the invoice¹ Passing an empty array `[]´ will delete the current texts Not passing this parameter will not make any changes
lines	Array / Optional	Array of line objects² Pasar un array vacío `[]´ eliminará las líneas actuales Not passing this parameter will not make any changes
template	Plantilla / Optional	Template object³

Text¹

Name	Type	Description
label	String / Required	Identifying name of the text
text	String / Required / Maximum 5000 characters	Text, supports basic markdown format, can contain substitution variables

Texts can contain substitution variables. They can be consulted in any text editor in the application.

Line²

Name	Type	Description
product_id	Integer / Optional	Product identifier If `product_id´ is sent, the product data will be set and it is not necessary to send more data
quantity	Integer / Required if `product_id´ is not sent	Quantity
price	Number up to 2 decimals / Required if `product_id´ is not sent	Price / Can contain a negative sign as "-100.05"
description	String / Required if `product_id´ is not sent / Maximum 500 characters	Product or service description
discount	Number up to 2 decimals / Required if `product_id´ is not sent / Min:0 Max:100	Discount percentage applied to the product or service
taxes	Array / Optional	Array of tax identifiers that will be applied to the product or service

Print template³

Name	Type	Description
id	Integer / Required if `template´ is sent	Template identifier. Template identifiers available in *data.options.invoice_templates* of the endpoint: /info.
options	Object / Required if `template´ is sent	Template options object⁴

Template options⁴

Name	Type	Description
use_company_color	Boolean / Required / true, false	Set if the corporate color is used in the template
include_texts_before	Boolean / Required / true, false	Set if the `intro_texts´ are included in the print
include_texts_after	Boolean / Required / true, false	Set if the `close_texts´ are included in the print

All parameters are optional but at least one parameter with value must be sent.

Playload

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

200 Response

{
    "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"
    }
}

Delete an invoice

This endpoint allows the deletion of an invoice from your application.

Only the last invoice created in a series can be deleted. Any pro forma invoice can be deleted. Issued invoices cannot be deleted in systems integrated with government platforms, such as Verifactu, due to legal and tax integrity restrictions.

HTTP Request

DELETE/invoices/{id}

204 Response

Response without body.

Electronic invoice "e_invoicing"

Information about the integration of the application with e-invoicing platforms.

If the application is sending invoices to an external government e-invoicing system (or similar), the "e_invoicing" field in the responses may include information related to that submission process.

...
"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"
},
...

Issue an invoice

This endpoint allows the issuance of a final invoice in your application.

HTTP Request

POST/invoices/{id}/issue

Parameters

Name	Type	Description
date	Date / Required / yyyy-mm-dd	Invoice date in format yyyy-mm-dd Valid issue date of the invoice in the selected series
serie_id	Integer / Required	Invoice series identifier
delete_proforma	Boolean / Optional	Indicates whether to delete the proforma/draft when issuing the invoice. If this parameter is not sent or is `false´, the proforma/draft will not be deleted

Playload

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

201Response

The response will contain the identifier of the new generated invoice.

{
    "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"
        }
    }
}

Rectify an invoice

This endpoint allows the rectification of an invoice in your application.

HTTP Request

POST/invoices/{id}/rectify

Parameters

Name	Type	Description
date	Date / Required / yyyy-mm-dd	Invoice date in format yyyy-mm-dd Valid issue date of the invoice in the selected series
serie_id	Integer / Required	Invoice series identifier

Playload

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

201Response

The response will contain the identifier of the new generated invoice.

{
    "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"
        }
    }
}

Invoices

Create a proforma or draft invoice

HTTP Request

Parameters

Text1

Line2

Print template3

Template options4

Playload

201Response

List invoices

HTTP Request

GET Parameters

200 Response

Get an invoice

HTTP Request

200 Response

Download an invoice

HTTP Request

200 Response

Update an invoice

HTTP Request

Parameters

Text1

Line2

Print template3

Template options4

Playload

200 Response

Delete an invoice

HTTP Request

204 Response

Electronic invoice "e_invoicing"

Issue an invoice

HTTP Request

Parameters

Playload

201Response

Rectify an invoice

HTTP Request

Parameters

Playload

201Response

Text¹

Line²

Print template³

Template options⁴

Text¹

Line²

Print template³

Template options⁴