Get a rent payments report
Lists the tenant payment transactions in a date range, one row each, with the property, unit, lease and payer resolved. Requires the reports:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
dateRange.startstring · daterequiredFirst transaction date to include, read in the company's timezone.
dateRange.endstring · daterequiredLast transaction date to include, read in the company's timezone. It may be at most 92 days after dateRange.start.
dateRange.startInclusivebooleanWhether dateRange.start itself is included.
dateRange.endInclusivebooleanWhether dateRange.end itself is included.
portfolioIdsstring[]Only these portfolios.
propertyIdsstring[]Only these properties.
externalTransactionTypesenum<string>[]Only payments taken through these channels. offline is the offline-recorded ones; the rest are online.
paymentMethodsenum<string>[]Only payments made this way.
statusesenum<string>[]Only payments in these states.
identitiesenum<string>[]Which kinds of lease payment to include. Omit for all lease-related kinds.
Response
200 · The matching payments and their totals.
entriesEntry[]One row per transaction.
totalAmountnumberThe sum of the entries' amounts, as a decimal.
totalCountintegerHow many entries there are.
400 · `dateRange` is missing, spans more than 92 days, or an id is not a Snowflake.
401 · The access token is missing, expired, or not for this company.
403 · The caller does not hold the `reports:read` permission.
A dateRange spanning more than 92 days is rejected with a 400. Ask for a longer history in several calls.
The report is not paginated — every matching transaction comes back in one response.