Skip to main content

Agency Object

FieldTypeDescription
idIntegerUnique ID of user's agency.
nameStringName of user's agency.
addressStringAddress, line 1, of user's agency.
address2StringAddress, line 2, of user's agency.
suburbStringSuburb of user's agency.
stateStringState of user's agency.
postcodeStringPostcode of user's agency.
phoneStringPhone number of user's agency.
faxStringFax number of user's agency.
emailStringEmail number of user's agency.
creditsIntegerNumber credits user's agency has.
activeBooleanReturns true if the user's agency is active.
approvedBooleanReturns true if the user's agency is approved.
member_numberStringUnique ID of the user's agency.
licencee_nameStringLicencee Name of user's Agency.
licencee_numberStringLicencee Number of user's Agency.
gstBooleanReturns true if user's Agency uses GST.
abnStringAustralian Business Number of user's Agency.
createdTimestampReturns Unix timestamp of when user's agency was created.
updatedTimestampReturns true if user's Agency has an active subscription.
active_subscriptionBooleanUnique ID of the user's agency.
subscription_expiryTimestampReturns Unix timestamp of when user's agency's subscription will expire. Returns null if no active subscription exists.
subscription_typeStringSubscription type of user's agency ALL=All Forms FM=Property Management Forms SA=Sales Forms
adminBooleanReturns true if user is admin of the agency.
forms_createdIntegerNumber of forms created by user's agency.