Menu

API reference · Schema

V1Tenant

V1Tenantcontract v1.tenant
  • tenant_idUuid7required
  • namestringrequired
    min length 1max length 200
  • country_codestringrequired
    pattern ^[A-Z]{2}$
  • base_currencystringrequired
    pattern ^[A-Z]{3}$
  • fy_start_monthintegerrequired
    ≥ 1≤ 12
  • statusenum (2)required
    activeretired
  • is_demobooleanrequired
  • onboarded_atIsoDatetime | nullrequired
  • home_tzstring | nullrequired
    pattern ^[A-Za-z]+\/[A-Za-z_]+$

Used by