New endpoints and fields to support accurate booking dates and reservation comments
Changed
- Expose
bookingDatein reservation creation and retrieval contracts forPOST /reservations-v3/quote,POST /reservations-v3/owner/confirmed,POST /reservations-v3,GET /reservations-v3, andGET /reservations-v3/search
Added
- Add
PUT /reservations-v3/{reservationId}/booking-dateto update a reservation's real-world booking date - Add reservation comment operations:
GET /reservations-v3/{reservationId}/comments,POST /reservations-v3/{reservationId}/comments,PATCH /reservations-v3/{reservationId}/comments/{commentId}, andDELETE /reservations-v3/{reservationId}/comments/{commentId}
Improvements to the guest payment method and vendor documentation
Changed
- Rename
POST /guests/{id}/payment-methodsfrom “Create payment method" to “Create guest payment method” - Label the
POST /guests/{id}/payment-methodsrequest-body variants asStripe Payment MethodandGuesty Pay Payment Methodwhile preserving their required fields - Document
payoutMethodin vendor response bodies forGET /vendorsandGET /vendors/{id}, including bank account, routing, BSB, sort code, account holder, and business address fields
Added
- Document the
201 application/jsonresponse body forPOST /guests/{id}/payment-methodswith a guest payment method schema and example - Document the
200 application/jsonresponse body forGET /guests/{id}/payment-methodswith a list of guest payment methods and example - Add
PaymentMethodandPaymentMethodListschemas for guest payment method response documentation covering/guests/{id}/payment-methods - Add
POST /vendorsfor creating vendors withcompany,firstName,lastName,email, optional contact details, taxcode, notes, andpayoutMethodrequest fields - Add
PATCH /vendors/{id}for updating vendor details and vendorpayoutMethoddata by vendor ID - Add create and update vendor schemas for
POST /vendorsandPATCH /vendors/{id}, includingCreatePayoutMethodDto,UpdatePayoutMethodDto, and vendor response schemas
Reservations V3 Updates - 2026-05-12
Added
- Add reservation search at
GET /reservations-v3/search, with filtering, sorting, and pagination - Add reservation travel information updates at
PUT /reservations-v3/{reservationId}/travel-information - Add reservation activity log retrieval at
GET /reservation-logs/{reservationId}
Changed
- Make
mergeAccommodationFarePriceComponentsoptional and defaulted onGET /reservations-v3,PUT /reservations-v3/{reservationId}/source,PUT /reservations-v3/{reservationId}/dates,PUT /reservations-v3/{reservationId}/guests, andPUT /reservations-v3/{reservationId}/relocate - Make
mergeAccommodationFarePriceComponentsoptional and defaulted onGET /quotes/{quoteId},POST /quotes,POST /quotes/multiple, andPOST /quotes/{quoteId}/coupons - Add
mergeInclusiveTaxessupport toGET /reservations-v3 - Add
ignoreCalendar,ignoreTerms, andignoreBlocksrequest fields toPUT /reservations-v3/{reservationId}/dates,PUT /reservations-v3/{reservationId}/guests, andPUT /reservations-v3/{reservationId}/relocate - Add
reservedUntilrequest and response support toPUT /reservations-v3/{reservationId}/status - Allow
HOSTas a cancellation actor onPUT /reservations-v3/{reservationId}/status - Make
reasonandmessageToGuestoptional onPOST /reservations-v3/{reservationId}/decline - Expose additional reservation metadata in reservation and quote responses, including
isUsingVCCand channelcancellationFee
Deprecation tags added to legacy listings and reservations resources to indicate Guesty's intention to sunset them in the near future
Added
- Add the
isTestflag toGET /listings,POST /listings,GET /listings/{id},PUT /listings/{id},PUT /listings/{id}/availability-settings,GET /owners-reservations,GET /owners-reservations/{id}, andPUT /owners-reservations/{id}responses to identify test properties - Add
secondarySourcetoGET /reservations,POST /reservations,GET /reservations/{id},PUT /reservations/{id}, andPOST /reservations/{id}/invoiceItemsresponses to expose the reservation website name when available - Added
feeGroupNametoGET /payment-transactions/reports/payouts-reconciliationresponses to expose the fee group name for payout reconciliation entries
Changed
- Deprecate
GET /listings/{id}/custom-fields,PUT /listings/{id}/custom-fields,GET /listings/{id}/custom-fields/{field_id}, andDELETE /listings/{listing_id}/custom-fields/{field_id} - Deprecate
POST /reservations.csvandPOST /reservations.email
Financials - 2026-04-27
No breaking changes have been introduced to taxes; rather, the documentation now aligns with the actual product behavior.
Added
- Add pre-deduct commission support so you can configure automatic deduction behavior in commission settings (
PUT /channel-commissions-v2/account,PUT /channel-commissions-v2/listings,PUT /channel-commission/listings, andPUT /channel-commission/account) - Add optional
isUpsellFeeto requests forPOST /invoice-items/reservation/:reservationId - Add optional
realizationDates.items.fromandrealizationDates.items.toto requests forPOST /invoice-items/reservation/:reservationId - Add optional
stayIndexto requests forPOST /invoice-items/reservation/:reservationId - Add
DIRECT_SERVICE,GUESTY_BASIC_TRAVEL_COVERAGE,GUESTY_EXTENDED_TRAVEL_COVERAGE,GUESTY_SHIELD,PROPERTY_INSURANCE, andTOTAL_PAYOUT_BASEDenum values tosecondIdentifierin requests forPOST /invoice-items/reservation/:reservationId - Support
parentInvoiceItemId,realizationDates[].from, realizationDates[].to, andstayIndexin requests toPOST /price-adjustments/manual-total-amountto allow richer mapping of manual total amount adjustments - Support additional secondIdentifier values
DIRECT_SERVICE,GUESTY_BASIC_TRAVEL_COVERAGE,GUESTY_EXTENDED_TRAVEL_COVERAGE,GUESTY_SHIELD,PROPERTY_INSURANCE, andTOTAL_PAYOUT_BASEDin requests toPOST /price-adjustments/manual-total-amount - Support additional
normalTypevaluesMARandMARFin requests toPOST /price-adjustments/manual-total-amount - Return optional
parentInvoiceItemId,realizationDatesRange, andstayIndexfields in200responses fromGET /price-adjustments/total-amount/:idfor better visibility into item-level adjustment context - Add optional request property
channelOverridestoPOST /taxesandPATCH /taxes/:id - Add optional request property i
sInclusivetoPOST /taxesandPATCH /taxes/:id - Add optional query parameter
applyRequiredChangesToTaxesWithSameTypetoPATCH /taxes/:id - Add optional response property
channelOverridestoPOST /taxes,PATCH /taxes/:id,GET /taxes/account,GET /taxes/unit-type/:id, andGET /taxes/unit-type/:id/actual - Add optional response property
isInclusivetoPOST /taxes,PATCH /taxes/:id,GET /taxes/account,GET /taxes/unit-type/:id, andGET /taxes/unit-type/:id/actual - Expand supported request enum values for
appliedOnFees/itemsinPOST /taxesandPATCH /taxes/:idto include many additional fee types (for example:ACTIVITIES,ADDITIONAL_BED,BOOKING_FEE, CLEANING,PARKING, POOL_HEATING,RESORT,WIFI,WOOD, and others)
Changed
- Restrict
appliedOnFees/itemsto enum values inPOST /taxes and PATCH /taxes/:id - Restrict
conditionalOverrides.rules[].dateRange.fromandconditionalOverrides.rules[].dateRange.totoMMDD_DATE_FORMAT_REGEXinPOST /taxesandPATCH /taxes/:id - Add
vrboLiteas a possible response enum value forappliedByDefaultOnChannels/itemsinPOST /taxes,PATCH /taxes/:id,GET /taxes/account,GET /taxes/unit-type/:id, andGET /taxes/unit-type/:id/actual - Expand the supported
commission.ofvalues by addingDIRECT_SERVICE,GUESTY_BASIC_TRAVEL_COVERAGE,GUESTY_EXTENDED_TRAVEL_COVERAGE,GUESTY_SHIELD,PROPERTY_INSURANCE, andTOTAL_PAYOUT_BASEDin update payloads forPUT /channel-commission/account,PUT /channel-commission/listings,PUT /channel-commissions-v2/account, andPUT /channel-commissions-v2/listings - Relax validation by making tax optional for payloads used by
PUT /channel-commissions-v2/accountandPUT /channel-commissions-v2/listings - Allow commission tax to be omitted when it is not relevant in channel commission updates (
PUT /channel-commissions-v2/account,PUT /channel-commissions-v2/listings) - Improve consistency of channel commission update inputs to make account and listing updates more predictable (
PUT /channel-commissions-v2/account,PUT /channel-commissions-v2/listings). - Make
realizationDates.items.dateoptional in requests forPOST /invoice-items/reservation/:reservationId - Allow
priceAdjustments[].realizationDates[].dateto be omitted in requests toPOST /price-adjustments/manual-total-amountwhen using range-based realization dates (from/to)
Removed
- Remove channel enum values
agoda,airbnb,bookingCom,bookingPal,expedia,homeAway,homeaway2,rentalsUnited,siteMinder, andtripAdvisorfrom request propertyappliedByDefaultOnChannels/itemsinPOST /taxesandPATCH /taxes/:id
Owner Payout Methods 2026-04-23
New Payouts API for managing owner payout details
Added
- Add
GET /payouts/owners/{ownerId}to retrieve owner payout details - Add
POST /payouts/owners/{ownerId}for creating a payout method for a given owner - Add
PUT /payouts/owners/{ownerId}for updating an existing payout method for a given owner - Add
POST /payouts/owners/bulkfor adding payout methods for multiple owners in a single request
Roles are deprecated from the /users API and separated into their own /roles and /user-scope API resources to align Guesty's Open API with the latest roles and permissions version supported by the platform.
Added
- Add
GET /rolesto retrieve a list of supported user roles and permissions - Add
GET /roles/:idto retrieve the roles and permissions assigned to a user - Add
POST /roles/assignto assign roles and permissions to a user - Add
POST /user-scope/assignto assign the scope of listing permissions to a user - Add
GET /user-scope/:idto retrieve the scope of listing permissions assigned to a user
Changed
- Add optional
countryrequest property toPOST /users - Add optional
registrationOriginrequest property toPOST /users
Removed
- Breaking: deprecated the
rolesproperty from the/userendpoints. Update your integrations to utilise the/rolesand/user-scopeAPIs to manage user roles and permissions instead
New feature for adding and managing external links in your property's "Channels" section, and a new owner-guest creation endpoint to support owner-guest reservations
Added
- Add
POST /properties-api/listing-settings/external-links/{propertyId}for adding an external link to the property's page - Add
PUT /properties-api/listing-settings/external-links/{propertyId}/{linkId}for updating the URL and name of an existing external link - Add
PUT /properties-api/listing-settings/external-links/{propertyId}/orderfor reordering the list of external links - Add
GET /properties-api/listing-settings/external-links/{propertyId}for retrieving the property's list of external links - Add
DEL properties-api/listing-settings/external-links/{propertyId}/{linkId}for deleting an external link - Add
POST /owners/:ownerId/guestendpoint to support owner reservations. You need to generate this ID only for a first-time owner reservation.
Changed
- Add
EXPENSES_CSV_IMPORTas a filterabletriggertoGET /accounting-api/journal-entriesandGET /accounting-api/journal-entries/all - Document
GET /expenses-api/expensespagination limit as “up to 100 items per page” in the endpoint description. - Document
POST /expenses-api/expensesvalidation/usage details in the endpoint description (including lock period behavior and clarifications around required inputs and mutual exclusivity ofownersvslistingIds). - Document
GET /expenses-api/expenses/:id}returned details to explicitly mention attachments in the endpoint description. - Document
POST /expenses-api/expenses/:id/attachmentsconstraints and required fields in the endpoint description (including “up to 10 attachments per request” andurlThumbnail). - Document
DELETE /expenses-api/expenses/:id/attachments/:attachmentIdbehavior in the endpoint description to emphasize it returns the updated expense after removal. - Document updated cancellation rules for
POST /expenses-api/expenses/:id/cancelin the endpoint description (expanded eligible statuses and clarified rejection conditions). - Simplify/standardize multiple
404response descriptions (e.g., “Expense not found”, “Expense or attachment not found”). - Add
businessInformation.businessNameto Owner create/update payloads and expose it in Owner responses (POST /owners,PUT /owners/:ownerId,GET /owners/:ownerId). - Add
ownersPortalSettings.rentalIncometo Owner create/update payloads and expose it in Owner responses (POST /owners,PUT /owners/:ownerId,GET /owners/:ownerId). - Add bulk support for
businessInformation.businessNameandownersPortalSettings.rentalIncomein request/response items (POST /owners/bulk).
Resources
- External links:
- Expenses:
- Journal entries
- Owners API
Added
- Add
RECORDED_CASHas the supported method for recording cash reservation payments to the recorded payment method enums list.
Removed
- Remove
CASHfrom the supported recorded payment enums list, as it is part of the payment automations workflow and can lead to an unintended credit card charge, once a valid credit card is added to the reservation. UseRECORDED_CASHinstead.
