List recurring vendor bills
Returns a page of the schedules that raise vendor bills automatically — what each one bills, for which property, how often, and when it starts and ends.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. The first page is 1.
pageSizeintegerHow many schedules to return per page. Between 1 and 100.
propertyIdsstring[]Return only schedules for these properties. Repeat the parameter for each id.
unitIdsstring[]Return only schedules for these units. Repeat the parameter for each id.
leaseIdsstring[]Return only schedules for these leases. Repeat the parameter for each id.
vendorIdsstring[]Return only schedules billing these vendors. Repeat the parameter for each id.
chargeFrequenciesenum<string>[]Return only schedules on these frequencies. Repeat the parameter for each value.
companyChargebooleantrue returns only schedules charged to the management company's own books; false only property expenses.
nextChargeDate.startstring · date-timeReturn only schedules whose next bill falls at or after this moment, read in the company's timezone. Give at least one of nextChargeDate.start and nextChargeDate.end.
nextChargeDate.endstring · date-timeReturn only schedules whose next bill falls at or before this moment, read in the company's timezone.
endsAfterstring · dateReturn only schedules that are still running after this day.
Response
200 · A page of recurring bill schedules.
itemsRecurringVendorBill[]The schedules on this page.
currentPageintegerThe page this response is.
totalPagesintegerHow many pages the filter produces.
pageSizeintegerHow many schedules a page holds.
totalCountintegerHow many schedules match the filter across all pages.