GetAgencyProperties
lua
The list is sorted by property name.
Parameters
- society:
stringThe job name of the society
Return Value
An array of tables, or an empty table:
- id:
numberThe property ID - title:
stringThe property name - address:
string - type:
'shell' | 'ipl' | 'mlo' - price:
number - rentPrice:
number - forSale:
boolean - forRent:
boolean - listed:
booleanListed for sale or for rent - description:
string - images:
string[] - garage:
boolean - hasYard:
boolean - listingAgentIdentifier / listingAgentName:
string | nilThe agent who listed it - assignedAgentIdentifier / assignedAgentName:
string | nilThe agent it is assigned to - assignmentDue:
string | nilWhen the assignment is due - contactPhone:
string | nil - rented:
booleanWhether someone rents it right now - renterName:
string | nil - renterType:
'user' | 'society' | nil - rentedTo:
string | nilWhen the rental ends - rentedPrice:
number | nil
Example
lua