GeoOp Developer Portal

Job

Associations

Name	Type	Description	Value Restrictions	Access	Visible by Default	Required
`recurrence`	item	Associated item:	None	Read	No	No
`client`	item	Associated item: `client`	None	Read Write Filter Change Sort	Yes	`POST` `PUT`
`billingClient`	item	Associated item: `billingClient`	None	Read Write Filter Change Sort	Yes	No
`status`	item	Associated item: `status`	None	Read Write Filter Change Sort	Yes	`PUT`
`account`	item	Associated item: `account`	None	Read Write Filter Change	Yes	`POST` `PUT`
`createdBy`	item	Associated item: `user`	None	Read Filter	No	No
`modifiedBy`	item	Associated item: `user`	None	Read Filter	No	No
`notes`	collection	Associated item: `note`	None	Read Write Filter Change	No	No
`parts`	collection	Associated item:	None	Read Filter	No	No
`charges`	collection	Associated item:	None	Read Filter	No	No
`payments`	collection	Associated item:	None	Read Filter	No	No
`visits`	collection	Associated item: `visit`	None	Read Write Filter Change Sort	No	No
`customFields`	collection	Associated item: `customField`	None	Read Write Filter Change	No	No

Fields

Name	Type	Description	Value Restrictions	Access	Visible by Default	Required
`id`	integer		None	Read Write Sort Filter Change	Yes	`PATCH` `DELETE`
`externalId`	string	External system id. If set it must be unique within the account. Use this value to store your identifier.	None	Read Write Filter Change	No	No
`reference`	string	Default value is calculated value according to company settings.	None	Read Write Sort Filter Change	Yes	No
`startTime`	datetime	ISO 8601 date. Represents the time the jobs is scheduled to start.	None	Read Sort Filter	Yes	No
`endTime`	datetime	Timestamp in seconds since epoch. Represents the time the jobs is scheduled to end.	None	Read Sort Filter	Yes	No
`priority`	integer	Priority level for the job.	Allowed values: `1`, `2`, `3`	Read Write Sort Filter Change	Yes	No
`title`	string	Title of the Job. Brief summary of the job.	Encoding: UTF-8 Min length: 1 Max length: 100	Read Write Sort Filter Change	Yes	`POST` `PUT`
`description`	text		None	Read Write Sort Filter Change	Yes	No
`address`.`line1`	string		None	Read Write Sort Filter Change	Yes	`POST` `PUT`
`address`.`line2`	string		None	Read Write Sort Filter Change	Yes	No
`address`.`city`	string		None	Read Write Sort Filter Change	Yes	No
`address`.`state`	string		None	Read Write Sort Filter Change	Yes	No
`address`.`postcode`	string		None	Read Write Sort Filter Change	Yes	No
`address`.`latitude`	float		None	Read Write Sort Filter Change	Yes	No
`address`.`longitude`	float		None	Read Write Sort Filter Change	Yes	No
`address`.`geocodeAccuracy`	integer	Describes how the latitude and longitude were calculated. Currently an integer enumeration with legacy values - this is slated to be changed in future releases. If your application allows the user to enter lat/long, use "100" in geocodeAccuracy.	None	Read Write Sort Filter Change	No	No
`creatorId`	integer		None	Read Filter	No	No
`jobNumber`	string		None	Read Write Sort Filter Change	Yes	No
`template`	boolean		None	Read Write Sort Filter Change	No	No
`deleted`	boolean		None	Read Write Filter Change	Yes	No
`type`	field-jobtype		None	Read Sort Filter	Yes	No
`metadata`.`visitsCount`	integer		None	Read Sort Filter	Yes	No
`metadata`.`assignedVisitsCount`	integer		None	Read Sort Filter	Yes	No
`metadata`.`unassignedVisitsCount`	integer		None	Read Sort Filter	Yes	No
`metadata`.`partsCount`	integer		None	Read	Yes	No
`metadata`.`chargesCount`	integer		None	Read	Yes	No
`metadata`.`timersCount`	integer		None	Read	Yes	No
`metadata`.`notesCount`	integer		None	Read	Yes	No
`metadata`.`parcelsCount`	integer		None	Read	Yes	No
`metadata`.`paymentsCount`	integer		None	Read	Yes	No
`metadata`.`documentsCount`	integer		None	Read Filter	Yes	No
`created`	datetime		None	Read Sort Filter	Yes	No
`modified`	datetime		None	Read Sort Filter	Yes	No

GeoOP

Job

Associations

Fields