Employee

Attribute Details

• UIDGuid (36)
• Unique employee contact identifier in the form of a guid.
  ONLY required for updating an existing contact
  NOT required when creating a new contact.
• CompanyNameString (50)
• Company name of the employee contact.
  ONLY required when creating a company contact with IsIndividual set to false.
• LastNameString (30)
• Last name for an individual contact
• FirstNameString (20)
• First name for an individual contact
• IsIndividualBoolean
• True indicates the employee contact represents an individual.
  False indicates the employee contact represents a company.
• DisplayIDString (15)
• Employee contact card id. { 'DisplayID': 'EMP00001' }
• IsActiveBoolean
• True indicates the employee contact is active.
  False indicates the employee contact is inactive.
• Addresses []
• The following set of information pulls through details for a contact address
• • Location Integer
  • One contact can have up to five address records.
  • Street String (255)
  • Full content of Address field.
  • City String (255)
  • City of address record.
  • State String (255)

  • State of address record.
    
    Updated in 2018.1, this field is required for addresses with a country that is blank or "Australia". Where required, valid values are:
    AAT
    ACT
    NSW
    NT
    QLD
    SA
    TAS
    VIC
    WA
    

  • PostCode String (11)
  • Postcode of address record.
  • Country String (255)

  • Country of location for address record.
    Updated in 2018.1, setting the country to "Australia" or a blank/null value will make the State field required for this address.

  • Phone1 String (21)
  • Phone number 1 of address record.
  • Phone2 String (21)
  • Phone number 2 of address record.
  • Phone3 String (21)
  • Phone number 3 of address record.
  • Fax String (21)
  • Fax number of address record.
  • Email String (255)
  • Email contact of address record.
  • Website String (255)
  • World wide web address for contact.
  • ContactName String (25)
  • Contact Name on address record.
  • Salutation String (15)
  • Salutation text for address record.
• NotesString (255)
• Notes for the employee contact.
• Identifiers []
• The following set of information pulls through details for a contact identifier
• • Label String (30)
  • Name attached to the identification alphabet letter.
  • Value String
  • Identifiers convert bits to actual letters, one of the 26 letters in the alphabet can be used.
• CustomList1
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList1 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 1 could be changed to Melbourne, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList1.
• CustomList2
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList2 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 2 could be changed to Sydney, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList2.
• CustomList3
• The following set of information pulls through details for a contact custom list
• • LabelString (30)
  • Name of CustomList3 applicable to the custom list text, labels can be edited within the AccountRight interface ONLY.
    For example CustomList # 3 could be changed to Tasmania, click here for more information on how to edit labels
  • ValueString (30)
  • Custom list text entry populated for CustomList3.
• CustomField1
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField1 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
    For example CustomField # 1 could be changed to South Australia, click here for more information on how to edit labels
  • ValueString (30)
  • Custom field text entry populated for CustomField1.
• CustomField2
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField2 applicable to the custom field text, labels can be edited, for example CustomField # 2 could be changed to Queensland
  • ValueString (30)
  • Custom field text entry populated for CustomField2.
• CustomField3
• The following set of information pulls through details for a contact custom field
• • LabelString (30)
  • Name of CustomField3 applicable to the custom field text, labels can be edited within the AccountRight interface ONLY.
    For example CustomField # 3 could be changed to ACT, click here for more information on how to edit labels
  • ValueString (30)
  • Custom field text entry populated for CustomField3.
• CurrentBalanceDecimal (13.6)
• Employee contact balance.
• EmployeePayrollDetails
• The following set of information pulls through details for the Employee Payroll Details object.
• • UID GUID (36)
  • Foreign Key: Unique employee payroll details identifier in the form of a guid
  • URI String
  • Uniform resource identifier associated with the employee payroll details object.
• EmployeePaymentDetails
• The following set of information pulls through details for the Employee Payment Details object.
• • UID GUID (36)
  • Foreign Key: Unique employee payment details identifier in the form of a guid.
    Note: When creating a new employee contact, PaymentMethod defaults to Cheque.
  • URI String
  • Uniform resource identifier associated with the employee payment details object.
• EmployeeStandardPay
• The following set of information pulls through details for the Employee Standard Pay object.
• • UID GUID (36)
  • Foreign Key: Employee standard payroll details identifier in the form of a guid.
    Please note: this identifier is equal to that of the EmployeePayrollDetails.UID
  • URI String
  • Uniform resource identifier associated with the employee payroll details object.
• TimeBillingDetails
• Details for the employee's time billing rates and hours
• • EmployeeBillingRateExcludingTaxDecimal (13.2)
  • Hourly billing rate for services provided by employee
  • CostPerHourDecimal (13.2)
  • Hourly cost of employee to business.
• LastModifiedDateTime
• Extracts the last modification date for the contact resource.
• PhotoURIString
• This is an AccountRight only field. Uniform resource identifier associated with a photo image.
• URIString
• Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
• RowVersionString
• Number value that changes upon a record update, can also be used for change control but does does not preserve a date or a time.
  ONLY required for updating an existing contact
  NOT required when creating a new contact.

For more information, check out our Knowledge base article "Employee Endpoint".

Paging: default page size is set to 400 with a maximum of 5000 results (contacts only).