# Commusoft developer ## Docs - Introduction [Introduction](https://developer.commusoft.com/introduction-1985208m0.md): - Introduction [Key concepts and relationships](https://developer.commusoft.com/key-concepts-and-relationships-1985291m0.md): - Introduction [Authentication](https://developer.commusoft.com/authentication-1985209m0.md): - Introduction [Rate-limits](https://developer.commusoft.com/rate-limits-1985219m0.md): - Introduction [Requests and responses](https://developer.commusoft.com/requests-and-responses-1985359m0.md): - Introduction [Core concepts and patterns](https://developer.commusoft.com/core-concepts-and-patterns-1985393m0.md): - Introduction [Support and technical support](https://developer.commusoft.com/support-and-technical-support-1985398m0.md): - CRM > Assets [Understanding assets](https://developer.commusoft.com/understanding-assets-2391372m0.md): - Webhooks [Webhooks](https://developer.commusoft.com/webhooks-2114965m0.md): - Webhooks [Example PHP script](https://developer.commusoft.com/example-php-script-2117190m0.md): ## API Docs - CRM > Properties [List customer types](https://developer.commusoft.com/list-customer-types-27670540e0.md): A Customer Type is a category used to group customers (e.g., Private, Company, Hospital, or Builder). It's used to build segmentation in Commusoft, for example, setting email templates by customer type (a different invoice email template based on customer type). It can also be used in reporting to generate reports, for example, revenue by customer type. - CRM > Properties [List properties](https://developer.commusoft.com/list-properties-24494182e0.md): A property is either a customer or work site. It represents an address where assets, contracts, opportunities or jobs can be recorded. The list properties end point will return a list of properties. - CRM > Properties [Properties](https://developer.commusoft.com/properties-24700271e0.md): - CRM > Properties [Customers](https://developer.commusoft.com/customers-24695232e0.md): A customer is the primary record in Commusoft. You will need to create a customer - CRM > Properties [Companies](https://developer.commusoft.com/companies-24695234e0.md): - CRM > Properties [Work addresses](https://developer.commusoft.com/work-addresses-24695289e0.md): - CRM > Properties [Customers](https://developer.commusoft.com/customers-24695291e0.md): - CRM > Properties [Companies](https://developer.commusoft.com/companies-24695351e0.md): - CRM > Properties [Work addresses](https://developer.commusoft.com/work-addresses-24695354e0.md): - CRM > Properties [Properties](https://developer.commusoft.com/properties-24695433e0.md): - CRM > Contacts [List property contacts](https://developer.commusoft.com/list-property-contacts-28546275e0.md): A contact is a person. Contacts can belong to customers, work addresses or suppliers. A private customer will always have at least 1 primary contact. In order to email, call or SMS in Commusoft, you will need a contact. - CRM > Contacts [Property contacts](https://developer.commusoft.com/property-contacts-28690973e0.md): This end point lets you create new contacts against either customers or work addresses. - CRM > Contacts [Property contacts](https://developer.commusoft.com/property-contacts-31975392e0.md): - CRM > Contacts [Property contacts](https://developer.commusoft.com/property-contacts-31975469e0.md): - CRM > Assets [List asset groups](https://developer.commusoft.com/list-asset-groups-38522859e0.md): The asset groups are the top level category for assets for example Boiler/Generator/Heatpump. These determine at the highest level a shared understanding of what the asset is. - CRM > Assets [List asset types](https://developer.commusoft.com/list-asset-types-38522862e0.md): Asset types build ontop of asset groups and further refine what the asset is. For example, if an asset is a Boiler (group) the type maybe set to Combination boiler. - CRM > Assets [Asset structure](https://developer.commusoft.com/asset-structure-27809342e0.md): - CRM > Assets [Assets dynamic fields](https://developer.commusoft.com/assets-dynamic-fields-43429859e0.md): - CRM > Assets [List assets](https://developer.commusoft.com/list-assets-27811309e0.md): - CRM > Assets [Assets](https://developer.commusoft.com/assets-42837225e0.md): - CRM > Assets [Assets](https://developer.commusoft.com/assets-38427976e0.md): - CRM > Assets [Assets](https://developer.commusoft.com/assets-38427983e0.md): - CRM > Assets [Assets](https://developer.commusoft.com/assets-38427987e0.md): - CRM > Scheduled activities [List scheduled activities](https://developer.commusoft.com/list-scheduled-activities-31575938e0.md): Scheduled activities are tasks or activities that managers/office staff need to complete. Scheduled activities can be associated with customers, opportunities or jobs. Example "Call John Smith back about his appointment". - CRM > Scheduled activities [Scheduled activities](https://developer.commusoft.com/scheduled-activities-31975704e0.md): - CRM > Scheduled activities [Scheduled activities](https://developer.commusoft.com/scheduled-activities-31979000e0.md): - CRM > Scheduled activities [Complete Scheduled Activity](https://developer.commusoft.com/complete-scheduled-activity-39110210e0.md): - CRM > Scheduled activities [Scheduled activities](https://developer.commusoft.com/scheduled-activities-31979131e0.md): - CRM [Search](https://developer.commusoft.com/search-27804038e0.md): - Sales > Opportunities [List opportunity pipelines](https://developer.commusoft.com/list-opportunity-pipelines-27674329e0.md): This returns a list of opportunity pipelines that are set to status=active. If you want to include the associated stages, then set includeStages=true. - Sales > Opportunities [List opportunity stages](https://developer.commusoft.com/list-opportunity-stages-27781293e0.md): This is a list of stages belonging to a single opportunity pipeline. - Sales > Opportunities [List opportunities](https://developer.commusoft.com/list-opportunities-27673943e0.md): - Sales > Opportunities [Opportunities](https://developer.commusoft.com/opportunities-27674353e0.md): An Opportunity record serves as the initial stage of your sales pipeline. Think of it as a "pre-job" file, a place to track a potential lead before it officially becomes a confirmed piece of work. - Sales > Opportunities [Opportunities](https://developer.commusoft.com/opportunities-27786459e0.md): - Sales > Opportunities [Opportunities](https://developer.commusoft.com/opportunities-27809268e0.md): - Sales > Opportunities [Opportunities](https://developer.commusoft.com/opportunities-31996528e0.md): - Sales > Actions [Change opportunity stage](https://developer.commusoft.com/change-opportunity-stage-36835308e0.md): - Jobs > Jobs [List job description templates](https://developer.commusoft.com/list-job-description-templates-28700025e0.md): A job description template - Jobs > Jobs [List jobs](https://developer.commusoft.com/list-jobs-24695917e0.md): - Jobs > Jobs [Jobs](https://developer.commusoft.com/jobs-24695919e0.md): - Jobs > Jobs [Jobs](https://developer.commusoft.com/jobs-24695359e0.md): - Jobs > Jobs [Jobs](https://developer.commusoft.com/jobs-31996770e0.md): In order to make status or stage changes to jobs, you will need to use seperate API's, including /jobs/{jobID}/complete and /jobs/{jobID}/changeStage - Jobs > Jobs [Jobs](https://developer.commusoft.com/jobs-32007825e0.md): - Jobs > Forms [List forms](https://developer.commusoft.com/list-forms-31706973e0.md): The forms end point will return a list of forms that have been completed against jobs. This only returns forms built inside the Custom forms setting. Legacy forms will not be returned in this API. - Jobs > Actions [Change job stage](https://developer.commusoft.com/change-job-stage-28705106e0.md): - Jobs > Actions [Put on hold](https://developer.commusoft.com/put-on-hold-28704857e0.md): Putting the job on hold is... - Jobs > Actions [Remove on hold](https://developer.commusoft.com/remove-on-hold-39270839e0.md): - Jobs > Actions [Mark as complete](https://developer.commusoft.com/mark-as-complete-31297128e0.md): - Jobs > Actions [Mark as uncompleted](https://developer.commusoft.com/mark-as-uncompleted-42415915e0.md): When a job has been marked as completed, this API will let you uncomplete it. - Jobs > Actions [Mark as free of charge](https://developer.commusoft.com/mark-as-free-of-charge-28704859e0.md): - Jobs > Actions [Mark as aborted](https://developer.commusoft.com/mark-as-aborted-28704860e0.md): - Users & Vehicles > Users [List users](https://developer.commusoft.com/list-users-27669355e0.md): - Settings [List titles](https://developer.commusoft.com/list-titles-27669337e0.md): The settings end point lists out all the contact title options, including Mr, Mrs, Miss. All records are returned - Settings [List advertising types](https://developer.commusoft.com/list-advertising-types-27671437e0.md): - Settings [List telephone types](https://developer.commusoft.com/list-telephone-types-27671332e0.md): A telephone types is a list, for example landline, mobile, fax number - Settings [List business units](https://developer.commusoft.com/list-business-units-27674224e0.md): A Business Unit is a structural tool used to segment your company into distinct branches or departments. - Settings [List user groups](https://developer.commusoft.com/list-user-groups-27674238e0.md): A user group is a reporting line that allows businesses to group technicians, visually split the schedule and report on opportunities and jobs. Examples of user groups include 'North' vs 'South'. - Settings [List provinces](https://developer.commusoft.com/list-provinces-27729564e0.md): Provinces are a list of county/states and are used when adding properties (either customers, companies or work addresses).