Association violations

Charge the tenant for a violation

Adds a charge to the violation's lease for something beyond the association's own fine, such as a clean-up cost or an administration fee. The violation must be tied to a lease.

POST
https://api.portal.magicdoor.com/company-app/associations/violations/{violationId}/lease-bill

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

violationIdstringrequired

The association violation to act on. A Snowflake id sent as a decimal string.

example: 1830472847398407007

Body

application/json

descriptionstringrequired

What the charge is for. Shown to the tenant.

chartOfAccountIdstringrequired

The chart of account to book the charge against. A Snowflake id sent as a decimal string.

amountnumberrequired

How much to charge, for example 75.00.

companyChargeboolean

Whether the money goes to the management company rather than the property owner.

default: false

Response

200 · The violation with the new charge added to `leaseBills`.

idstring

The violation. A Snowflake id sent as a decimal string.

portfolioIdstring

The portfolio the violation was raised against.

propertyIdstring

The property the violation was raised against.

unitIdstring

The unit the violation was raised against. Absent when the violation is property-wide.

leaseIdstring

The lease the violation was raised against. Absent when no lease is involved.

statusenum<string>

Where the violation sits in its workflow.

receivedinProgressresolved
hoaVendorIdstring

The vendor record for the homeowners association that issued the violation.

referencestring

The association's own reference for the violation. Generated automatically when the caller did not supply one.

violationReceivedDatestring · date

The day the association's notice reached the property manager.

violationDatestring · date

The day the violation itself happened.

fixByDatestring · date

The deadline the association gave for putting it right. Absent when no deadline was given.

associationFinenumber

The fine the association charges, for example 250.00. Absent when no fine was recorded.

titlestring

Short title. Written by an AI summary of the description when the caller did not supply one.

descriptionstring

What the association says is wrong.

notificationSentAtstring · date-time

When a notice was last sent to the lease or the owners, in the company's timezone. Absent while no notice has been sent.

filesobject[]

Files attached to the violation, such as the association's own notice.

propertyFineBillobject

The vendor bill raised against the property for the association's fine. Absent until the fine is charged.

leaseFineBillobject

The lease charge raised when the fine was passed on to the tenant. Absent when the fine was not passed on.

portfolioobject

The portfolio the violation belongs to.

propertyobject

The property the violation was raised against.

unitobject

The unit the violation was raised against. Absent when the violation is property-wide.

leaseobject

The lease the violation was raised against. Absent when no lease is involved.

workOrdersobject[]

Work orders raised from this violation.

leaseBillsobject[]

Extra lease charges added against this violation, beyond the fine itself.

ownersobject[]

Owners of the property, as used when sending an owner notice.

workOrderVendorsobject[]

Vendors assigned to the work orders above.

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

404 · No association violation with that id exists in the caller's company.

The violation must have a lease

A violation raised against a property or a unit with no lease has nobody to bill, and this call fails. Attach the violation to a lease first.

The charge is dated today in the company's timezone, both as its bill date and as its due date.