Core resources


Administration


Booking flow

Payments

Booking payments. Both planned, partially paid and paid.

The payment object

Attributes

iduuid

Unique identifier

booking_iduuid
bookings.id

Identifier of the related booking

invoice_iduuid
invoices.id

Identifier of the related invoice

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

amountinteger

Total amount of the payment

currencytext

Currency of the payment

due_attimestamp with time zone

Timestamp at which the payment is due

offlineboolean
paidinteger

Amount of the payment that was paid

referencetext
The payment object
{
"id": "00000000-0000-0000-0000-000000000000",
"booking_id": "00000000-0000-0000-0000-000000000000",
"invoice_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-06-21T08:26:49.550Z",
"updated_at": "2024-06-21T08:26:49.550Z",
"amount": 0,
"currency": "",
"due_at": "2024-06-21T08:26:49.550Z",
"offline": false,
"paid": 0,
"reference": ""
}

List payments

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

invoice_idFilter<uuid>

Identifier of the related invoice

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

amountFilter<integer>

Total amount of the payment

currencyFilter<text>

Currency of the payment

due_atFilter<timestamp with time zone>

Timestamp at which the payment is due

offlineFilter<boolean>
paidFilter<integer>

Amount of the payment that was paid

referenceFilter<text>

Responses

200

A list of payments with the selected columns

206

Partial Content

GET/payments
curl -X GET "https://api.bookingmood.com/v1/payments?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create payments

Body

Partial<Payment>
| Array<Partial<Payment>>

Responses

201

The newly created payments with the selected columns

POST/payments
curl -X POST "https://api.bookingmood.com/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete payments

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

invoice_idFilter<uuid>

Identifier of the related invoice

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

amountFilter<integer>

Total amount of the payment

currencyFilter<text>

Currency of the payment

due_atFilter<timestamp with time zone>

Timestamp at which the payment is due

offlineFilter<boolean>
paidFilter<integer>

Amount of the payment that was paid

referenceFilter<text>

Responses

204

The deleted payments with the selected columns

DELETE/payments
curl -X DELETE "https://api.bookingmood.com/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update payments

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

invoice_idFilter<uuid>

Identifier of the related invoice

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

amountFilter<integer>

Total amount of the payment

currencyFilter<text>

Currency of the payment

due_atFilter<timestamp with time zone>

Timestamp at which the payment is due

offlineFilter<boolean>
paidFilter<integer>

Amount of the payment that was paid

referenceFilter<text>

Body

Partial<Payment>

Responses

204

The updated payments with the selected columns

PATCH/payments
curl -X PATCH "https://api.bookingmood.com/v1/payments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'