Company
Details of the company/location
The Company is a representation of what is generally a physical location or use case within the system.
This is the major object to which services, resources, staff and events are connected.
A Company object can sometimes be itself a container representing a region, which will have child locations
Field | Usage / Description | Additional Information |
---|---|---|
id | {{company.id}} | Example: 3700 |
address_id | {{company.address_id}} | Example: 958694 |
available_locales | {{company.available_locales}} | |
children_count | {{company.children_count}} | |
created_at | {{company.created_at}} | |
currency_code | {{company.currency_code}} | Example: GBP |
country_code | {{company.country_code}} | Example: GB |
description | {{company.description}} | Example: Take care of pets |
disabled | {{company.disabled}} | |
extra | {{company.extra}} | Example: {123=>"answer to question 123", 345=>"answer to question 345"} |
host | {{company.host}} | The URL Host of the company |
live | {{company.live}} | |
locale | {{company.locale}} | |
logo_url | <img src='{{company.logo_url}}' | Link to the logo image |
membership_id | {{company.membership_id}} | Example: 37000 |
multi_status | {{company.multi_status}} | |
origin | {{company.origin}} | Where the object came from e.g. importer, manually |
name | {{company.name}} | Example: Pet Store Ltd._ |
numeric_widget_id | {{company.numeric_widget_id}} | |
ref | {{company.ref}} | |
reference | {{company.reference}} | Also known as External Id in the Importer API |
settings | {{company.settings}} | |
template_images | <img src='{{company.images[image_name]}}' | Link to the URL of all images by name |
timezone | {{company.timezone}} | Example: BST |
updated_at | {{company.updated_at}} | |
website | {{company.website}} | Example: petstore.london |
address | {{company.address.property}} | Link to the address object |
app | {{company.app.property}} | Link to a Custom Object belonging to an app |
extras | {{company.extras.property}} | Link to the extra values |
base_company | {{company.basecompany._property}} | Link to the base/top level Company object |
parent_company | {{company.parentcompany._property}} | Link to the parent Company object |
people | {% for person in company.people %} | Loop around all configured staff for this location |
resources | {% for resource in company.resources %} | Loop around all configured resources for this location |
settings | {{company.settings.property}} | Link to the settings object |
services | {% for service in company.services %} | Loop around all configured services for this location |
Updated over 1 year ago