API object definitions

Client

The list endpoint (GET /Clients) returns a slim DTO with the following fields: ClientId, Name, Importuniqueid, ModifiedDt.

Field	Description
`ClientId`	Readonly System generated guid
`PhysicalLocationId`	System generated guid. Will be autoset to a new location if not supplied
`Importuniqueid`	Text unique identifier for querying matching
`Name`	Mandatory Text
`Description`	Text
`ContactFirstName`	Text
`ContactLastName`	Text
`ContactMobile`	Text
`ContactEmail`	Text
`ContactPhone`	Text
`ContactFax`	Text
`Address1`	Text
`Address2`	Text
`City`	Text
`Region`	Text
`PostCode`	Text
`Country`	Text
`IsActive`	Boolean default true
`ModifiedDt`	Readonly System set datetime
`ModifiedBy`	Readonly system set audit
`XeroId`	Readonly System set guid
`UseDefaultCredentials`	Boolean
`LastExportTime`	Readonly datetime
`ClientLocations`	JSON object. If an object is supplied it creates a location for every item supplied with the first being set as physicalLocationId. LocationName is the only mandatory field

ClientLocation

Field	Description
`LocationId`	System generated guid
`ClientId`	Readonly system generated guid
`Importuniqueid`	Text unique identifier for querying matching
`Code`	Text
`LocationName`	Mandatory Text
`LocationPhone`	Text
`ContactFullName`	Text
`ContactMobile`	Text
`ContactEmail`	Text
`Address1`	Text
`Address2`	Text
`City`	Text
`Region`	Text
`PostCode`	Text
`Country`	Text
`IsActive`	Boolean default true
`ModifiedDt`	Readonly System set datetime
`ModifiedBy`	Readonly system set audit
`InspectionIntervalId`	Readonly Int (if interval is overridden)
`AssignedBranch`	Readonly BranchID
`LocationInstructions`	Text
`Notes`	Text
`SalesPersonGuid`	Readonly Guid
`SalesPersonEmail`	Text
`InspectorGuid`	Readonly Guid
`TravelTime`	Int
`Duration`	Int
`CustomImportField1`	Text
`CustomImportField2`	Text
`BillingType`	Text
`Client_importUniqueId`	Set only unique ID for supplying importuniqueID for client on PUT (instead of the ClientID). Not populated on GET.

Equipment

The list endpoint (GET /Equipment) returns a slim DTO with the following fields: EquipmentGuid, SerialNumber, Description, Location, ClientReference, Barcode, ClientLocationId, EquipmentTypeId, LastInspectionDate, NextScheduledDate, ModifiedDt, Passed, Failed, Missed, IsActive.

Field	Description
`EquipmentGuid`	System generated guid
`SerialNumber`	Mandatory Text
`ClientId`	Mandatory GUID
`Importuniqueid`	Text unique identifier for querying matching
`EquipmentTypeId`	Int
`EquipmentType`	Readonly Text (equipment type description)
`Description`	Text
`Location`	Text
`LastInspectionDate`	Datetime
`GroupGuid`	Guid
`IsActive`	Boolean default true
`InspectionIntervalId`	Int
`ClientReference`	Text
`Make`	Text
`Model`	Text
`Barcode`	Text
`WarrantyBegin`	Datetime
`WarrantyEnd`	Datetime
`ModifiedDt`	Readonly System set datetime
`ModifiedBy`	Readonly system set audit
`Comment`	Text
`Passed`	Boolean
`Failed`	Boolean
`Missed`	Boolean
`StatusId`	Int
`ClientLocationId`	Mandatory Guid
`NextScheduledDate`	Readonly Datetime
`SearchText`	Text
`CustomerAcceptanceName`	Text
`CustomerAcceptanceDate`	Datetime
`AuthorisingWorkerId`	Guid
`InspectionHistory`	Text
`Serial2`	Text
`StatusLookupGuid`	Guid
`AreaGuid`	Guid
`PostponeDate`	Datetime
`CertificateNumber`	Text
`Building`	Text
`PreviousLocation`	Text
`ClientName`	Readonly Text
`Client_importUniqueId`	Set only unique ID for supplying importuniqueID for client on PUT (instead of the ClientID). Not populated on GET.
`Attachments`	Readonly JSON object
`EquipmentDetails`	JSON array of equipment detail attributes. Each item contains `equipmentDetailId` (guid), `value` (text), and `attributeName` (text).

Inspection

The list endpoint (GET /Inspections) returns a slim DTO with the following fields: InspectionGuid, DateCreated, JobGuid, EquipmentGuid, IsActive, ModifiedDt, ModifiedBy, WorkerId.

Field	Description
`InspectionGuid`	System generated guid
`DateCreated`	Date
`JobGuid`	Job Guid
`EquipmentGuid`	Equipment Guid
`AuthorisingWorkerId`	Authorising Worker Guid
`InspectionTemplateId`	Int
`TestSpecification`	Text
`Notes`	Text
`CertNo`	Text
`IsActive`	Boolean (Ignored on create)
`ModifiedDt`	Readonly DateTime
`ModifiedBy`	Readonly Text
`WorkerId`	Worker Guid
`Comment`	Text
`Passed`	Boolean
`Failed`	Boolean
`Missed`	Boolean
`InspectionInterval`	Int
`CustomerAcceptanceName`	Text
`CustomerAcceptanceDate`	Datetime
`NextInspectionDate`	Datetime
`StatusLookupGuid`	Status Lookup Guid
`Importuniqueid`	Text unique identifier for querying matching
`Equipment_importUniqueId`	Unique ID for supplying importuniqueID for equipment on PUT (instead of the EquipmentGuid).
`InspectionComponentResults`	JSON array of component results. Each item contains `inspectionComponentResultId` (guid), `section`, `description`, `value`, and optional `section2`, `description2`, `value2` for secondary language support.

Jobs

Field	Description
`JobGuid`	System generated guid
`Importuniqueid`	Text unique identifier for querying matching
`Clientid`	Mandatory GUID (or can use client_importUniqueId)
`ClientLocationId`	Mandatory GUID (or can use clientLocation_importUniqueId)
`BranchGuid`	GUID for Branch
`StatusId`	Int
`SubStatusId`	Int
`JobNumber`	Int. Either autonumber or manual set depending on site setup.
`CustomerRef`	Text
`StartTime`	Mandatory Datetime
`ContactFullName`	Text
`Mobile`	Text
`Email`	Text
`Phone`	Text
`Address1`	Text
`Address2`	Text
`City`	Text
`Region`	Text
`PostCode`	Text
`Country`	Text
`DueDate`	DateTime
`Notes`	Text
`EndTime`	DateTime
`Hours`	Decimal
`StartTimeActual`	DateTime
`EndTimeActual`	DateTime
`IsComplete`	Boolean
`IsActive`	Boolean (Ignored on create)
`CreatedBy`	Readonly Text
`CreatedDt`	Readonly DateTime
`ModifiedBy`	Readonly Text
`ModifiedDt`	Readonly DateTime
`Recurring`	Readonly Boolean
`NotifyClient`	Boolean
`NotifyTechnician`	Boolean
`ClientNotified`	Readonly Boolean
`TechnicianNotified`	Readonly Boolean
`ClientEmailAddress`	Text
`ClientEmailText`	Text
`CompleteNotificationSentDate`	Readonly DateTime
`ApprovedBy`	Guid of user
`CompletedBy`	Guid of user
`CompletedDate`	DateTime
`ExtraFields`	Text
`VcSubject`	Text
`AuthorisedUtcdate`	DateTime
`LastProcessedDate`	DateTime
`Apinotes`	Text
`ApprovalEmailSent`	Readonly Boolean
`JobWorkers`	JSON Object of worker emails. Example: `"jobWorkers": [{"WorkerEmail": "worker1@domain.com"}, {"WorkerEmail": "worker2@domain.com"}]`
`Client_importUniqueId`	Unique ID for supplying importuniqueID for client on PUT (instead of the ClientID).
`ClientLocation_importUniqueId`	Unique ID for supplying importuniqueID for client location on PUT (instead of the ClientLocationID).
`Branch_importUniqueId`	Unique ID for supplying importuniqueID for branch on PUT (instead of the BranchGuid).

ServiceRecord

The list endpoint (GET /ServiceRecords) returns a slim DTO with the following fields: ServiceRecordGuid, JobGuid, DateOfRecord, ModifiedDt, IsActive.

Field	Description
`ServiceRecordGuid`	System generated guid
`JobGuid`	Job Guid
`Kms`	Int
`DateOfRecord`	DateTime
`TimeArrivedOnSite`	DateTime
`DepartureTimeFromSite`	DateTime
`Notes`	Text
`IsActive`	Boolean
`ModifiedDt`	Readonly DateTime
`ModifiedBy`	Readonly Text
`UserId`	Guid
`ServiceRecordEquipments`	JSON array of equipment items associated with the service record.