Перейти до вмісту

Invoices

Invoices for bookings

The invoice object

Attributes

iduuid

Unique identifier

booking_iduuid | null
bookings.id

Identifier of the related booking

organization_iduuid
organizations.id

Identifier of the organization this invoice is defined in

created_atread-onlytimestamp with time zone

Creation timestamp

updated_atread-onlytimestamp with time zone

Last modification timestamp

attachmenttext | null

URL of a custom attachment

ftsread-onlytsvector
referencetext

Reference of the invoice

Related resources

Embed related resources in the response with the select parameter, for example select=*,bookings!booking_id(*). Resources related through more than one column need the column as a hint, like table!column(*).

bookings!booking_id(*)object | null
bookings

The booking referenced by booking_id.

organizations(*)object | null
organizations

The organization referenced by organization_id.

line_items(*)array
line_items

The line items referencing this invoice through line_items.invoice_id.

payments(*)array
payments

The payments referencing this invoice through payments.invoice_id.

refunds(*)array
refunds

The refunds referencing this invoice through refunds.invoice_id.

The invoice object
JSON
{
  "id": "00000000-0000-0000-0000-000000000000",
  "booking_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-10-30T22:27:57.051Z",
  "updated_at": "2026-10-30T22:27:57.051Z",
  "attachment": "",
  "reference": "ABC123"
}
Including related resources
curl -X GET "https://api.bookingmood.com/v1/invoices?limit=10&select=*,bookings!booking_id(*),organizations(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

List invoices

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid | null>
bookings.id

Identifier of the related booking

organization_idFilter<uuid>
organizations.id

Identifier of the organization this invoice is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

attachmentFilter<text | null>

URL of a custom attachment

ftsFilter<tsvector>
referenceFilter<text>

Reference of the invoice

Responses

200

A list of invoices with the selected columns

206

Partial Content

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

Error responses have a JSON body with a code, message, details and hint. See the introduction for more on errors.
GET /invoices
curl -X GET "https://api.bookingmood.com/v1/invoices?select=*&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-10-30T22:27:57.051Z",
    "updated_at": "2026-10-30T22:27:57.051Z",
    "attachment": "",
    "reference": "ABC123"
  }
]

Create invoices

Body

Partial<Invoice> | Array<Partial<Invoice>>

Read-only attributes are set by the database and can't be written.

Responses

201

The newly created invoices with the selected columns

400

The request is malformed, for example an unknown column, an invalid filter or an invalid body.

401

The API key is missing or invalid.

403

The API key has no permission for this change, for example when writing rows of another organization.

409

The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

Error responses have a JSON body with a code, message, details and hint. See the introduction for more on errors.
POST /invoices
curl -X POST "https://api.bookingmood.com/v1/invoices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "reference": "ABC123"
  }'
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-10-30T22:27:57.051Z",
    "updated_at": "2026-10-30T22:27:57.051Z",
    "attachment": "",
    "reference": "ABC123"
  }
]

Delete invoices

Filters

Without filters, this request deletes all invoices you have access to. Always filter on at least one column, e.g. id=eq.{id}.

idFilter<uuid>

Unique identifier

booking_idFilter<uuid | null>
bookings.id

Identifier of the related booking

organization_idFilter<uuid>
organizations.id

Identifier of the organization this invoice is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

attachmentFilter<text | null>

URL of a custom attachment

ftsFilter<tsvector>
referenceFilter<text>

Reference of the invoice

Responses

200

The deleted invoices with the selected columns. Returns 204 without a body when sending the header Prefer: return=minimal.

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

403

The API key has no permission for this change, for example when writing rows of another organization.

Error responses have a JSON body with a code, message, details and hint. See the introduction for more on errors.
DELETE /invoices
curl -X DELETE "https://api.bookingmood.com/v1/invoices?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-10-30T22:27:57.051Z",
    "updated_at": "2026-10-30T22:27:57.051Z",
    "attachment": "",
    "reference": "ABC123"
  }
]

Update invoices

Filters

Without filters, this request updates all invoices you have access to. Always filter on at least one column, e.g. id=eq.{id}.

idFilter<uuid>

Unique identifier

booking_idFilter<uuid | null>
bookings.id

Identifier of the related booking

organization_idFilter<uuid>
organizations.id

Identifier of the organization this invoice is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

attachmentFilter<text | null>

URL of a custom attachment

ftsFilter<tsvector>
referenceFilter<text>

Reference of the invoice

Body

Partial<Invoice>

Read-only attributes are set by the database and can't be written.

Responses

200

The updated invoices with the selected columns. Returns 204 without a body when sending the header Prefer: return=minimal.

400

The request is malformed, for example an unknown column, an invalid filter or an invalid body.

401

The API key is missing or invalid.

403

The API key has no permission for this change, for example when writing rows of another organization.

409

The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

Error responses have a JSON body with a code, message, details and hint. See the introduction for more on errors.
PATCH /invoices
curl -X PATCH "https://api.bookingmood.com/v1/invoices?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "ABC123"
  }'
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-10-30T22:27:57.051Z",
    "updated_at": "2026-10-30T22:27:57.051Z",
    "attachment": "",
    "reference": "ABC123"
  }
]

Візьміть контроль над своїми бронюваннями. Створіть власний бізнес.

Приєднуйтесь до 1200+ незалежних компаній з оренди житла для відпочинку, які використовують Bookingmood для збільшення кількості прямих бронювань та зміцнення відносин із гостями.

Почніть безкоштовну 14-денну пробну версію