Skip to main content

TenantSchema

_archivedboolean
account_labelsundefined[]
accounts_receivable_bank_accountsundefined[]
accounts_receivable_contact_idintegernullable
aggregate_emails_by_contactbooleannullable
allow_email_two_factorboolean
archivedboolean
archived_datedate-timenullable
archivedbynullable
archivedby_idintegernullable
audit_logundefined[]
automatic_account_linkingboolean
broker_portal_enabledboolean
broker_support_emailstringnullable
can_approve_claim_requestsboolean
can_create_vendor_tenantsboolean
can_enable_new_claim_emailsboolean
can_impersonate_billing_contactboolean
can_impersonate_brokerboolean
can_make_claim_requestsboolean
can_use_portalboolean
claim_tenantsundefined[]
claimsundefined[]
createddatedate-timenullable
default_claims_filter_idintegernullable
default_dashboard
disable_overduebooleannullable
disabled_for_nonpaymentboolean
disabled_for_nonpayment_reasonstringnullable
domainsundefined[]
easy_enroll_dob_requiredboolean
easy_enroll_ssn_requiredboolean
employer_activity_settingsnullable
employersundefined[]
etl_tasksundefined[]
extendednullable

Extra fields for the Tenant table

favicon_override_urlstringnullable
feature_flag_account_accumulatorsboolean
feature_flag_account_rate_reportingboolean
feature_flag_api_userboolean
feature_flag_batch_postingboolean
feature_flag_betaboolean
feature_flag_billingboolean
feature_flag_claim_webhookboolean
feature_flag_claims_harvestingboolean
feature_flag_claims_updaterboolean
feature_flag_cobra_point_employer_portalboolean
feature_flag_communicationsboolean
feature_flag_custom_invoice_layoutboolean
feature_flag_employer_advisor_experienceboolean
feature_flag_etl_pageboolean
feature_flag_insured_employee_countboolean
feature_flag_insured_employee_count_reportingboolean
feature_flag_integrationsboolean
feature_flag_interopboolean
feature_flag_invoice_footer_templatesboolean
feature_flag_invoicing_communicationsboolean
feature_flag_invoicing_communications_onlyboolean
feature_flag_javascript_sdk_tokenboolean
feature_flag_knowledge_baseboolean
feature_flag_login_problem_webhookboolean
feature_flag_lookback_adjustmentsboolean
feature_flag_manual_billingboolean
feature_flag_payable_entityboolean
feature_flag_payer_healthboolean
filtersundefined[]
first_crawl_completion_webhook_urlstringnullable
fix_credentials_mfa_delay_daysinteger
fix_credentials_week_fourboolean
fix_credentials_week_oneboolean
fix_credentials_week_threeboolean
fix_credentials_week_twoboolean
has_vendor_unitsboolean
hs_aggregate_emails_by_contactbooleannullable
hs_disable_overduebooleannullable
hs_fix_credentials_mfa_delay_daysintegernullable
hs_fix_credentials_week_fourbooleannullable
hs_fix_credentials_week_onebooleannullable
hs_fix_credentials_week_threebooleannullable
hs_fix_credentials_week_twobooleannullable
hs_include_csv_detail_linkbooleannullable
hs_include_divisional_breakdownbooleannullable
hs_include_pdf_detail_linkbooleannullable
hs_include_pdf_summary_attachmentbooleannullable
hs_include_portal_access_linkbooleannullable
hs_invoice_day_of_month_dueintegernullable
hs_invoice_due_daysintegernullable
hs_invoice_email_templatenullable
hs_invoice_email_template_uuiduuidnullable
hs_invoice_footer_templatenullable
hs_invoice_footer_template_uuiduuidnullable
hs_invoice_header_templatenullable
hs_invoice_header_template_uuiduuidnullable
hs_require_mfa_for_portal_accessbooleannullable
hs_show_account_statusbooleannullable
hs_streamlined_employer_portalbooleannullable

Send this group to the new broker portal (but for employers)

hs_whitelabel_display_namestringnullable
hs_whitelabel_localstringnullable
hs_whitelabel_subdomainstringnullable
hubspot_idstringnullable
idinteger
include_csv_detail_linkbooleannullable
include_divisional_breakdownbooleannullable
include_pdf_detail_linkbooleannullable
include_pdf_summary_attachmentbooleannullable
include_portal_access_linkbooleannullable
invoice_day_of_month_dueintegernullable
invoice_default_payment_urlstringnullable
invoice_due_daysstringnullable
invoice_email_login_link_enabledbooleannullable
invoice_email_subject_templatestringnullable
invoice_email_template_uuidstring
invoice_footer_template_uuidstring
invoice_header_template_uuidstring
invoice_key_templatestringnullable

Jinja2 template for how invoice.invoice_key should be generated

is_demoboolean
login_problem_webhook_urlstringnullable
logo_urlstringnullable
mailchimp_member_automation_urlstringnullable
mailgun_domainstring
mailgun_subdomainstring
mailgun_whitelabel_domainstringnullable
mailgun_whitelabel_enabled_communicationsbooleannullable
mailgun_whitelabel_enabled_invoicingbooleannullable
membersundefined[]
modifieddatedate-timenullable
namestringrequired
new_claim_webhook_urlstringnullable
onboard_send_reimbursement_textstringnullable
organization_idintegerrequired
organization_usersundefined[]
outbound_tasksundefined[]
policy_holdersundefined[]
post_every_crawl_completion_webhookboolean
prefer_new_uxboolean
price_per_policy_holder_per_monthnumbernullable
remittance_dashboard_enabledboolean
require_mfa_for_portal_accessbooleannullable
sales_entitiesundefined[]
show_account_statusbooleannullable
show_overdue_invoices_in_portalbooleannullable
show_previously_outstanding_invoiceboolean
slugstringnullable
sso_error_messagestringnullable
streamlined_employer_portalbooleannullable
support_emailstringnullable

Don't use this directly - instead use employer.support_email_derived

support_phonestringnullable

Don't use this directly - instead use employer.support_phone_derived

teamsundefined[]
tenant_email_domainsundefined[]
tenant_feature_flagnullable
tenant_feature_flag_idintegerrequired
tenant_idinteger
tenant_subscription_default_idintegernullable
terms_of_usestringnullable
terms_of_use_messagestringnullable
time_zonestring
total_eligible_membersintegernullable

How many members we think this tenant is technically able to add. This is a user-defined value.

two_factor_required_bydatenullable
uuiduuid
vendors_ownedundefined[]
vero_event_login_needs_correctionstringnullable
vero_event_login_needs_correction_memberstringnullable
vero_event_new_claim_createdstringnullable
vero_event_send_enrollment_emailstringnullable
vero_event_send_enrollment_email_oncestringnullable
whitelabel_display_namestringnullable
whitelabel_from_addressstringnullable
whitelabel_localstringnullable
whitelabel_nicknamestringnullable
whitelabel_subdomainstringnullable
TenantSchema
{
  "_archived": true,
  "account_labels": [
    null
  ],
  "accounts_receivable_bank_accounts": [
    null
  ],
  "accounts_receivable_contact_id": 0,
  "aggregate_emails_by_contact": true,
  "allow_email_two_factor": true,
  "archived": true,
  "archived_date": "2024-07-29T15:51:28.071Z",
  "archivedby_id": 0,
  "audit_log": [
    null
  ],
  "automatic_account_linking": true,
  "broker_portal_enabled": true,
  "broker_support_email": "string",
  "can_approve_claim_requests": true,
  "can_create_vendor_tenants": true,
  "can_enable_new_claim_emails": true,
  "can_impersonate_billing_contact": true,
  "can_impersonate_broker": true,
  "can_make_claim_requests": true,
  "can_use_portal": true,
  "claim_tenants": [
    null
  ],
  "claims": [
    null
  ],
  "createddate": "2024-07-29T15:51:28.071Z",
  "default_claims_filter_id": 0,
  "default_dashboard": {},
  "disable_overdue": true,
  "disabled_for_nonpayment": true,
  "disabled_for_nonpayment_reason": "string",
  "domains": [
    null
  ],
  "easy_enroll_dob_required": true,
  "easy_enroll_ssn_required": true,
  "employers": [
    null
  ],
  "etl_tasks": [
    null
  ],
  "favicon_override_url": "string",
  "feature_flag_account_accumulators": true,
  "feature_flag_account_rate_reporting": true,
  "feature_flag_api_user": true,
  "feature_flag_batch_posting": true,
  "feature_flag_beta": true,
  "feature_flag_billing": true,
  "feature_flag_claim_webhook": true,
  "feature_flag_claims_harvesting": true,
  "feature_flag_claims_updater": true,
  "feature_flag_cobra_point_employer_portal": true,
  "feature_flag_communications": true,
  "feature_flag_custom_invoice_layout": true,
  "feature_flag_employer_advisor_experience": true,
  "feature_flag_etl_page": true,
  "feature_flag_insured_employee_count": true,
  "feature_flag_insured_employee_count_reporting": true,
  "feature_flag_integrations": true,
  "feature_flag_interop": true,
  "feature_flag_invoice_footer_templates": true,
  "feature_flag_invoicing_communications": true,
  "feature_flag_invoicing_communications_only": true,
  "feature_flag_javascript_sdk_token": true,
  "feature_flag_knowledge_base": true,
  "feature_flag_login_problem_webhook": true,
  "feature_flag_lookback_adjustments": true,
  "feature_flag_manual_billing": true,
  "feature_flag_payable_entity": true,
  "feature_flag_payer_health": true,
  "filters": [
    null
  ],
  "first_crawl_completion_webhook_url": "string",
  "fix_credentials_mfa_delay_days": 0,
  "fix_credentials_week_four": true,
  "fix_credentials_week_one": true,
  "fix_credentials_week_three": true,
  "fix_credentials_week_two": true,
  "has_vendor_units": true,
  "hs_aggregate_emails_by_contact": true,
  "hs_disable_overdue": true,
  "hs_fix_credentials_mfa_delay_days": 0,
  "hs_fix_credentials_week_four": true,
  "hs_fix_credentials_week_one": true,
  "hs_fix_credentials_week_three": true,
  "hs_fix_credentials_week_two": true,
  "hs_include_csv_detail_link": true,
  "hs_include_divisional_breakdown": true,
  "hs_include_pdf_detail_link": true,
  "hs_include_pdf_summary_attachment": true,
  "hs_include_portal_access_link": true,
  "hs_invoice_day_of_month_due": 0,
  "hs_invoice_due_days": 0,
  "hs_invoice_email_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_invoice_footer_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_invoice_header_template_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hs_require_mfa_for_portal_access": true,
  "hs_show_account_status": true,
  "hs_streamlined_employer_portal": true,
  "hs_whitelabel_display_name": "string",
  "hs_whitelabel_local": "string",
  "hs_whitelabel_subdomain": "string",
  "hubspot_id": "string",
  "id": 0,
  "include_csv_detail_link": true,
  "include_divisional_breakdown": true,
  "include_pdf_detail_link": true,
  "include_pdf_summary_attachment": true,
  "include_portal_access_link": true,
  "invoice_day_of_month_due": 0,
  "invoice_default_payment_url": "string",
  "invoice_due_days": "string",
  "invoice_email_login_link_enabled": true,
  "invoice_email_subject_template": "string",
  "invoice_email_template_uuid": "string",
  "invoice_footer_template_uuid": "string",
  "invoice_header_template_uuid": "string",
  "invoice_key_template": "string",
  "is_demo": true,
  "login_problem_webhook_url": "string",
  "logo_url": "string",
  "mailchimp_member_automation_url": "string",
  "mailgun_domain": "string",
  "mailgun_subdomain": "string",
  "mailgun_whitelabel_domain": "string",
  "mailgun_whitelabel_enabled_communications": true,
  "mailgun_whitelabel_enabled_invoicing": true,
  "members": [
    null
  ],
  "modifieddate": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "new_claim_webhook_url": "string",
  "onboard_send_reimbursement_text": "string",
  "organization_id": 0,
  "organization_users": [
    null
  ],
  "outbound_tasks": [
    null
  ],
  "policy_holders": [
    null
  ],
  "post_every_crawl_completion_webhook": true,
  "prefer_new_ux": true,
  "price_per_policy_holder_per_month": 0,
  "remittance_dashboard_enabled": true,
  "require_mfa_for_portal_access": true,
  "sales_entities": [
    null
  ],
  "show_account_status": true,
  "show_overdue_invoices_in_portal": true,
  "show_previously_outstanding_invoice": true,
  "slug": "string",
  "sso_error_message": "string",
  "streamlined_employer_portal": true,
  "support_email": "string",
  "support_phone": "string",
  "teams": [
    null
  ],
  "tenant_email_domains": [
    null
  ],
  "tenant_feature_flag_id": 0,
  "tenant_id": 0,
  "tenant_subscription_default_id": 0,
  "terms_of_use": "string",
  "terms_of_use_message": "string",
  "time_zone": "string",
  "total_eligible_members": 0,
  "two_factor_required_by": "2024-07-29",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendors_owned": [
    null
  ],
  "vero_event_login_needs_correction": "string",
  "vero_event_login_needs_correction_member": "string",
  "vero_event_new_claim_created": "string",
  "vero_event_send_enrollment_email": "string",
  "vero_event_send_enrollment_email_once": "string",
  "whitelabel_display_name": "string",
  "whitelabel_from_address": "string",
  "whitelabel_local": "string",
  "whitelabel_nickname": "string",
  "whitelabel_subdomain": "string"
}