Damage waivers

Get a lease's damage waiver settings

Returns what the damage waiver means for one lease: the fee it is actually charged, whether it has been opted out, where it stands in the notice and grace period flow, and when the next charge falls due.

GET
https://services.magicdoor.com/tenantinsurance/company-portal/insurance/damage-waivers/leases/{leaseId}/settings

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 read the damage waiver settings for.

example: 1842910736482304512

Response

200 · The lease's damage waiver settings. A lease with no settings of its own gets the company defaults back rather than an error.

leaseIdstring

The lease these settings are for.

isOptedOutboolean

True when this lease has been opted out of the damage waiver program.

statusenum<string>

Where the lease sits in the damage waiver flow. none is the resting state, including after the tenant produced their own insurance. inGracePeriod means a notice went out and the tenant still has time to upload proof of insurance. enrolled means the waiver is in force and being charged. cancelled means the waiver was called off, usually because other coverage took over.

noneinGracePeriodenrolledoptedOutcancelled
effectiveMonthlyFeenumber

The monthly fee this lease is actually charged, in dollars: the lease's own fee when it has one, otherwise the company's.

customMonthlyFeenumber

A fee set for this lease alone, in dollars. Absent when the lease uses the company fee.

companyMonthlyFeenumber

The company-wide damage waiver fee, in dollars.

recurringLeaseChargeChartOfAccountobject

The company's revenue account the monthly damage waiver charge is posted to.

gracePeriodEndsAtstring · date-time

When the tenant's window to upload their own insurance closes, after which the lease is enrolled in the waiver automatically. Absent when no grace period is running.

latestNoticeSentAtstring · date-time

When the most recent damage waiver notice went out. Absent when none has been sent.

noticeTypestring

Why the most recent notice was sent: Initial for a lease with no insurance, Expired when previous insurance ran out, Rejected when uploaded proof was turned down. Absent when no notice has been sent. Sent capitalised, unlike the enum values elsewhere in this API.

InitialExpiredRejected
nextChargeDatestring · date-time

When the next monthly damage waiver charge is due. Absent when no waiver is currently in force.

policyStartDatestring · date-time

When the current waiver started. Absent when none is in force.

policyEndDatestring · date-time

When the current waiver ends. Absent when none is in force or it has no end date.

401 · The access token is missing, expired, or not a company portal token.

404 · No such lease, the lease belongs to another company, or the company's configured damage waiver charge account no longer exists.