Retrieves a financial overview for one or more reservations from the guest folio.
Field selection
You must specify at least one field to return via the fields query parameter.
reservationId is always included in every result, even if not listed in fields.
Use the exact enum values listed — any unrecognized field name results in a 400 error.
Partial success
If some reservation IDs are not found, the response still returns HTTP 200.
Found records appear in results; missing IDs are listed in notFound.
Bulk limit
A maximum of 200 reservation IDs can be submitted per request.
For larger datasets, paginate by calling this endpoint in batches of up to 200.
Parallel requests are supported and recommended when retrieving many reservations.
Currency
Unless the field name explicitly indicates another currency (e.g. hostPayoutUsd), monetary values are expressed in the reservation's native currency.
Use the currency field to determine which currency applies.
Example usage
Fetch the host payout and total taxes for two reservations:
GET /v1/guest-folio/overview?reservationIds=64a1f2c3e4b0a1b2c3d4e5f6,64a1f2c3e4b0a1b2c3d4e5f7&fields=hostPayout,totalTaxes,currency| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The request is invalid. Common causes: missing or empty reservationIds, more than 200 reservation IDs submitted, missing or empty fields, or an unrecognized field name in fields.