List a tenant's payments
Returns a page of money-in transactions recorded against this tenant — payments, and the returns, refunds and disputes that follow them. Money going out is not included.
Authorization
AuthorizationstringrequiredPath parameters
tenantIdstringrequiredThe tenant. A Snowflake id, sent as a decimal string.
Query parameters
pageintegerWhich page to return. Starts at 1. Note the asymmetry: the parameter is page, but the response reports it back as currentPage.
pageSizeintegerHow many records per page. Between 1 and 100.
Response
200 · A page of transactions, plus the records they refer to.
currentPageintegerThe page returned. Note the name: this envelope calls it currentPage, not page.
totalPagesintegerHow many pages the filter matches.
pageSizeintegerHow many records were asked for per page.
totalCountintegerHow many records the filter matches in total.
itemsTransaction[]The records on this page.
bankAccountsobject[]The bank accounts referenced on this page.
chartOfAccountsobject[]The chart-of-accounts lines referenced on this page.
propertiesobject[]The properties referenced on this page.
unitsobject[]The units referenced on this page.
leasesobject[]The leases referenced on this page.
tenantsobject[]The tenants referenced on this page.
vendorsobject[]The vendors referenced on this page.
subsidizersobject[]The subsidizers referenced on this page.
ownersobject[]The owners referenced on this page.
401 · The access token is missing, expired, or does not belong to a property manager.
This endpoint filters transactions by tenant id rather than looking the tenant up first, so an id that does not exist, or belongs to another company, returns an empty page rather than 404.
The filter is fixed to incoming transactions. Payouts, vendor bills and other outgoing movements never appear here, whichever tenant they mention.