Rentals Fees

  1. List rentals fees
  2. Get a single rentals fee
  3. Create a new rentals fee
  4. Update a rentals fee
  5. Archive a rentals fee

Parameters

Name Type Read/Write Description
id Integer Read Rentals Fee’s id.
always_applied Boolean Read Available to all seasons and periods if set to true.
maximum_bookable Integer Read Rentals Fee’s maximum booked count.
name Object Read Rentals Fee’s name, list of locales described in enums section.
public Boolean Read Publicly bookable by client if set to true.
rate Decimal Read Rentals Fee’s rate.
rate_kind String Read Rentals Fee’s rate kind, list of fee’s rate kinds described in enums section.
required Boolean Read Always included for new bookings, also public if set to true.
archived_at Time Read Rentals Fee’s archive time.
created_at Time Read Rentals Fee’s create time.
updated_at Time Read Rentals Fee’s update time.
start_date Date Read Rentals Fee’s start date.
end_date Date Read Rentals Fee’s end date.
Name Type Read/Write Description
id Integer Read Rentals Fee’s id.
fee_id Integer Write Fee id related to the Rentals Fee.
season_ids Array Write Season ids related to the Rentals Fee.
always_applied Boolean Read/Write Available to all seasons and periods if set to true.
maximum_bookable Integer Read/Write Rentals Fee’s maximum booked count.
name Object Read Rentals Fee’s name, list of locales described in enums section.
public Boolean Read Publicly bookable by client if set to true.
rate Decimal Read Rentals Fee’s rate.
rate_kind String Read Rentals Fee’s rate kind, list of fee’s rate kinds described in enums section.
required Boolean Read Always included for new bookings, also public if set to true.
status Boolean Write Possible values are public, required or private.
archived_at Time Read Rentals Fee’s archive time.
created_at Time Read Rentals Fee’s create time.
updated_at Time Read Rentals Fee’s update time.
start_date Date Read/Write Rentals Fee’s start date.
end_date Date Read/Write Rentals Fee’s end date.

List rentals fees

List all rentals fees for a given account(s).

GET /rentals_fees

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Get a single rentals fee

Returns a single rentals fee identified by ID.

GET /rentals_fees/:rentals_fee_id

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Create a new rentals fee

Creates a rentals fee for given rental.

POST /rentals/:rental_id/rentals_fees

Example JSON request

{
  "rentals_fees": [
    {
      "always_applied": true,
      "fee_id": 9,
      "maximum_bookable": 12,
      "status": "public"
    }
  ]
}

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Update a rentals fee

Returns an updated rentals fee identified by ID.

PUT /rentals_fees/:rentals_fee_id

Example JSON request

{
  "rentals_fees": [
    {
      "always_applied": "true",
      "maximum_bookable": 12,
      "status": "public"
    }
  ]
}

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Archive a rentals fee

Required OAuth scope: :rentals_write

Returns empty response with ‘204 No Content’ status code on success.

DELETE /rentals_fees/:rentals_fee_id