Core resources
Administration
Booking flow
Booking payments. Both planned, partially paid and paid.
id
uuid
Unique identifier
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
amount
integer
Total amount of the payment
currency
text
Currency of the payment
due_at
timestamp with time zone
Timestamp at which the payment is due
offline
boolean
paid
integer
Amount of the payment that was paid
reference
text
{"id": "00000000-0000-0000-0000-000000000000","booking_id": "00000000-0000-0000-0000-000000000000","invoice_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-09-08T01:30:56.478Z","updated_at": "2024-09-08T01:30:56.478Z","amount": 0,"currency": "","due_at": "2024-09-08T01:30:56.478Z","offline": false,"paid": 0,"reference": ""}
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
invoice_id
Filter<uuid>
Identifier of the related invoice
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
amount
Filter<integer>
Total amount of the payment
currency
Filter<text>
Currency of the payment
due_at
Filter<timestamp with time zone>
Timestamp at which the payment is due
offline
Filter<boolean>
paid
Filter<integer>
Amount of the payment that was paid
reference
Filter<text>
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"
Partial<Payment>
| Array<Partial<Payment>>
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 '[]'
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
invoice_id
Filter<uuid>
Identifier of the related invoice
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
amount
Filter<integer>
Total amount of the payment
currency
Filter<text>
Currency of the payment
due_at
Filter<timestamp with time zone>
Timestamp at which the payment is due
offline
Filter<boolean>
paid
Filter<integer>
Amount of the payment that was paid
reference
Filter<text>
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"
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
invoice_id
Filter<uuid>
Identifier of the related invoice
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
amount
Filter<integer>
Total amount of the payment
currency
Filter<text>
Currency of the payment
due_at
Filter<timestamp with time zone>
Timestamp at which the payment is due
offline
Filter<boolean>
paid
Filter<integer>
Amount of the payment that was paid
reference
Filter<text>
Partial<Payment>
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 '{}'