Listings

Update a listing's financial settings

Changed on

Only accessible to Admin or User tokens.

put/financials/listing/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/financials/listing/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Listing id

Request body

guestsIncludedInRegularFeenumber

The maximum number of guests accommodated before the extraPersonFee applies

extraPersonFeenumber float

The amount of charged for each extra person, above the accommodation default (guestsIncludedInRegularFee)

basePricenumber float

The default rate per night. This will apply to the weekend if no weekend price is defined.

basePriceUSDnumber float

The default per night in USD

monthlyPriceFactornumber float

The monthly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g.,0.8 grants a 20% discount. Accepted values are float values between 0 and 1.

weeklyPriceFactornumber float

The weekly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g. 0.95 grants a 5% discount. Accepted values are float values between 0 and 1.

weekendBasePricenumber float

The base pricefor weekend stays

securityDepositFeenumber float

The security deposit fee charged for reservations at this listing.

currencystring

The currency to be used for bookings at the property. Choose from this list of ISO 4217 alphabetic codes. E.g., USD.

Example request

{
  "guestsIncludedInRegularFee": 6,
  "extraPersonFee": 55.5,
  "basePrice": 150,
  "basePriceUSD": 100,
  "monthlyPriceFactor": 0.8,
  "weeklyPriceFactor": 0.95,
  "weekendBasePrice": 150,
  "securityDepositFee": 100,
  "currency": "USD",
  "cleaningFee": {
    "value": {
      "formula": 50
    },
    "lastUpdatedAt": "2020-12-01",
    "airbnb": {
      "value": {
        "formula": 50
      }
    },
    "rentalsUnited": {
      "value": {
        "formula": 50
      }
    },
    "homeAway": {
      "value": {
        "formula": 50
      }
    },
    "expedia": {
      "value": {
        "formula": 50
      }
    },
    "despegar": {
      "value": {
        "formula": 50
      }
    },
    "bookingCom": {
      "value": {
        "formula": 50
      }
    }
  }
}

Response

The Updated financials object

guestsIncludedInRegularFeenumber

The maximum number of guests accommodated before the extraPersonFee applies.

extraPersonFeenumber float

The amount of fee which is added for each extra person, above guestsIncludedInRegularFee, in the reservation

basePricenumber float

The cost per night for the listing

basePriceUSDnumber float

The default rate per night. This will apply to the weekend if no weekend price is defined.

monthlyPriceFactornumber float

The monthly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g.,0.8 grants a 20% discount.

weeklyPriceFactornumber float

The weekly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g. 0.95 grants a 5% discount.

weekendBasePricenumber float

The default weekend rate per night.

securityDepositFeenumber float

The security deposit fee charged for reservations at this listing.

currencystring

The currency to be used for bookings at the property. Choose from this list of ISO 4217 alphabetic codes. E.g., USD.

Example response

{
  "basePrice": 100,
  "basePriceUSD": 150,
  "monthlyPriceFactor": 0.8,
  "weeklyPriceFactor": 0.95,
  "weekendBasePrice": 150,
  "securityDepositFee": 100,
  "cleaningFee": {
    "value": {
      "formula": 50
    },
    "lastUpdatedAt": "2020-12-01T12:00:00Z",
    "airbnb": {
      "value": {
        "formula": 50
      }
    },
    "rentalsUnited": {
      "value": {
        "formula": 50
      }
    },
    "homeAway": {
      "value": {
        "formula": 50
      }
    },
    "expedia": {
      "value": {
        "formula": 50
      }
    },
    "despegar": {
      "value": {
        "formula": 50
      }
    },
    "bookingCom": {
      "value": {
        "formula": 50
      }
    }
  }
}

Changes

    • breaking

      the request property format changed from no format to float

    • breaking

      the request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the /// request property format changed from no format to float

    • breaking

      the // request property format changed from no format to float

    • breaking

      the request property format changed from no format to float

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to float

    • breaking

      the request property format changed from no format to float

    • breaking

      the request property format changed from no format to float

    • breaking

      the request property format changed from no format to float

    • breaking

      the / response's property format changed from date to date-time for status

    • info

      api operation id propertiesFinancialsUpdate was added