1. Assets
Commusoft developer
  • Introduction
    • Introduction
    • Key concepts and relationships
    • Authentication
    • Rate-limits
    • Requests and responses
    • Core concepts and patterns
    • Support and technical support
  • CRM
    • Properties
      • List customer types
      • List properties
      • Properties
      • Customers
      • Companies
      • Work addresses
      • Customers
      • Companies
      • Work addresses
      • Properties
    • Contacts
      • List property contacts
      • Property contacts
      • Property contacts
      • Property contacts
    • Assets
      • Understanding assets
      • List asset groups
        GET
      • List asset types
        GET
      • Asset structure
        GET
      • Assets dynamic fields
        GET
      • List assets
        GET
      • Assets
        GET
      • Assets
        POST
      • Assets
        PATCH
      • Assets
        DELETE
    • Scheduled activities
      • List scheduled activities
      • Scheduled activities
      • Scheduled activities
      • Complete Scheduled Activity
      • Scheduled activities
    • Search
      GET
  • Sales
    • Opportunities
      • List opportunity pipelines
      • List opportunity stages
      • List opportunities
      • Opportunities
      • Opportunities
      • Opportunities
      • Opportunities
    • Actions
      • Change opportunity stage
  • Jobs
    • Jobs
      • List job description templates
      • List jobs
      • Jobs
      • Jobs
      • Jobs
      • Jobs
    • Forms
      • List forms
    • Actions
      • Change job stage
      • Put on hold
      • Remove on hold
      • Mark as complete
      • Mark as uncompleted
      • Mark as free of charge
      • Mark as aborted
  • Users & Vehicles
    • Users
      • List users
  • Settings
    • List titles
    • List advertising types
    • List telephone types
    • List business units
    • List user groups
    • List provinces
  • Webhooks
    • Webhooks
    • Example PHP script
  1. Assets

Understanding assets

What is an asset#

Assets are pieces of equipment that's been installed at a property. These can be things like HVAC units, boilers, heatpumps or generators. Due to each business wanting to store unique information about the type of equipment they work with, asset structures are completely dynamic.

Asset groups and types#

Each asset will have a group and a type that determines the category of asset for example Boiler > Combination boiler, or Generator > Standby generator. The group and types are determined by each business and configured inside Commusoft's settings. You can get a list of these via a GET call using the API.
There is a relationship between asset groups and types, a one to many groups to types.

Understanding the asset structure/fields#

The asset fields themselves are configured with standard asset fields, which are fields that all assets share, for example 'Make' and 'Mode'. To get a list of standard asset fields the business has configured, call the /assetStructure API. As well as standard fields, assets can have specific fields based on the group and type. For example, it maybe necessary to store specific information only relevant to the group or, the type.

Sub assets#

Sub assets are assets that belong to a parent asset. These can be used to breakdown large or complex assets into small components. The benefit of this is that you can associate jobs, create forms and track history of those smaller components. For example, in a large generator installation you may want to track the main generator as a parent asset and multiple ATS as sub assets.

Version control#

What is it?
Modified at 2026-09-11 08:03:30
Previous
Property contacts
Next
List asset groups
Built with