Required roles
- Coworker-*
Learn more about Customers in our Knowledge Base.
Properties
Property | Type | Required | Information |
|---|---|---|---|
CoworkerType | enum | No | |
Businesses | array_int | No | |
Teams | array_int | No | |
FullName | string | Yes | |
Salutation | string | No | |
Gender | enum | No | |
string | Yes | ||
CreateUser | boolean | No | |
Address | string | No | |
PostCode | string | No | |
CityName | string | No | |
State | string | No | |
CountryId | int | Yes | |
SimpleTimeZoneId | int | Yes | |
MobilePhone | string | No | |
LandLine | string | No | |
DateOfBirth | timestamp | No | |
NickName | string | No | |
BusinessArea | string | No | |
Position | string | No | |
CompanyName | string | No | |
ProfileWebsite | string | No | |
ProfileTags | string | No | |
ProfileSummary | string | No | |
string | No | ||
string | No | ||
string | No | ||
Telegram | string | No | |
string | No | ||
Skype | string | No | |
Github | string | No | |
string | No | ||
Flickr | string | No | |
string | No | ||
Vimeo | string | No | |
Tumblr | string | No | |
Blogger | string | No | |
ProfileIsPublic | boolean | No | |
InvoicingBusinessId | int | No | |
InvoicingBusinessName | string | No | Read-only |
BillingEmail | string | No | |
BillingName | string | No | |
BillingAddress | string | No | |
BillingPostCode | string | No | |
BillingCityName | string | No | |
BillingState | string | No | |
BillingCountryId | int | No | |
BillingSimpleTimeZoneId | int | No | |
TaxRateType | enum | No | |
TaxRate | float | Yes | |
TaxIDNumber | string | No | |
BankName | string | No | |
BankAccount | string | No | |
BankBranch | string | No | |
NotifyOnNewInvoice | boolean | No | |
NotifyOnNewPayment | boolean | No | |
NotifyOnFailedPayment | boolean | No | |
ShowPayingMemberInvoices | boolean | No | |
EnableGoCardlessPayments | boolean | No | |
GoCardlessContractNumber | string | No | |
StripeBacsDDPaymentMethodId | string | No | |
StripeBacsDDMandateId | string | No | |
StripeBacsDDCustomerToken | string | No | |
StripeBacsDDEnabled | boolean | No | |
RegularPaymentProvider | enum | No | |
RegularPaymentContractNumber | string | No | |
CardNumber | string | No | |
DoNotProcessInvoicesAutomatically | boolean | No | |
AllowNetworkCheckin | boolean | No | |
CheckinSinceLastRenewal | int | No | |
MinutesSinceLastRenewal | int | No | |
AccessCardId | string | No | |
AccessPincode | string | No | |
KeyFobNumber | string | No | |
NotifyOnDelivery | boolean | No | |
EzeepUserId | string | No | |
EzeepFreePrinting | boolean | No | |
EzeepBlueUserId | string | No | |
EzeepBlueFreePrinting | boolean | No | |
EzeepBluePrintingEnabled | boolean | No | |
PaperCutPayAsYouPrint | boolean | No | |
PaperCutFreePrinting | boolean | No | |
PaperCutUserId | string | No | |
CanMakeBookings | boolean | No | |
CanBookForTeam | boolean | No | |
CanPurchaseProducts | boolean | No | |
CanPurchaseEvents | boolean | No | |
CanAccessCommunity | boolean | No | |
ReferenceNumber | string | No | |
Tag | string | No | |
Notes | string | No | |
ShowAlert | boolean | No | |
AlertNote | string | No | |
UserId | int | No | |
UserFullName | string | No | Read-only |
UserIsAdmin | string | No | Read-only |
UserLastAccess | string | No | Read-only |
UserActive | string | No | Read-only |
UserReceiveCommunityDigest | string | No | Read-only |
UserReceiveEveryMessage | string | No | Read-only |
Active | boolean | No | |
NextAutoInvoice | timestamp | No | |
InvoiceDueDatePeriod | int | No | |
RegistrationDate | timestamp | No | |
GeneralTermsAccepted | boolean | No | |
Custom1 | string | No | |
Custom2 | string | No | |
Custom3 | string | No | |
Custom4 | string | No | |
Custom5 | string | No | |
Custom6 | string | No | |
Custom7 | string | No | |
Custom8 | string | No | |
Custom9 | string | No | |
Custom10 | string | No | |
Custom11 | string | No | |
Custom12 | string | No | |
Custom13 | string | No | |
Custom14 | string | No | |
Custom15 | string | No | |
Custom16 | string | No | |
Custom17 | string | No | |
Custom18 | string | No | |
Custom19 | string | No | |
Custom20 | string | No | |
Custom21 | string | No | |
Custom22 | string | No | |
Custom23 | string | No | |
Custom24 | string | No | |
Custom25 | string | No | |
Custom26 | string | No | |
Custom27 | string | No | |
Custom28 | string | No | |
Custom29 | string | No | |
Custom30 | string | No | |
StripeACHBankToken | string | No | |
StripeACHCustomerToken | string | No | |
HasAcceptedStripeACHAgreement | boolean | No | |
HasVerifiedStripeACHDeposits | boolean | No | |
PurchaseOrder | string | No | |
SyncToSquare | boolean | No | |
NotifyOnDeliveriesEmail | string | No | |
SyncToPaperCutDue | boolean | No | |
CoworkerContractIds | string | No | |
CoworkerContractTariffNames | string | No | |
BillingDay | int | No | |
TariffId | int | No | |
TariffInvoiceEvery | int | No | |
TariffInvoiceEveryWeeks | int | No | |
RenewalDate | timestamp | No | |
TeamName | string | No | |
TeamId | int | No | |
TeamNames | string | No | |
TeamIds | string | No | |
CurrentAccessSignature | string | No | |
InvoiceSegregationOverride | boolean | No | |
InvoiceSegregateContracts | boolean | No | |
InvoiceSegregateBookings | boolean | No | |
InvoiceSegregateProducts | boolean | No | |
InvoiceSegregateTimePasses | boolean | No | |
InvoiceSegregateTickets | boolean | No | |
IsDefaultProfile | boolean | No | |
InvoiceSegregateCharges | boolean | No | |
EzeepPrintingEnabled | boolean | No | |
ChurnProbability | float | No | |
EngagementLevel | string | No | |
InvoiceDueDateDay | int | No | |
MondayAttendance | enum | No | |
TuesdayAttendance | enum | No | |
WednesdayAttendance | enum | No | |
ThursdayAttendance | enum | No | |
FridayAttendance | enum | No | |
SaturdayAttendance | enum | No | |
SundayAttendance | enum | No | |
Longitude | float | No | |
Latitude | float | No | |
BillingLongitude | float | No | |
BillingLatitude | float | No | |
Archived | boolean | No | |
AvatarFileName | string | No | |
BannerImageFileName | string | No | |
NextTariffId | int | No | |
StartDate | timestamp | No | |
CancellationDate | timestamp | No | |
IsTeamAdministrator | boolean | No | |
Quantity | int | No | |
UnitPrice | float | No | |
Desks | array_int | No | |
TotalActiveContracts | float | No | |
TotalNonRefundableDepositsActiveContracts | float | No | |
TotalNonRefundableDepositsNewContracts | float | No | |
TotalRefundableDepositsActiveContracts | float | No | |
TotalRefundableDepositsNewContracts | float | No | |
TotalDepositsActiveContracts | float | No | |
TotalDepositsNewContracts | float | No | |
TotalNewContracts | float | No | |
TotalRecurrentProducts | float | No | |
RecurrentProductsNames | string | No | |
CreateSingleInvoiceForTeam | boolean | No | |
TariffName | string | No | |
NextTariffName | string | No | |
HasDueInvoices | boolean | No | |
IsAdmin | boolean | No | |
SignUpToNewsletter | boolean | No | |
BusinessNames | string | No | |
Password | string | No | |
InvoicingOrder | int | No | |
GuessedFirstNameForInvoice | string | No | |
GuessedLastNameForInvoice | string | No | |
GuessedFirstName | string | No | |
GuessedLastName | string | No | |
Id | int | Yes | Read-only |
UpdatedOn | timestamp | No | Read-only |
CreatedOn | timestamp | No | Read-only |
UniqueId | string | No | Read-only |
SystemId | string | No |
Related records
Property | Record type |
|---|---|
CountryId | |
SimpleTimeZoneId | |
InvoicingBusinessId | |
BillingCountryId | |
BillingSimpleTimeZoneId | |
UserId | |
TariffId | |