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.

New guides have been published covering common alterations. Access them from here.

Reservation events don't trigger the calendar webhook. See the updated guide and callout with guidance here.