API Reference

Tenant

A tenant represents the top most billable corporate entity that encapsulates all other resources.

Attributes

AttributeTypeDescription
idIntegerThe unique id of the Tenant.
is_activeBooleanDefines if the Tenant account is active.
nameStringThe Tenant's name.
address_streetStringThe Tenant's street address.
address_cityStringThe city for the Tenant's address.
address_stateStringThe state for the Tenant's address.
address_zipStringThe post code for the Tenant's address.
phoneStringThe Tenant's phone number.
faxStringThe Tenant's fax number.
urlStringThe Tenant's home page URL.
signed_up_atDateTimeThe date time the Tenant signed up for Contractors Cloud.
trial_expires_atDateTimeThe date time for when the Tenant's Contractors Cloud account trial will expire.
billing_starts_atDateTimeThe date time for when the Tenant's Contractors Cloud account will be billed at.
is_workflow_visibleBooleanDetermines if WorkFlows are enabled for the Tenant.
is_billableBooleanDetermines if the Tenant is billable.

Allowed includes

RelationTypeDescription

Allowed filters

NameTypeDescription
idIntegerFilter Tenants by their id.
nameStringFilter Tenants by their name.

Allowed sorts

NameDescription
nameSort Tenants by their name