Invoices
Businesses are able to create and manage invoices for their bookings on Bookinglayer.
The Invoice object
{
"data": {
"id": "a7443538-95e8-4ac9-b252-82d55b7887e9",
"date": "2023-07-04T12:55:54+00:00",
"due_date": "2023-07-18T12:55:54+00:00",
"status": "closed",
"reference": {
"full": "20237322",
"prefix": "20237",
"suffix": "",
"number": 322
},
"total_price_excl_tax": 2181.82,
"final_price_incl_tax": 2400,
"discount_total": 0,
"final_price_excl_tax": 2181.82,
"total_price_incl_tax": 2400,
"tax_component": 218.18,
"discounted_tax": 0,
"final_tax_component": 0,
"creditable_amount": 0,
"credit_total": 0,
"amount_due": 0,
"amount_paid": 2400,
"display": "items",
"comment": null,
"currency": "EUR",
"tax_breakdown": {
{
"rate": 10,
"amount": 218.18,
"final_price_excl": 2181.82
}
}
"booking": {
"id": "2361736f-1646-426d-acf6-04c4f9d785dd"
},
"payments": [
{
"id": "ed3b8ffa-6ea7-4019-a9ba-3045caa7ab85",
"currency": "EUR",
"amount": 2400,
"refund_amount": 0,
"surcharge": 0,
"status": "ok",
"cc_brand": null,
"cc_last4": null,
"foreign_currency": null,
"amount_in_foreign_currency": null,
"transaction_reference": null,
"comment": null,
"metadata": null,
"ip_address": null,
"user": {
"id": "c6eef2d5-1019-11e9-bd3b-04016aacf401"
},
"booking": {
"id": "2361736f-1646-426d-acf6-04c4f9d785dd"
},
"guest": null,
"invoice": {
"id": "a7443538-95e8-4ac9-b252-82d55b7887e9"
},
"payment_gateway": {
"id": 57,
"backoffice_title": "On site",
"slug": "onsite",
"description": "Activate this if you want to give bookers the option on your Payment Form to select an on site payment.",
"is_frontoffice": true,
"has_icon": false,
"invoicexpress_code": "OU",
"is_bookinglayer_pro": false,
"provider": null,
"provider_url": null,
"knowledge_base_link": null,
"notifications": null,
"created_at": "2018-12-05T17:47:23.000000Z",
"updated_at": "2020-10-22T11:38:56.000000Z",
"frontoffice": true,
"title": "On site",
"frontoffice_title": "On site"
},
"gift_certificate": null,
"paid_at": "2023-07-03T12:57:00+00:00",
"deleted_at": null,
"created_at": "2023-07-03T10:57:52+00:00",
"updated_at": "2023-07-04T12:56:00+00:00",
"status_message": null,
"channel": "backoffice"
}
],
"lines": [
{
"id": 4744208,
"title": "Room Jenny",
"title_translation": {
"en": null
},
"package_title": null,
"package_title_translation": null,
"unit_price_incl_tax": 200,
"qty": 4,
"total_price_incl_tax": 800,
"discount_value": 0,
"discount_rate": 0,
"final_price_incl_tax": 800,
"tax_rate": "10.00",
"tax_value": 72.73,
"creditable_amount": 0,
"credit_total": 0,
"deleted_at": null,
"created_at": "2023-07-04T12:55:50+00:00",
"updated_at": "2023-07-04T12:55:50+00:00"
},
{
"id": 4744209,
"description": "Room Jenny",
"description_translation": {
"en": null
},
"package_title_translation": null,
"unit_price_incl_tax": 200,
"qty": 4,
"total_price_incl_tax": 800,
"discount_value": 0,
"discount_rate": 0,
"final_price_incl_tax": 800,
"tax_rate": "0.00",
"tax_value": 0,
"creditable_amount": 0,
"credit_total": 0,
"deleted_at": null,
"created_at": "2023-07-04T12:55:50+00:00",
"updated_at": "2023-07-04T12:55:50+00:00"
},
{
"id": 4744210,
"description": "Room Jenny",
"description_translation": {
"en": null
},
"package_title_translation": null,
"unit_price_incl_tax": 200,
"qty": 4,
"total_price_incl_tax": 800,
"discount_value": 0,
"discount_rate": 0,
"final_price_incl_tax": 800,
"tax_rate": "0.00",
"tax_value": 0,
"creditable_amount": 0,
"credit_total": 0,
"deleted_at": null,
"created_at": "2023-07-04T12:55:50+00:00",
"updated_at": "2023-07-04T12:55:50+00:00"
}
],
"exports": [
{
"service": "fatture_in_cloud",
"external_id": 553232,
"status": "sent"
}
],
"created_at": "2023-07-04T12:55:50+00:00",
"updated_at": "2023-07-04T12:56:01+00:00"
}
}Endpoints
Get a paginated list of all invoices
Filter invoices by invoiced price
500,1000Filter invoices by the date they were generated on
2024-05-10,2024-05-15Filter invoices by the date they were closed on
2024-05-10,2024-05-15Filter invoices by number
15Filter invoices by the date the booking they belong to was created on
2024-05-10,2024-05-15Filter invoices by the the status of the booking they belong to
Filter between closed or draft invoices
Filter invoices by the location of the booking they belong to
15,227Filter invoices by the currency they are issued in
EURList of invoices
List of invoices
Generate an invoice for a booking. You can create an amount, percentage or remainder ID. You can also assign invoices to guests or payments, depending on your settings.
Guest to assign to invoice. Required if other invoices for the booking are per-guest.
Amount to invoice. Required when percentage or remainder are not specified.
Percentage of the booking final amount to invoice. Required if amount or remainder are not specified.
If enabled the whole un-invoiced amount will be invoiced. Required if amount or percentage are not specified.
List of ID's to generate an invoice for. Generates an invoice for the sum of all paid amounts or for the sum of the whole booking, depending on which is larger. Required if amount, percentage or remainder are not specified.
Invoice has successfully been created.
Invoice creation is not possible at the present time.
The sent request is invalid.
ID of the booking
ID of the invoice
Invoice number.
The date and time the invoice was closed.
The prefix placed before the invoice number within the invoice reference.
The suffix placed after the invoice number within the invoice reference.
Invoice successfully updated
Invoice cannot be updated with the provided data at the present time.
The sent request is invalid.
No content
Delete an invoice. Both draft and closed invoices can be deleted, however invoices that have previously been credited cannot be deleted as long as their credit note(s) exists.
ID of the booking
ID of the invoice
Invoice was successfully deleted.
Invoice cannot be deleted at the present time, most likely a credit note for the invoice exists.
No content
Download an invoice with all of its items in PDF format.
ID of the booking
ID of the invoice
File download containing the invoice in PDF format.
No content
File download containing the invoice in PDF format.
No content
Last updated