Commusoft · Schema

Customer

A customer record in the Commusoft field service management platform

Field Service ManagementJob ManagementHVACPlumbingTradesSchedulingInvoicingEngineersCustomersService History

Properties

Name	Type	Description
id	integer	Internal numeric ID
uuid	string	Universally unique identifier for the customer
title	string	Title (Mr, Mrs, Dr, etc.)
firstName	string	Customer first name
lastName	string	Customer last name
companyName	string	Company name for business customers
email	string	Primary email address
telephone	string	Primary telephone number
mobile	string	Mobile telephone number
address	object
propertyDetails	object
accountingSettings	object
deleted	integer	Soft-delete flag; 1 indicates the record has been deleted
createdAt	string
updatedAt	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/commusoft/json-schema/customer.json",
  "title": "Customer",
  "description": "A customer record in the Commusoft field service management platform",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Internal numeric ID",
      "readOnly": true
    },
    "uuid": {
      "type": "string",
      "format": "uuid",
      "description": "Universally unique identifier for the customer",
      "readOnly": true
    },
    "title": {
      "type": "string",
      "description": "Title (Mr, Mrs, Dr, etc.)"
    },
    "firstName": {
      "type": "string",
      "description": "Customer first name"
    },
    "lastName": {
      "type": "string",
      "description": "Customer last name"
    },
    "companyName": {
      "type": "string",
      "description": "Company name for business customers"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Primary email address"
    },
    "telephone": {
      "type": "string",
      "description": "Primary telephone number"
    },
    "mobile": {
      "type": "string",
      "description": "Mobile telephone number"
    },
    "address": {
      "$ref": "address.json"
    },
    "propertyDetails": {
      "$ref": "property-details.json"
    },
    "accountingSettings": {
      "$ref": "accounting-settings.json"
    },
    "deleted": {
      "type": "integer",
      "enum": [0, 1],
      "description": "Soft-delete flag; 1 indicates the record has been deleted",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "required": ["uuid", "lastName"]
}