Create a subsidizer
Adds a body that pays part of a tenant's rent — a housing authority, a charity, an employer. The new subsidizer starts active and can be attached to leases straight away.
Authorization
AuthorizationstringrequiredBody
application/json
type and name are required. Everything else is optional.
typeenum<string>requiredWhat kind of body the subsidizer is.
namestringrequiredThe subsidizer's name. 1 to 200 characters.
languagestringISO 639-1 language code for messages to this subsidizer. Stored as en when omitted.
memostringInternal note. Up to 1,000 characters.
websitestringThe subsidizer's website. Up to 500 characters.
contactobjectHow to reach the subsidizer.
addressobjectThe subsidizer's mailing address.
federalTaxInformationobjectTax identification for the subsidizer. Sending it stores a government identifier.
paymentSettingsobjectHow the subsidizer pays.
Response
200 · The new subsidizer.
idstringThe subsidizer.
namestringThe subsidizer's name.
languagestringISO 639-1 language code used for messages to this subsidizer.
memostringInternal note. Absent when none was written.
activebooleanfalse once the subsidizer has been deactivated. Deactivated subsidizers are hidden from the default list but keep every subsidy already recorded against them.
websitestringThe subsidizer's website. Absent when none is on file.
contactobjectHow to reach the subsidizer.
addressobjectThe subsidizer's mailing address.
federalTaxInformationobjectTax identification for the subsidizer. Absent when none is on file.
paymentSettingsobjectHow the subsidizer pays.
typeenum<string>What kind of body the subsidizer is.
creatorobjectWho created the subsidizer record.
createdstring · date-timeWhen the subsidizer was created.
updatedstring · date-timeWhen the subsidizer was last changed.
creatorInfoobjectThe person or company behind creator, filled in so you do not have to fetch them. Only the property that matches creator.type is present.
401 · The access token is missing, expired, or does not belong to a property manager.
A subsidizer is a body that pays part of a tenant's rent — a housing authority, a charity, an employer. It is a payer, not a person with a portal sign-in: there is no password, no invite and no portal status here. Subsidizers are attached to leases as lease subsidies, and the money they send appears on the lease ledger.