A tenant represents the top most billable corporate entity that encapsulates all other resources.
Attributes
Attribute | Type | Description |
---|---|---|
id | Integer | The unique id of the Tenant. |
is_active | Boolean | Defines if the Tenant account is active. |
name | String | The Tenant's name. |
address_street | String | The Tenant's street address. |
address_city | String | The city for the Tenant's address. |
address_state | String | The state for the Tenant's address. |
address_zip | String | The post code for the Tenant's address. |
phone | String | The Tenant's phone number. |
fax | String | The Tenant's fax number. |
url | String | The Tenant's home page URL. |
signed_up_at | DateTime | The date time the Tenant signed up for Contractors Cloud. |
trial_expires_at | DateTime | The date time for when the Tenant's Contractors Cloud account trial will expire. |
billing_starts_at | DateTime | The date time for when the Tenant's Contractors Cloud account will be billed at. |
is_workflow_visible | Boolean | Determines if WorkFlows are enabled for the Tenant. |
is_billable | Boolean | Determines if the Tenant is billable. |
Allowed includes
Relation | Type | Description |
---|
Allowed filters
Name | Type | Description |
---|---|---|
id | Integer | Filter Tenants by their id. |
name | String | Filter Tenants by their name. |
Allowed sorts
Name | Description |
---|---|
name | Sort Tenants by their name |