Key concepts and relationships
The following relationships will help you understand how the relationships inside Commusoft work and therefore how you utilise the API effectively.Customers#
The Customer is the "Who." This is the primary billing entity or the person/company that owns the account. This can either be a private customer or a company/organisation.Relationship: The top-level parent. A Customer can have multiple Work Addresses.Scenario: A property management company (The Customer) that pays the bills for 50 different apartment buildings.Work Addresses#
The Work Address used when the work is being done at a different address to the customer. It's unlikely you'd need a work address when dealing with a private customer, however, landlords, estate agents, property management firms, companies, commercial buildings etc will all have work addresses.Relationship: Child of a Customer; Parent of Assets, Jobs, and Contracts.Scenario: One of the specific apartment buildings owned by the property management company.Assets#
An Asset is a specific piece of equipment located at a Customer or Work Address site. The asset is installed, serviced and maintained. The asset doesn't move.Relationship: Assets belong to either customers or work addresses and the relationship defines where the asset is installed.Scenario: A specific gas boiler (serial number: 12345) located in the basement of the apartment building.Contracts#
A Contract defines a service level agreement (SLA) or a recurring billing arrangement for a Customer or specific Work Address.Relationship: Linked to a Customer. Often governs the pricing of Jobs. The contract always is owned by the customer, but can include work addresses under it's terms.Scenario: A "Gold Plan" contract that entitles the customer to one free boiler service per year and 24/7 emergency call-outs.Opportunities#
An Opportunity is a pre-sale entity. It represents a potential lead or a quote that hasn't yet become a confirmed Job.Relationship: The opportunity can belong to either the customer or work address. It is converted into a Job upon acceptance.Scenario: A technician visits a site and notices the AC unit is failing; they create an Opportunity to install a new system.Jobs#
A Job is the "What." It represents a specific piece of work to be done.Relationship: The job can belong to either the customer or work address. A Job can contain multiple Appointments.Scenario: An "Annual Boiler Service" or a "Leaking Pipe Repair."Appointments#
An Appointment is the "When." It is a specific time slot assigned to a technician to carry out a survey for an opportunity or work to be completed on a Job.Relationship: Child of an opportunity or Job. A single Job might require multiple Appointments (e.g., a "First Fix" and "Second Fix").Scenario: Scheduling technician "Dave" to arrive at the apartment building on Tuesday between 9:00 AM and 11:00 AM. Modified at 2026-03-02 16:04:09
