AgencyRecordDeal

exports.nolag_properties:AgencyRecordDeal(society, propertyId, propertyLabel, dealType, amount, buyerIdentifier, metadata, actingPlayer, contractId)

Use it when your own script sells or rents out an agency property. It does two things:

1. Adds the deal to the agency's transactions in the Agency Portal.
2. Pays the agent a commission from the society account. The rate comes from the employee's override, then their grade, then Config.Agency.CommissionPercent.

The agent is the one assigned to the property, or the one who listed it. If there is neither, it is actingPlayer.

It does nothing if society is not a real estate agency job.

Parameters

• society: string The job name of the selling agency
• propertyId: number The property ID
• propertyLabel: string The property name, for the transaction list
• dealType: 'sale' | 'rent' The kind of deal
• amount: number The deal amount. Commission is a percentage of it.
• buyerIdentifier: string The identifier of the buyer or renter
• metadata?: table The property metadata. Used to find the assigned or listing agent.
• actingPlayer?: table The framework player object of the agent who made the deal
• contractId?: number The contract ID, if the deal used a contract

Return Value

• None

Example

local data = exports.nolag_properties:GetPropertyData(12)

exports.nolag_properties:AgencyRecordDeal(
    data.owner, data.id, data.label, 'sale', 250000, 'ABC12345', data.metadata
)