Lease subsidies

List a lease's subsidies

Returns a page of the subsidies on this lease, with the paying bodies and accounts alongside. Only active subsidies come back unless you ask for the inactive ones too.

GET

https://api.portal.magicdoor.com/company-app/leases/{leaseId}/subsidies

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.

Path parameters

leaseIdstringrequired

The lease whose subsidies you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Query parameters

pageinteger

Which page to return. Starts at 1.

default: 1example: 1

pageSizeinteger

How many rows per page, between 1 and 100.

default: 50example: 50

activeboolean

Whether to return active subsidies or deactivated ones. Defaults to true, so only active subsidies come back unless you send active=false.

default: true

subsidyTypeenum<string>

Only subsidies under this programme.

section8vashehvfupprojectBasedother

subsidizerIdsstring[]

Only subsidies paid by any of these bodies.

unitIdsstring[]

Only subsidies on any of these units.

propertyIdsstring[]

Only subsidies on any of these properties.

portfolioIdsstring[]

Only subsidies in any of these portfolios.

Response

200 · A page of subsidies.

itemsLeaseSubsidy[]

The rows on this page.

currentPageinteger

The page you asked for. Pages start at 1.

totalPagesinteger

How many pages exist at this page size.

pageSizeinteger

How many rows a page holds.

totalCountinteger

How many rows match in total, across all pages.

chartOfAccountsChartOfAccount[]

Chart-of-account records referenced above.

subsidizersSubsidizer[]

The bodies paying the subsidies above.

propertyManagersPropertyManager[]

Property managers referenced as creators.

tenantsTenant[]

Tenants referenced as creators.

vendorsVendor[]

Vendors referenced as creators.

ownersOwner[]

Owners on the subsidies, and any referenced as creators.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

401 · The access token is missing, expired, or not for this company.

404 · No lease matched the id, or it belongs to another company.

What a subsidy is

A lease subsidy is a standing arrangement where a third party — a housing authority, say — pays part of the rent. MagicDoor raises the subsidy's share as a recurring payment on the lease, so the tenant only owes their own portion. Deactivating a subsidy stops future payments without deleting its history.