List vendor bills
Returns a page of the company's vendor bills, with every filter applied as an AND. Deleted bills are never included. Requires the vendor_bills:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return, starting at 1.
pageSizeintegerHow many bills per page, between 1 and 100.
companyBillbooleantrue returns only bills the management company owes, false only bills an owner owes.
vendorIdsstring[]Only bills from these vendors.
portfolioIdsstring[]Only bills whose line items sit in these portfolios.
propertyIdsstring[]Only bills whose line items sit on these properties.
unitIdsstring[]Only bills whose line items sit on these units.
leaseIdsstring[]Only bills whose line items sit on these leases.
ownerIdsstring[]Only bills on properties these owners own. Resolved to property ids server-side and intersected with propertyIds if you also send that.
statusesenum<string>[]Only bills in these approval states.
assignedToIdsstring[]Only bills currently assigned to these property managers.
assignedByIdsstring[]Only bills assigned by these property managers.
assignedAt.startstring · date-timeEarliest assignment time to include.
assignedAt.endstring · date-timeLatest assignment time to include.
assignedAt.startInclusivebooleanWhether assignedAt.start itself is included.
assignedAt.endInclusivebooleanWhether assignedAt.end itself is included.
billDate.startstring · dateEarliest bill date to include.
billDate.endstring · dateLatest bill date to include.
billDate.startInclusivebooleanWhether billDate.start itself is included.
billDate.endInclusivebooleanWhether billDate.end itself is included.
dueDate.startstring · dateEarliest due date to include.
dueDate.endstring · dateLatest due date to include.
dueDate.startInclusivebooleanWhether dueDate.start itself is included.
dueDate.endInclusivebooleanWhether dueDate.end itself is included.
totalAmount.startnumberSmallest totalAmount to include, as a decimal.
totalAmount.endnumberLargest totalAmount to include, as a decimal.
dueAmount.startnumberSmallest dueAmount to include, as a decimal. Use dueAmount.start=0.01 for bills that still owe something.
dueAmount.endnumberLargest dueAmount to include, as a decimal.
hasInvoicesbooleantrue returns only bills that have at least one attached file, false only bills with none.
magicTagValuesstring[]Only bills on properties carrying these MagicTags. Resolved to property ids server-side and intersected with propertyIds if you also send that.
searchstringFree-text search, 1 to 150 characters. Matches the bill's memo or reference case-insensitively, and also returns bills whose property or vendor name matches.
Response
200 · A page of vendor bills.
itemsVendorBill[]The bills on this page.
currentPageintegerThe page number that was returned.
totalPagesintegerHow many pages the filter produces at this pageSize.
pageSizeintegerHow many bills a full page holds.
totalCountintegerHow many bills match the filter in total.
400 · A query parameter failed validation — `page` below 1, `pageSize` outside 1–100, an id that is not a Snowflake, or a `search` longer than 150 characters.
401 · The access token is missing, expired, or not for this company.
403 · The caller does not hold the `vendor_bills:read` permission.
The envelope here is currentPage, totalPages, pageSize, totalCount, items — note currentPage, not page as on most list endpoints.