Recurring vendor bills

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.

GET
https://api.portal.magicdoor.com/company-app/vendors/recurring-bills

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1
pageSizeinteger

How many schedules to return per page. Between 1 and 100.

default: 50
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.

monthlyweeklydailymonthly2XSplitquarterlyyearly
companyChargeboolean

true returns only schedules charged to the management company's own books; false only property expenses.

nextChargeDate.startstring · date-time

Return 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-time

Return only schedules whose next bill falls at or before this moment, read in the company's timezone.

endsAfterstring · date

Return only schedules that are still running after this day.

Response

200 · A page of recurring bill schedules.

itemsRecurringVendorBill[]

The schedules on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many schedules a page holds.

totalCountinteger

How many schedules match the filter across all pages.

401 · The access token is missing, expired, or does not belong to a property manager.