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.
Authorization
AuthorizationstringrequiredPath parameters
violationIdstringrequiredThe association violation to act on. A Snowflake id sent as a decimal string.
Body
application/json
descriptionstringrequiredWhat the charge is for. Shown to the tenant.
chartOfAccountIdstringrequiredThe chart of account to book the charge against. A Snowflake id sent as a decimal string.
amountnumberrequiredHow much to charge, for example 75.00.
companyChargebooleanWhether the money goes to the management company rather than the property owner.
Response
200 · The violation with the new charge added to `leaseBills`.
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.
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.
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.