Lease subsidies

Create a subsidy

Sets up a third party to pay part of this lease's rent on a schedule. Set createPastSubsidies to true to also record the payments that would already have fallen due since effectiveDate.

POST

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 to put the subsidy on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Body

application/json

subsidizerIdstringrequired

The body paying the subsidy. A Snowflake id, sent as a decimal string.

chartOfAccountIdstringrequired

Account to book the subsidy payments to. A Snowflake id, sent as a decimal string.

amountnumberrequired

How much the subsidy pays each period, as a decimal of at least 1.

createPastSubsidiesbooleanrequired

Whether to record the payments that fell due between effectiveDate and today.

subsidyTypeenum<string>

Which programme this is.

section8vashehvfupprojectBasedother

subsidyFrequencyenum<string>

How often the subsidy pays.

monthlyweeklydailymonthly2XSplitquarterlyyearly

effectiveDatestring · date

First date the subsidy pays.

endDatestring · date

Last date it pays. Must be later than effectiveDate.

ownerIdstring

Owner to record the subsidy against. A Snowflake id, sent as a decimal string.

voucherNumberstring

The voucher number the paying body uses. 1 to 100 characters.

descriptionstring

What the subsidy is for. Up to 1000 characters.

Response

200 · The subsidy that was created.

idstring

Id of the subsidy. A Snowflake id, sent as a decimal string.

leaseIdstring

The lease it applies to. A Snowflake id, sent as a decimal string.

ownerIdstring

The owner the subsidy is recorded against, when one is set. A Snowflake id, sent as a decimal string.

unitIdstring

Unit the lease is on. A Snowflake id, sent as a decimal string.

propertyIdstring

Property the lease is on. A Snowflake id, sent as a decimal string.

portfolioIdstring

Portfolio the lease rolls up to. A Snowflake id, sent as a decimal string.

subsidizerIdstring

The body paying the subsidy. A Snowflake id, sent as a decimal string.

chartOfAccountIdstring

Account the subsidy payments are booked to. A Snowflake id, sent as a decimal string.

subsidyTypeenum<string>

Which programme this is: section8 for a Housing Choice Voucher, vash for Veterans Affairs Supportive Housing, ehv for an Emergency Housing Voucher, fup for the Family Unification Program, projectBased for a Project-Based Voucher, or other.

section8vashehvfupprojectBasedother

voucherNumberstring

The voucher number the paying body uses. Up to 100 characters.

descriptionstring

What the subsidy is for. Up to 1000 characters.

amountnumber

How much the subsidy pays each period, as a decimal amount.

subsidyFrequencyenum<string>

How often the subsidy pays.

monthlyweeklydailymonthly2XSplitquarterlyyearly

effectiveDatestring · date

First date the subsidy pays.

endDatestring · date

Last date it pays. Absent when it runs indefinitely.

lastSubsidystring · date-time

When it last paid.

nextSubsidystring · date-time

When it next pays.

activeboolean

Whether the subsidy is switched on. A deactivated subsidy keeps its history but stops paying.

creatorobject

Who created the record.

createdstring · date-time

When the subsidy was created, in the company's timezone.

updatedstring · date-time

When it last changed.

ownerobject

The owner the subsidy is recorded against, when one is set.

subsidizerobject

The body paying the subsidy.

chartOfAccountobject

The account the subsidy payments are booked to.

creatorInfoobject

The full record of whoever created this, under whichever one key matches the creator's type.

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, subsidizer or chart of account 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.