Associations

Name Type Description Value Restrictions Access Visible by Default Required
chargePriceTax item

Associated item:

None Read
Filter
 Yes No
partPriceTax item

Associated item:

None Read
Filter
 Yes No
paymentTax item

Associated item:

None Read
Filter
 Yes No
cohort item

Associated item:

None Read
Filter
 Yes No
customRoles collection

Associated item: role

 None Read
 No No
rolePermissions collection

Associated item:

None Read
 No No

Fields

Name Type Description Value Restrictions Access Visible by Default Required
id integer None Read
Write
Sort
Filter
Change
 Yes No
companyName string None Read
Write
Filter
Change
 Yes No
partnerParent integer None Read
Filter
 No No
extraFeatures.clientReminderEmail string None Read
 Yes No
extraFeatures.clientReminderSms string None Read
 Yes No
extraFeatures.enableQuoteTimeAndParts boolean None Read
 Yes No
extraFeatures.defaultTimeAndPartsToActuals boolean None Read
 Yes No
extraFeatures.enableSeparateBillingClient boolean None Read
 Yes No
extraFeatures.enableEmailAndSmsSignature boolean None Read
 Yes No
extraFeatures.emailAndSmsSignature text None Read
 Yes No
extraFeatures.enableTemplatesAndRecurrences boolean None Read
 Yes No
extraFeatures.recurrenceLimit integer None Read
 Yes No
extraFeatures.enableDropdownMenuOnJobTitle boolean None Read
 Yes No
extraFeatures.enableDropdownMenuOnBusinessType boolean None Read
 Yes No
extraFeatures.enableDropdownMenuOnLeadSource boolean None Read
 Yes No
extraFeatures.jobReferencePrefix text None Read
 Yes No
extraFeatures.jobReferenceNumber integer None Read
 Yes No
extraFeatures.enableJobShareForNewClients boolean None Read
 Yes No
extraFeatures.enableRememberJobSearch boolean None Read
 Yes No
extraFeatures.enablePushNotifications boolean None Read
 Yes No
extraFeatures.enablePushNotificationTime integer None Read
 Yes No
extraFeatures.defaultJobBookingStart integer None Read
 Yes No
extraFeatures.dateFormat text None Read
 Yes No
extraFeatures.jobDateFormat text None Read
 Yes No
extraFeatures.defaultBookingDuration integer None Read
 Yes No
physicalAddress.line1 string None Read
 Yes No
physicalAddress.line2 string None Read
 Yes No
physicalAddress.city string None Read
 Yes No
physicalAddress.state string None Read
 Yes No
physicalAddress.postcode string None Read
 Yes No
mailingAddress.line1 string None Read
 Yes No
mailingAddress.line2 string None Read
 Yes No
mailingAddress.city string None Read
 Yes No
mailingAddress.state string None Read
 Yes No
mailingAddress.postcode string None Read
 Yes No
timeZone string None Read
 Yes No
email string None Read
 Yes No
mobile string None Read
 Yes No
fullMobileNumber string None Read
 No No
phone string None Read
 Yes No
licenses integer None Read
 Yes No
countryCode integer None Read
Write
Change
 Yes No
registrationDate datetime None Read
 No No
superMobile boolean None Read
 Yes No
logoUrl string None Read
 Yes No
extraFeatures.enableJobShareForAllClients json None Read
 Yes No
extraFeatures.calendarSettings text None Read
 Yes No
accountingIntegration text None Read
 Yes No
inventoryIntegration text None Read
 Yes No
mobileCountryCode integer None Read
 Yes No
website text None Read
 Yes No
taxInclusive boolean

Determines if totals are tax inclusve.

 None Read
 Yes No
roles array None Read
 No No