User

Represents a User Account.
As well as basic details about the user it also includes details of Employers that the user account can access.

Name / Description Type / Format Example
emailAddress string email "string"
pendingEmailAddress
If the user has requested to change their email address then the address it'll be changed to after verification will be shown here.
string email "string"
firstName string "string"
lastName string "string"
userIdentifier string "string"
photo string "string"
role string "Admin" "Editor" "Reviewer"
jobType string "BusinessOwner" "PayrollManager" "Accountant" "Developer" "SoftwareVendor" "Other"
emailVerified boolean true
gdprOptin boolean true
inviteCode string "string"
registrationIp string "string"
registrationDate string date "2020-07-14"
lastLogin string date "2020-07-14"
isActivated boolean true
authorization
This model provides information about what the User is able to access.
This would usually just be a list of Employers. But if the user is an adminsitrator for a White Label instance then this will be shown in the list of Tenants.
UserAuthorization {UserAuthorization}
tenant
The Tenant model represents the brand that provides the account.
This is used by our White Label partners to manage and brand their user accounts.
Unless you are an admin for a White Label account you'll have no interest in this model.
Tenant {Tenant}
requestDdSetup
If true then the user is required to set up a direct debit mandate
boolean true
disabled
If true then any employers the owner managed will not be able to run new payruns.
DisabledReason will give a reason why the account is disabled
boolean true
canCreateEmployers
If false then the user cannot create new employers.
This can be turned on or off by the tenant admin.
boolean true
disabledReason string "string"
directDebitMandate DirectDebitMandate {DirectDebitMandate}
displayPrefs UserDisplayPreferences {UserDisplayPreferences}
showBills
Whether or not the user can see bills. This will be false if the Tenant manages billing and the user is not an admin for the Tenant
boolean true
accountingCustomerId string "string"
utmInfo UtmInfo {UtmInfo}
id
The unique id of the object
string uuid "string"
{
  "emailAddress": "string",
  "pendingEmailAddress": "string",
  "firstName": "string",
  "lastName": "string",
  "userIdentifier": "string",
  "photo": "string",
  "role": "Admin",
  "jobType": "BusinessOwner",
  "emailVerified": true,
  "gdprOptin": true,
  "inviteCode": "string",
  "registrationIp": "string",
  "registrationDate": "2020-07-14",
  "lastLogin": "2020-07-14",
  "isActivated": true,
  "authorization": {
    "employers": [
      {
        "isOwner": true,
        "role": "Admin",
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ],
    "tenants": [
      {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      }
    ]
  },
  "tenant": {
    "brandCode": "string",
    "appName": "string",
    "homeUrl": "string",
    "headContent": "string",
    "logOutUrl": "string",
    "loginImgUrl": "string",
    "homeImgUrl": "string",
    "favIcon": "string",
    "cssColorsFile": "string",
    "cssFile": "string",
    "mailingList": true,
    "mailSettings": {
      "senderName": "string",
      "senderEmail": "string",
      "senderEmailVerified": true,
      "customiseSmtpSettings": true,
      "smtpSettings": {
        "smtpServer": "string",
        "smtpPort": 0,
        "useSsl": true,
        "smtpUsername": "string",
        "smtpPassword": "string"
      },
      "customiseHtmlEmailSettings": true,
      "htmlEmailSettings": {
        "bodyCssStyle": "string",
        "fontCssStyle": "string",
        "buttonCssStyle": "string",
        "headerHtml": "string",
        "footerHtml": "string"
      },
      "id": "string"
    },
    "signupUrl": "string",
    "termsUrl": "string",
    "supportEmail": "string",
    "approveNewUsers": true,
    "tenantOwnsBilling": true,
    "id": "string"
  },
  "requestDdSetup": true,
  "disabled": true,
  "canCreateEmployers": true,
  "disabledReason": "string",
  "directDebitMandate": {
    "isCompleted": true,
    "bankName": "string",
    "accountNumberEnding": "string",
    "id": "string"
  },
  "displayPrefs": {
    "startPage": "Dashboard",
    "showZeroes": true,
    "showTaxCodeWhenViewingPayrunEntry": true,
    "allowJournalResubmit": true,
    "hideSalaryOnEmployeeIndexPage": true,
    "enableMultiEmployerImport": true,
    "enableCovid19Features": true
  },
  "showBills": true,
  "accountingCustomerId": "string",
  "utmInfo": {
    "source": "string",
    "medium": "string",
    "term": "string",
    "content": "string",
    "campaign": "string"
  },
  "id": "string"
}