List owner statements

get

https://open-api.guesty.com/v1/owner-statement-api/owner-statements

Returns owner statement metadata and presigned PDF download URLs (valid for 1 hour) for generated statements.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

skip

integer

≥ 0

Defaults to 0

Offset: number of matching statements to skip before returning results. Echoed in the response skip field. Defaults to 0.

limit

integer

1 to 100

Defaults to 25

Requested page size (1–100). Values above the max are clamped. Echoed as the effective page size in the response limit field. Defaults to 25.

ownerId

string

Filter results to a specific owner by their ID

periodMode

string

enum

How to interpret period filter fields.

When omitted and no period fields are sent: no period filter is applied; statements are returned across all periods (subject to other filters and pagination).
When omitted but any period field is sent (e.g. year=2025 without periodMode): the request is rejected with 400 Bad Request (periodMode is required when period fields are provided). There is no implicit mode and period fields are not ignored in that case.
When set: only the fields required by that mode are used; other period fields are ignored.
Modes:
month — requires year + month (e.g. January 2025)
year — requires year (full calendar year)
monthRange — requires fromYear, fromMonth, toYear, toMonth (start ≤ end)
yearRange — requires fromYear + toYear (full years inclusive, fromYear ≤ toYear)
fiscalYear — requires fiscalYear (uses account fiscal start month)
fiscalYearRange — requires fromFiscalYear + toFiscalYear (fromFiscalYear ≤ toFiscalYear)

Allowed:

year

integer

Calendar year. Required for periodMode=month and periodMode=year.

month

integer

1 to 12

Calendar month 1–12. Required for periodMode=month.

fromYear

integer

Range start year. Required for periodMode=monthRange and periodMode=yearRange.

fromMonth

integer

1 to 12

Range start month 1–12. Required for periodMode=monthRange.

toYear

integer

Range end year. Required for periodMode=monthRange and periodMode=yearRange.

toMonth

integer

1 to 12

Range end month 1–12. Required for periodMode=monthRange.

fiscalYear

integer

Fiscal year. Required for periodMode=fiscalYear.

fromFiscalYear

integer

Fiscal range start. Required for periodMode=fiscalYearRange.

toFiscalYear

integer

Fiscal range end. Required for periodMode=fiscalYearRange.

updatedSince

date-time

Return statements created or updated after this ISO-8601 timestamp. Highly recommended for incremental sync.

statementType

string

enum

Filter by statement type

Allowed:

Responses

200Owner statements list

400Invalid query parameter. Common causes: period fields sent without periodMode, incomplete/invalid periodMode fields, invalid statementType, or invalid skip (e.g. negative).

401Missing or invalid Bearer access token

403Authenticated account is not permitted to access this resource (e.g. Accounting feature flow disabled)

500Unhandled exception. Something went wrong on server