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.

Schema

Name / Description	Type / Format	Example
`id` Dedicated setter compared to ModelBase so only tenant JSON deserialization writes "id" into Tenant.UniqueId.	`string` uuid	`"string"`
`brandCode`	`string`	`"string"`
`appName`	`string`	`"string"`
`homeUrl`	`string`	`"string"`
`headContent`	`string`	`"string"`
`logOutUrl`	`string`	`"string"`
`loginImgUrl`	`string`	`"string"`
`homeImgUrl`	`string`	`"string"`
`favIcon`	`string`	`"string"`
`cssColorsFile`	`string`	`"string"`
`cssFile`	`string`	`"string"`
`mailingList`	`boolean`	`true`
`htmlInsertions`	`TenantHtmlInsertion[]`	`{TenantHtmlInsertion}`
`mailSettings` Determines the settings used when the Employer sends emails. If CustomiseSmtpSettings is false then SmtpSettings will be null and our default internal settings will be used;	`MailSettings`	`{MailSettings}`
`signupUrl`	`string`	`"string"`
`termsUrl`	`string`	`"string"`
`helpUrl`	`string`	`"string"`
`supportEmail`	`string` email	`"string"`
`newUserSignupEmail`	`string` email	`"string"`
`approveNewUsers`	`boolean`	`true`
`enableBureauFeatures`	`boolean`	`true`
`enableAdvancedBureauDashboard` Enables advanced bureau dashboard features including enhanced analytics and reporting. Can only be set by Super Admin. Automatically reset to false when EnableBureauFeatures is disabled.	`boolean`	`true`
`enableNewSquadRoles` Enables adding new payroll squad roles. Can only be set by Super Admin. Automatically reset to false when EnableBureauFeatures is disabled.	`boolean`	`true`
`requireDdMandateBeforeAllowingBillableActivity`	`boolean`	`true`
`whiteLabelMode`	`boolean`	`true`
`enableReportWriterFeature` Indicates if the Report Writer feature is enabled for the tenant.	`boolean`	`true`
`disableEvc` Indicates whether FPS should be submitted to EVC for employees/employers under this tenant.	`boolean`	`true`
`tenantOwnsBilling`	`boolean`	`true`
`billingSettings`	`TenantBillingSettings`	`{TenantBillingSettings}`
`usersCanManageAccountSecuritySettings` If the users are allowed manage their own account security settings through a page or portal defined by their current authentication provider	`boolean`	`true`
`enableAdminsToManageReportWriter` Indicates whether all Admin users of a tenant can manage report templates.	`boolean`	`true`

JSON Example

{
  "id": "string",
  "brandCode": "string",
  "appName": "string",
  "homeUrl": "string",
  "headContent": "string",
  "logOutUrl": "string",
  "loginImgUrl": "string",
  "homeImgUrl": "string",
  "favIcon": "string",
  "cssColorsFile": "string",
  "cssFile": "string",
  "mailingList": true,
  "htmlInsertions": [
    {
      "insertionPoint": "CreateEmployer",
      "content": "string"
    }
  ],
  "mailSettings": {
    "senderName": "string",
    "senderEmail": "string",
    "useSystemFromAddress": true,
    "senderEmailVerified": true,
    "customiseSmtpSettings": true,
    "smtpSettings": {
      "smtpServer": "string",
      "smtpPort": 0,
      "encryption": "Auto",
      "smtpUsername": "string",
      "smtpPassword": "string",
      "accessToken": "string",
      "expiresAt": "2026-10-24",
      "refreshToken": "string",
      "expiresIn": 0
    },
    "customiseHtmlEmailSettings": true,
    "htmlEmailSettings": {
      "bodyCssStyle": "string",
      "fontCssStyle": "string",
      "buttonCssStyle": "string",
      "headerHtml": "string",
      "footerHtml": "string"
    },
    "id": "string"
  },
  "signupUrl": "string",
  "termsUrl": "string",
  "helpUrl": "string",
  "supportEmail": "string",
  "newUserSignupEmail": "string",
  "approveNewUsers": true,
  "enableBureauFeatures": true,
  "enableAdvancedBureauDashboard": true,
  "enableNewSquadRoles": true,
  "requireDdMandateBeforeAllowingBillableActivity": true,
  "whiteLabelMode": true,
  "enableReportWriterFeature": true,
  "disableEvc": true,
  "tenantOwnsBilling": true,
  "billingSettings": {
    "discount": 0.0,
    "monthlyMinimum": 0.0,
    "aggregatedPricing": true,
    "billTo": "string",
    "pricingTable": "string",
    "netSuiteDefaultItemCode": "string",
    "netSuiteDefaultDescription": "string"
  },
  "usersCanManageAccountSecuritySettings": true,
  "enableAdminsToManageReportWriter": true
}

References

Contained in Models
User

Consumed by Operations
Create a Tenant
Update a Tenant

Returned by Operations
Get Tenant
Tenant Branding
Create a Tenant
Get a Tenant
Update a Tenant
Upload Logo
Upload Favicon