List checks
Returns a page of the checks the company has written, together with the bank accounts, vendors, owners and tenants those checks refer to so the list can be rendered without extra lookups.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. The first page is 1.
pageSizeintegerHow many checks to return per page. Between 1 and 100.
checkIdentityenum<string>Return only checks written for this kind of payment: a vendor bill, an owner distribution, a payout to the management company, or the release of a lease balance.
vendorIdsstring[]Return only checks made out to these vendors. Repeat the parameter for each vendor id.
ownerIdsstring[]Return only checks made out to these owners. Repeat the parameter for each owner id.
tenantIdsstring[]Return only checks made out to these tenants. Repeat the parameter for each tenant id.
bankAccountIdsstring[]Return only checks drawn on these bank accounts. Repeat the parameter for each bank account id.
dateFromstring · dateReturn only checks dated on or after this day.
dateTostring · dateReturn only checks dated on or before this day.
amount.fromnumberLower bound of the check amount. Give at least one of amount.from and amount.to when filtering by amount, or the request is rejected.
amount.tonumberUpper bound of the check amount.
amount.includeFrombooleanWhether a check whose amount equals amount.from is included.
amount.includeTobooleanWhether a check whose amount equals amount.to is included.
memostringReturn only checks whose memo matches this text.
transactionIdsstring[]Return only the checks tied to these accounting transactions. Repeat the parameter for each transaction id.
voidedbooleantrue returns only voided checks, false only checks that are still good. Omit it to get both.
Response
200 · A page of checks plus the records they point at.
itemsCheck[]The checks on this page.
currentPageintegerThe page this response is.
totalPagesintegerHow many pages the filter produces.
pageSizeintegerHow many checks a page holds.
totalCountintegerHow many checks match the filter across all pages.
bankAccountsBankAccount[]Every bank account referenced by items[].bankAccountId, so the list can show the account a check was drawn on. Account and routing numbers are masked to their last four digits.
vendorsVendor[]Every vendor referenced by items[].vendorId. Each entry is the full vendor record.
ownersOwner[]Every owner referenced by items[].ownerId. Each entry is the full owner record.
tenantsTenant[]Every tenant referenced by items[].tenantId. Each entry is the full tenant record.