New Features 🆕

Account Brands

• New endpoint to retrieve brand information per property (listing).
  • Get brand by property_id.

Calendar

• Added a blockReason field to the Update the calendar for a single listing endpoint. You can select from: Owner block, Offboarded, Migrated unit block, Maintenance, Onboarding, Emergency out of order, Do not sell, Deactivated, or Other.

Patched 🔧

Calendar

• The description of the Update the calendar for a single listing endpoint suggested that it is possible to set availability for multiple dates or date ranges, but that was inaccurate. The request only permits a single date or date range. The document description was amended to, "Set the nightly rate, minimum stay and availability of any calendar date per listing."
• The Update calendar for multiple listings endpoint suggested that cta/ctd values could be updated, but this isn't the case. These body parameters were removed from the document.

New Features 🆕

Accounting

• The new GuestyPay rolling reserve (RR) charge code was added to the Get journal entriesaccounting endpoint. This will allow you to maintain an accurate picture of the amount withheld by GuestyPay and sync it with their financial reporting solutions.

Calendar

• New endpoint for retrieving calendar block logs. You can select logs based on listing ID, username, date range, block type, and event type.
  • Get calendar block logs

Financials: Additional Fees

• Added the option to override fee type, amount and quantifier in channel per channel, including the ability to specify whether the fee should be bundled as a part of the accommodation fare and whether it should be deducted from it when a reservation is created.
  • Create additional fee on account level
  • Create additional fee on listing level
  • Update existing additional fee
  • Calculate additional fee amount for quote [Beta]
  • Add upsell fee to inquiry rate plans quotes [Beta]

Improvements 📈

• We have added price adjustment support for the Expedia AFE (Expedia bundles and sends reservation additional fees as a single invoice item).

Patched 🔧

Guests and Reservations

• Defined the individual address fields for the guest object on the guests and reservations APIs, delivering clarity for those working with guest data. These fields already existed but needed to be documented.
  • Create guest
  • Update guest
  • Create a reservation from quote
  • Create a Reservation Without a Quote

Financials: Additional Fees

• Added missing (existent) API fields for bundling as a part of accommodation fare and deducted from accommodation fare (generally for all channels).
  • Create additional fee on account level
  • Create additional fee on listing level
  • Update existing additional fee

Available Endpoints

Guesty has replaced the property identifiers unitType and unitTypeId with the more familiar listing and listingId. The changes ensure consistency in naming conventions and improve code readability and maintainability. For example:

Before

curl 'https://open-api.guesty.com/v1/rm-los-calendar-service/unitType/{unitTypeId}/calendar?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&limit=100&skip=0' \
--header 'Accept: application/json'

After

curl --globoff 'https://open-api.guesty.com/v1/rm-los-calendar-service/listing/{listingId}/calendar?startDate=YYYY-MM-DD&endDate=YYYY-MM-DD&limit=100&skip=0' \
--header 'accept: application/json'

In addition, parameter and endpoint descriptions were updated to remove any ambiguity and increase understanding.

Resources

Reservation guest invoice items now have their own API and currently only support one action: adding an invoice item to an existing reservation. The table below highlights the changes between the versions.

Examples

Old Request

curl --request POST \
     --url https://open-api.guesty.com/v1/reservations/{reservationId}/invoiceItems \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "title": "Management Fee",
  "amount": 100,
  "normalType": "AFE",
  "description": "Management fee description",
  "secondIdentifier": "MANAGEMENT"
}
'

New Request

Please note that realizationDates is a new optional body parameter for accounting customers only.

curl --request POST \
     --url https://open-api.guesty.com/v1/invoice-items/reservation/{reservationId} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "normalType": "AFE",
  "title": "Management Fee",
  "amount": 100,
  "description": "Management fee description",
  "secondIdentifier": "MANAGEMENT",
  "realizationDates": [
    {
      "date": "2024-03-02"
    }
  ]
}
'

Working Capital is moving from the owners domain to accounting.

What's New?

Working Capital now has its own API. This will allow you to update Owner Working Capital via the API and permit accounting role permission changes to be applied to Working Capital. Additionally, it opens the possibility of adding historical snapshots of its value.

The default behavior remains the same. When a new owner is added, their working capital remains at zero until it is updated.

Links

• Retrieve owner working capital
• Update owner working capital

Deprecation Schedule

We plan to deprecate Working Capital from the Owners API between February 26 and March 4, 2024 (UTC+2). Please ensure you update your flows beforehand.

We have published a new API for viewing guest codes, guest backup codes, and lock info per reservation for Partners who integrate with Guesty Locks Manager.

We have corrected some issues on the Create a reservation documentation.

• The money object now shows as optional. It was previously described as required, but that is no longer the case, as the system applies the property's rate strategy by default.
• Replaced the type parameter of the money.invoiceItems object with all the required fields.

We're happy to announce that we've published all the property amenities currently supported by Guesty. You can view them here.

The following guides have been published to help you navigate guest payments on a reservation via the OpenAPI.

• Posting a Guest Payment
• Canceling or Editing a Scheduled Payment
• Refunding a Guest Payment
• Recording an External Guest Payment/Refund

Guesty has just released a Postman collection for our OpenAPI. You can access it and learn more through this guide.