Core resources
Administration
Booking flow
Booking payments. Both planned, partially paid and paid.
iduuid Unique identifier
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 {"id": "00000000-0000-0000-0000-000000000000","booking_id": "00000000-0000-0000-0000-000000000000","invoice_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-05-11T08:57:37.765Z","updated_at": "2024-05-11T08:57:37.765Z","amount": 0,"currency": "","due_at": "2024-05-11T08:57:37.765Z","offline": false,"paid": 0,"reference": ""}
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>200A list of payments with the selected columns
206Partial Content
GET/paymentscurl -X GET "https://api.bookingmood.com/v1/payments?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
Partial<Payment>
| Array<Partial<Payment>>201The newly created payments with the selected columns
POST/paymentscurl -X POST "https://api.bookingmood.com/v1/payments" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '[]'
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>204The deleted payments with the selected columns
DELETE/paymentscurl -X DELETE "https://api.bookingmood.com/v1/payments" \ -H "Authorization: Bearer YOUR_API_KEY"
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>Partial<Payment>204The updated payments with the selected columns
PATCH/paymentscurl -X PATCH "https://api.bookingmood.com/v1/payments" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{}'