View the tax, fee, commission, and currency conversion settings that were used to calculate each reservation's financials for every stay. These settings reflect what was applied at the time of calculation, which may differ from your current account or listing setup.

Field selection

Choose at least one field to return using the fields query parameter. reservationId and stayIndex are always included; you do not need to request them. For nested fields like taxes, additionalFees, or additionalFees.upsell, specify the leaf path you want, such as taxes.name, additionalFees.value, or additionalFees.upsell.description. Only channelCommission, cleaningFeeConfig, markup, and currencyConversion can be requested by name. If you enter an unrecognized field, you'll receive a 400 error.

Multi-stay

If a reservation includes multiple stays, you'll see a separate snapshot for each one, each having its own stayIndex. For single-stay reservations, the stayIndex is 0.

Response structure

All snapshots for a reservation are grouped under settingsSnapshots and sorted by stayIndex in ascending order (from lowest to highest).

Partial success

If a reservation ID is malformed or doesn't exist, it will appear in the notFound list. The response always returns HTTP 200.

Currency

All amounts are shown in the reservation's currency. The currencyConversion field shows the exchange rate used at the time of calculation.

Presence

If a field has no stored value, it will be omitted from the response. For older OTA reservations, like Airbnb or Vrbo bookings made before channel commission breakdowns were tracked, channelCommission will not appear. Manual-platform reservations are not affected.

Batching

For large datasets, you can submit up to 200 reservation IDs per request.

Example request

curl --request GET \
  --url 'https://open-api.guesty.com/v1/guest-folio/settings-snapshot?reservationIds=64a1f2c3e4b0a1b2c3d4e5f6&fields=taxes.name%2Ctaxes.amount%2CcurrencyConversion' \
  --header 'Authorization: Bearer <access_token>'

{
  "results": [
    {
      "reservationId": "64a1f2c3e4b0a1b2c3d4e5f6",
      "settingsSnapshots": [
        {
          "stayIndex": 0,
          "extraPersonFee": 15
        }
      ]
    }
  ],
  "notFound": [
    "64a1f2c3e4b0a1b2c3d4e5f9"
  ]
}