This resource represents the Booking’s Fees, which contribute to Booking’s final price.
Bookings Fees are usually related to RentalsFees, but they might be also not related at all to any Fee. These fees are called “standalone fees”. Bookings originating from external Channels are likely to have standalone Bookings Fees.
| Name | Type | Read/Write | Description |
|---|---|---|---|
| rentals_fee | Integer | Read | RentalsFee’s ID related to the Bookings Fee |
| booking | Integer | Read | Booking’s ID related to the Bookings Fee |
| fee | Integer | Read | Fee’s ID related to the Bookings Fee |
| account | Integer | Read | Account’s ID related to the Bookings Fee |
| bookings_taxes | Array | Read | Array of Bookings Taxes IDs where the given Bookings Fee is a taxable item |
| id | Integer | Read | Bookings Fee’s id. |
| included_in_price | Boolean | Read | Whether Bookings Fee contributes to the final price or not. |
| name | Object | Read | Bookings Fee’s name, list of locales described in enums section. |
| price | Decimal | Read | Bookings Fee’s price. |
| required | Boolean | Read | Always included for new bookings if set to true. |
| times_booked | Integer | Read | Bookings Fee’s times booked count. |
| created_at | Time | Read | Bookings Fee’s create time. |
| updated_at | Time | Read | Bookings Fee’s update time. |
Based on the OAuth token scopes bookings_fees will be limited to a certain range.
| Scope | Read Permissions |
|---|---|
:bookings_write_owned |
Display fees only for bookings created by app that is making the request |
:bookings_read |
Display fees for all bookings |
:bookings_write |
Display fees for all bookings |
Other scopes will return no results.
List all bookings fees for a given account(s).
GET /bookings_fees
{
"links": {
"bookings_fees.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_fees.account}",
"bookings_fees.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_fees.booking}",
"bookings_fees.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings_fees.bookings_taxes}",
"bookings_fees.fee": "https://www.bookingsync.com/api/v3/fees/{bookings_fees.fee}",
"bookings_fees.rentals_fee": "https://www.bookingsync.com/api/v3/rentals_fees/{bookings_fees.rentals_fee}"
},
"bookings_fees": [
{
"id": 13,
"included_in_price": false,
"name": {
"en": "Bookings Fee"
},
"price": "12.0",
"required": false,
"times_booked": 0,
"created_at": "2015-03-20T16:04:05Z",
"updated_at": "2015-03-20T16:04:05Z",
"links": {
"account": 3,
"booking": 1313,
"bookings_taxes": [
],
"fee": 9,
"rentals_fee": 6
}
}
],
"meta": {
}
}Returns a single bookings fee identified by ID.
GET /bookings_fees/:bookings_fee_id
{
"links": {
"bookings_fees.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_fees.account}",
"bookings_fees.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_fees.booking}",
"bookings_fees.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings_fees.bookings_taxes}",
"bookings_fees.fee": "https://www.bookingsync.com/api/v3/fees/{bookings_fees.fee}",
"bookings_fees.rentals_fee": "https://www.bookingsync.com/api/v3/rentals_fees/{bookings_fees.rentals_fee}"
},
"bookings_fees": [
{
"id": 13,
"included_in_price": false,
"name": {
"en": "Bookings Fee"
},
"price": "12.0",
"required": false,
"times_booked": 0,
"created_at": "2015-03-20T16:04:05Z",
"updated_at": "2015-03-20T16:04:05Z",
"links": {
"account": 3,
"booking": 1313,
"bookings_taxes": [
],
"fee": 9,
"rentals_fee": 6
}
}
],
"meta": {
}
}Adds a fee to an existing booking.
PATCH /bookings/:id/add_bookings_fee
{
"id": 1,
"bookings_fees": [
{
"price": 68.89,
"rentals_fee_id": 2488,
"times_booked": 1
}
]
}{
"bookings": [
{
"id": 982468349,
"account_id": 1059638630,
"adults": null,
"booked": true,
"bookings_fees": [
{
"id": 3139,
"booking_id": 982468349,
"rentals_fee_id": 2489,
"times_booked": 7,
"price": "32.56",
"created_at": "2017-09-28T16:22:17Z",
"updated_at": "2017-09-28T16:22:17Z",
"canceled_at": null,
"commission": null,
"payback_to_owner": null,
"locked": null,
"name": "Service 1"
}
],
"children": null,
"client_id": null,
"currency": "EUR",
"damage_deposit": "0.0",
"discount": null,
"downpayment": null,
"final_price": "5227.92",
"initial_price": "5000.0",
"notes": null,
"reference": "G8XPFH",
"rental_id": 675045400,
"source_id": null,
"unavailable": false,
"created_at": "2017-09-28T16:22:17Z",
"updated_at": "2017-09-28T16:22:17Z",
"start_at": "2017-09-28T16:00:00Z",
"end_at": "2017-10-06T10:00:00Z",
"canceled_at": null,
"tentative_expires_at": null
}
]
}{
"bookings": [
{
"id": 982468349,
"account_id": 1059638630,
"adults": null,
"booked": true,
"bookings_fees": [
{
"id": 3139,
"booking_id": 982468349,
"rentals_fee_id": 2489,
"times_booked": 7,
"price": "32.56",
"created_at": "2017-09-28T16:22:17Z",
"updated_at": "2017-09-28T16:22:17Z",
"canceled_at": null,
"commission": null,
"payback_to_owner": null,
"locked": null,
"name": "Service 1"
}
],
"children": null,
"client_id": null,
"currency": "EUR",
"damage_deposit": "0.0",
"discount": null,
"downpayment": null,
"final_price": "5227.92",
"initial_price": "5000.0",
"notes": null,
"reference": "G8XPFH",
"rental_id": 675045400,
"source_id": null,
"unavailable": false,
"created_at": "2017-09-28T16:22:17Z",
"updated_at": "2017-09-28T16:22:17Z",
"start_at": "2017-09-28T16:00:00Z",
"end_at": "2017-10-06T10:00:00Z",
"canceled_at": null,
"tentative_expires_at": null
}
]
}Removes a fee from an existing booking.
PATCH /bookings/:id/remove_bookings_fee/:bookings_fee_id
{
"bookings": [
{
"id": 982468349,
"account_id": 1059638630,
"adults": null,
"booked": true,
"bookings_fees": [
],
"children": null,
"client_id": null,
"currency": "EUR",
"damage_deposit": "0.0",
"discount": null,
"downpayment": null,
"final_price": "5000.0",
"initial_price": "5000.0",
"notes": null,
"reference": "G8XPFH",
"rental_id": 675045400,
"source_id": null,
"unavailable": false,
"created_at": "2017-09-28T16:40:36Z",
"updated_at": "2017-09-28T16:40:36Z",
"start_at": "2017-09-28T16:00:00Z",
"end_at": "2017-09-29T10:00:00Z",
"canceled_at": null,
"tentative_expires_at": null
}
]
}{
"bookings": [
{
"id": 982468349,
"account_id": 1059638630,
"adults": null,
"booked": true,
"bookings_fees": [
],
"children": null,
"client_id": null,
"currency": "EUR",
"damage_deposit": "0.0",
"discount": null,
"downpayment": null,
"final_price": "5000.0",
"initial_price": "5000.0",
"notes": null,
"reference": "G8XPFH",
"rental_id": 675045400,
"source_id": null,
"unavailable": false,
"created_at": "2017-09-28T16:40:36Z",
"updated_at": "2017-09-28T16:40:36Z",
"start_at": "2017-09-28T16:00:00Z",
"end_at": "2017-09-29T10:00:00Z",
"canceled_at": null,
"tentative_expires_at": null
}
]
}