Create an association violation
Records a violation notice received from a homeowners association. Give it at least one of a lease, a unit or a property; whichever of the three you leave out is worked out from the one you supply.
Authorization
AuthorizationstringrequiredBody
application/json
hoaVendorIdstringrequiredThe vendor record for the association that issued the notice. A Snowflake id sent as a decimal string.
propertyIdstringThe property the violation is against. Supply this, unitId or leaseId.
unitIdstringThe unit the violation is against. Supply this, propertyId or leaseId.
leaseIdstringThe lease the violation is against. Supply this, unitId or propertyId. A lease is what makes it possible to bill the tenant later.
statusenum<string>Where to start the violation.
referencestringThe association's own reference, up to 150 characters. A random reference is generated when this is left out.
violationReceivedDatestring · daterequiredThe day the notice reached you. Read in the company's timezone.
violationDatestring · daterequiredThe day the violation itself happened. Read in the company's timezone.
fixByDatestring · dateThe deadline the association gave.
associationFinenumberThe fine the association charges, for example 250.00. Needed later if you want to charge the fine on.
titlestringShort title, up to 150 characters. When this is left out MagicDoor writes one from the description using AI.
descriptionstringrequiredWhat the association says is wrong.
Response
200 · The violation that was created.
idstringThe violation. A Snowflake id sent as a decimal string.
portfolioIdstringThe portfolio the violation was raised against.
propertyIdstringThe property the violation was raised against.
unitIdstringThe unit the violation was raised against. Absent when the violation is property-wide.
leaseIdstringThe lease the violation was raised against. Absent when no lease is involved.
statusenum<string>Where the violation sits in its workflow.
hoaVendorIdstringThe vendor record for the homeowners association that issued the violation.
referencestringThe association's own reference for the violation. Generated automatically when the caller did not supply one.
violationReceivedDatestring · dateThe day the association's notice reached the property manager.
violationDatestring · dateThe day the violation itself happened.
fixByDatestring · dateThe deadline the association gave for putting it right. Absent when no deadline was given.
associationFinenumberThe fine the association charges, for example 250.00. Absent when no fine was recorded.
titlestringShort title. Written by an AI summary of the description when the caller did not supply one.
descriptionstringWhat the association says is wrong.
notificationSentAtstring · date-timeWhen 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.
propertyFineBillobjectThe vendor bill raised against the property for the association's fine. Absent until the fine is charged.
leaseFineBillobjectThe lease charge raised when the fine was passed on to the tenant. Absent when the fine was not passed on.
portfolioobjectThe portfolio the violation belongs to.
propertyobjectThe property the violation was raised against.
unitobjectThe unit the violation was raised against. Absent when the violation is property-wide.
leaseobjectThe 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.