KC (Preview)

KC Practice Management enables secure access to client and business data, allowing users to retrieve and manage information efficiently through automated workflows.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Kloud Connect Support
URL	https://www.kloudconnect.com.au/
Email	support@kloudconnect.com.au

Connector Metadata
Publisher	Kloud Connect
Website	https://www.kloudconnect.com.au/
Privacy policy	https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf
Categories	Business Management;Finance

Kloud Connect Practice Management

Overview

This provides access to Kloud Connect Practice Management APIs.

Features

List clients
Create Clients
List Contacts
Create Contacts
List invoices
Create Timesheet
List Tasks
Create Tasks
List Jobs
Create Jobs
Access practice management data

Authentication

OAuth 2.0 via Kloud Connect Identity Server

Support

support@kloudconnect.com.au

Actions

Create client	Creates a client.
Create client group	Creates a client group.
Create job	Creates a workflow job.
Get client by ID	Returns details for a client by ID.
get Client Groups	get Client Groups
Get custom fields by context	Returns custom fields for the specified context.
Get debtor client mapping	Returns debtor client mapping for a client.
List client relationships	Returns a paged list of client relationships.
List client tags	Returns the available client tags.
List clients	Returns a paged list of clients.
List contacts	Returns a paged list of contacts.
List divisions	Returns a paged list of divisions.
List invoices	Returns a paged list of invoices.
List job priorities	Returns the available workflow job priorities.
List job templates	Returns the available workflow job templates.
List job type statuses	Returns the available workflow job type statuses.
List job types	Returns the available workflow job types.
List jobs	Returns a paged list of workflow jobs.
List non-billable time types	Returns the available non-billable timesheet types.
List teams	Returns the available teams.
List users	Returns a paged list of users.
Log time	Creates a timesheet time entry.
Update client by ID	Updates a client by ID.
Update client group	Updates a client group by group code.
Update contact	Updates a contact by ID.
Update job	Updates a workflow job by ID.
Update job status and priority	Updates the status and priority for workflow jobs.

Create client

Operation ID:: createClients

Creates a client.

Parameters

Name	Key	Required	Type
entityType	entityType	True	string
clientCode	clientCode	True	string
salutation	salutation		string
firstName	firstName		string
middleName	middleName		string
lastName	lastName		string
trustName	trustName		string
trustType	trustType		string
companyName	companyName		string
tradingName	tradingName		string
partnershipName	partnershipName		string
smsfName	smsfName		string
softwareType	softwareType		string
softwareName	softwareName		string
partnerId	partnerId	True	string
managerId	managerId		string
divisionId	divisionId	True	integer
prospect	prospect		boolean
preferredName	preferredName		string
dateofbirth	dateofbirth		date-time
placeOfBirth	placeOfBirth		string
gender	gender		string
type	type		string
email	email		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
type	type		string
number	number		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
linkedInProfileId	linkedInProfileId		string
website	website		string
annualReviewDate	annualReviewDate		date-time
formationDate	formationDate		date-time
addressType	addressType		string
unit	unit		string
careOf	careOf		string
addressLine1	addressLine1		string
addressLine2	addressLine2		string
suburb	suburb		string
state	state		string
country	country		string
postCode	postCode		string
industry	industry		string
role	role		string
salary	salary		string
annualIncome	annualIncome		string
isTaxClient	isTaxClient		boolean
isLodgeActivity	isLodgeActivity		boolean
tfn	tfn		integer
abn	abn		integer
acn	acn		integer
din	din		integer
taxAgent	taxAgent		string
gst	gst		boolean
resident	resident		boolean
bankName	bankName		string
bankAccountName	bankAccountName		string
bankBSB	bankBSB		integer
bankAccountNumber	bankAccountNumber		integer
contactId	contactId		integer
contactType	contactType		string
id	id		integer
value	value		string
enumEntityTypes	enumEntityTypes		string
enumTrustTypes	enumTrustTypes		string
enumGender	enumGender		string
enumEmailTypes	enumEmailTypes		string
enumPhoneTypes	enumPhoneTypes		string
enumContactTypes	enumContactTypes		string
enumAddressTypes	enumAddressTypes		string

Create client group

Operation ID:: createClientGroup

Creates a client group.

Parameters

Name	Key	Type
groupName	groupName	string
partnerId	partnerId	string
tags	tags	array of integer
clientId	clientId	integer
isDebitorClient	isDebitorClient	boolean
relationIds	relationIds	array of integer
contactId	contactId	integer

Create job

Operation ID:: createJobs

Creates a workflow job.

Parameters

Name	Key	Type
clientId	clientId	integer
divisionId	divisionId	integer
debtorclientId	debtorclientId	integer
jobTypeId	jobTypeId	integer
jobCategory	jobCategory	string
jobName	jobName	string
financialYear	financialYear	integer
templateId	templateId	integer
managerId	managerId	string
partnerId	partnerId	string
startDate	startDate	date-time
dueDate	dueDate	date-time
estimateType	estimateType	string
priority	priority	string
description	description	string
billingMethod	billingMethod	string
teamId	teamId	integer
quoteAmount	quoteAmount	double
statusId	statusId	integer
id	id	integer
value	value	string
enumJobCategoryTypes	enumJobCategoryTypes	string
enumEstimateTypes	enumEstimateTypes	string
enumBillingMethods	enumBillingMethods	string
enumPriorityTypes	enumPriorityTypes	string

Get client by ID

Operation ID:: getAClient

Returns details for a client by ID.

Parameters

Name	Key	Required	Type	Description
Client ID	clientId	True	integer	Client identifier.
Custom fields	isCustomField		boolean	Include custom fields.

Returns

Body: ClientDetails_Result

get Client Groups

Operation ID:: getClientGroups

get Client Groups

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of client groups to return per page.
Group code	groupCode	string	Filter client groups by group code.

Returns

Name	Path	Type	Description
clientGroups	clientGroups	array of object	clientGroups
groupId	clientGroups.groupId	integer	groupId
groupCode	clientGroups.groupCode	string	groupCode
groupName	clientGroups.groupName	string	groupName
contact	clientGroups.contact	string	contact
tags	clientGroups.tags	array of	tags
clients	clientGroups.clients	array of object	clients
clientId	clientGroups.clients.clientId	integer	clientId
entityType	clientGroups.clients.entityType	string	entityType
clientname	clientGroups.clients.clientname	string	clientname
isDebtorClient	clientGroups.clients.isDebtorClient	boolean	isDebtorClient
debtorClientId	clientGroups.clients.debtorClientId	integer	debtorClientId
createdBY	clientGroups.createdBY	string	createdBY
created	clientGroups.created	string	created
lastmodified	clientGroups.lastmodified	string	lastmodified
total_records	pagination.total_records	integer	total_records
current_page	pagination.current_page	integer	current_page
page_Size	pagination.page_Size	integer	page_Size
total_pages	pagination.total_pages	integer	total_pages
next_page	pagination.next_page	integer	next_page
next_pageurl	pagination.next_pageurl	string	next_pageurl
	pagination.prev_page	integer	prev_page
prev_pageurl	pagination.prev_pageurl	string	prev_pageurl

Get custom fields by context

Operation ID:: getFirmCustomfields

Returns custom fields for the specified context.

Parameters

Name	Key	Required	Type	Description
Context	context	True	string	Custom fields context.

Get debtor client mapping

Operation ID:: getClientsDebtor

Returns debtor client mapping for a client.

Parameters

Name	Key	Required	Type	Description
Client ID	clientId	True	integer	Client identifier.

Returns

Body: ClientDebtor

List client relationships

Operation ID:: getClientRelationships

Returns a paged list of client relationships.

Parameters

Name	Key	Required	Type	Description
Client ID	clientId	True	integer	Client identifier.
Page	page		integer	Results page number.
Page size	pageSize		integer	Number of relationships to return per page.

Returns

Body: Relationships_Result

List client tags

Operation ID:: getClientsTags

Returns the available client tags.

List clients

Operation ID:: getClients

Returns a paged list of clients.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number (1-based).
Page size	pageSize	integer	Number of items per page.
Partner ID	partnerId	string	Filter by partner identifier.
Debit client	isDebitClient	boolean	Filter by debit-client flag.
Modified since	modifiedSince	string	Return clients modified on/after this timestamp (ISO 8601).
Group code	groupCode	string	Filter by group code.
Client ID	clientId	integer	Filter by client ID.
Custom fields	isCustomField	boolean	Include custom fields.

Returns

Body: Client_Result

List contacts

Operation ID:: getContacts

Returns a paged list of contacts.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of contacts to return per page.
Modified since	modifiedSince	string	Return contacts modified on or after this timestamp.
Contact ID	contactId	integer	Filter contacts by contact identifier.
Client ID filter	isClientId	boolean	Indicates whether the contact ID filter should be treated as a client ID.
Custom fields	isCustomField	boolean	Include custom fields in the contact results.

Returns

Body: Contact_Result

List divisions

Operation ID:: getDivisions

Returns a paged list of divisions.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of divisions to return per page.
Modified since	modifiedSince	string	Return divisions modified on or after this timestamp.

Returns

Body: Divisions_Result

List invoices

Operation ID:: getInvoices

Returns a paged list of invoices.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of invoices to return per page.
Draft invoice	isDraftInvoice	boolean	Filter invoices by draft invoice flag.
Include invoice details	includeInvoiceDetails	boolean	Include invoice detail records in the response.
Status	status	string	Filter invoices by status.
Modified since	modifiedSince	string	Return invoices modified on or after this timestamp.
Debit client	isDebitClient	boolean	Filter invoices by debit client flag.
Client name	clientname	string	Filter invoices by client name.
Client code	clientcode	string	Filter invoices by client code.
Job name	jobname	string	Filter invoices by job name.
Job code	jobcode	string	Filter invoices by job code.
Billing entity ID	billingEntityId	string	Filter invoices by billing entity identifier.

Returns

Body: InvoiceDetail_Result

List job priorities

Operation ID:: getJobPriorities

Returns the available workflow job priorities.

Returns

Body: JobPriorityValues

List job templates

Operation ID:: getJobTemplates

Returns the available workflow job templates.

Returns

Body: JobTemplate

List job type statuses

Operation ID:: getJobTypeStatus

Returns the available workflow job type statuses.

Returns

Body: JobTypeStatus

List job types

Operation ID:: getJobTypes

Returns the available workflow job types.

Returns

Body: JobType

List jobs

Operation ID:: getJobs

Returns a paged list of workflow jobs.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of jobs to return per page.
Partner ID	partnerId	string	Filter jobs by partner identifier.
Client name	clientName	string	Filter jobs by client name.
Client code	clientcode	string	Filter jobs by client code.
Modified since	modifiedSince	string	Return jobs modified on or after this timestamp.
Debit client	isDebitClient	boolean	Filter jobs by debit client flag.
Custom fields	isCustomField	boolean	Include custom fields in the job results.

Returns

Body: Jobs_Result

List non-billable time types

Operation ID:: getNonBillableTimesheetTypes

Returns the available non-billable timesheet types.

List teams

Operation ID:: getTeams

Returns the available teams.

Returns

Body: Teams

List users

Operation ID:: getUsers

Returns a paged list of users.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number.
Page size	pageSize	integer	Number of users to return per page.
Modified since	modifiedSince	string	Return users modified on or after this timestamp.
Role name	rolename	string	Filter users by role name.

Returns

Body: Users_Result

Log time

Operation ID:: createTimesheet

Creates a timesheet time entry.

Parameters

Name	Key	Type
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
units	units	double
starttime	starttime	string
rate	rate	double
description	description	string

Update client by ID

Operation ID:: updateAClient

Updates a client by ID.

Parameters

Name	Key	Required	Type	Description
Client ID	clientId	True	integer	Client identifier.
entityType	entityType	True	string
clientCode	clientCode	True	string
salutation	salutation		string
firstName	firstName		string
middleName	middleName		string
lastName	lastName		string
trustName	trustName		string
trustType	trustType		string
companyName	companyName		string
tradingName	tradingName		string
partnershipName	partnershipName		string
smsfName	smsfName		string
softwareType	softwareType		string
softwareName	softwareName		string
partnerId	partnerId	True	string
managerId	managerId		string
divisionId	divisionId	True	integer
prospect	prospect		boolean
preferredName	preferredName		string
dateofbirth	dateofbirth		date-time
placeOfBirth	placeOfBirth		string
gender	gender		string
type	type		string
email	email		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
type	type		string
number	number		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
linkedInProfileId	linkedInProfileId		string
website	website		string
annualReviewDate	annualReviewDate		date-time
formationDate	formationDate		date-time
addressType	addressType		string
unit	unit		string
careOf	careOf		string
addressLine1	addressLine1		string
addressLine2	addressLine2		string
suburb	suburb		string
state	state		string
country	country		string
postCode	postCode		string
industry	industry		string
role	role		string
salary	salary		string
annualIncome	annualIncome		string
isTaxClient	isTaxClient		boolean
isLodgeActivity	isLodgeActivity		boolean
tfn	tfn		integer
abn	abn		integer
acn	acn		integer
din	din		integer
taxAgent	taxAgent		string
gst	gst		boolean
resident	resident		boolean
bankName	bankName		string
bankAccountName	bankAccountName		string
bankBSB	bankBSB		integer
bankAccountNumber	bankAccountNumber		integer
contactId	contactId		integer
contactType	contactType		string
id	id		integer
value	value		string
enumEntityTypes	enumEntityTypes		string
enumTrustTypes	enumTrustTypes		string
enumGender	enumGender		string
enumEmailTypes	enumEmailTypes		string
enumPhoneTypes	enumPhoneTypes		string
enumContactTypes	enumContactTypes		string
enumAddressTypes	enumAddressTypes		string

Update client group

Operation ID:: updateClientGroup

Updates a client group by group code.

Parameters

Name	Key	Required	Type	Description
Group code	groupCode	True	string	Client group code.
groupName	groupName		string
partnerId	partnerId		string
tags	tags		array of integer
clientId	clientId		integer
isDebitorClient	isDebitorClient		boolean
relationIds	relationIds		array of integer
contactId	contactId		integer

Update contact

Operation ID:: updateAContact

Updates a contact by ID.

Parameters

Name	Key	Required	Type	Description
Contact ID	contactId	True	integer	Contact identifier.
salutation	salutation		string
firstName	firstName	True	string
middleName	middleName		string
lastName	lastName	True	string
gender	gender		string
type	type		string
number	number		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
type	type		string
email	email		string
favourite	favourite		boolean
feeSynergy	feeSynergy		boolean
companyName	companyName		string
placeOfBirth	placeOfBirth		string
linkedInProfileID	linkedInProfileID		string
preferredName	preferredName		string
din	din		string
dateOfBirth	dateOfBirth		date-time
isImportent	isImportent		boolean
addressType	addressType		string
unit	unit		string
careOf	careOf		string
addressLine1	addressLine1		string
addressLine2	addressLine2		string
suburb	suburb		string
state	state		string
country	country		string
postCode	postCode		string
id	id		integer
value	value		string
enumAddressTypes	enumAddressTypes		string

Update job

Operation ID:: updateAJob

Updates a workflow job by ID.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.
clientId	clientId		integer
divisionId	divisionId		integer
debtorclientId	debtorclientId		integer
jobTypeId	jobTypeId		integer
jobCategory	jobCategory		string
jobName	jobName		string
financialYear	financialYear		integer
templateId	templateId		integer
managerId	managerId		string
partnerId	partnerId		string
startDate	startDate		date-time
dueDate	dueDate		date-time
estimateType	estimateType		string
priority	priority		string
description	description		string
billingMethod	billingMethod		string
teamId	teamId		integer
quoteAmount	quoteAmount		double
statusId	statusId		integer
id	id		integer
value	value		string
enumJobCategoryTypes	enumJobCategoryTypes		string
enumEstimateTypes	enumEstimateTypes		string
enumBillingMethods	enumBillingMethods		string
enumPriorityTypes	enumPriorityTypes		string

Update job status and priority

Operation ID:: updateJobStatuses

Updates the status and priority for workflow jobs.

Parameters

Name	Key	Type
jobId	jobId	integer
priority	priority	string
status	status	string
statusOwner	statusOwner	string

Definitions

Address

Name	Path	Type
addressType	addressType	string
unit	unit	string
careOf	careOf	string
addressLine1	addressLine1	string
addressLine2	addressLine2	string
suburb	suburb	string
state	state	string
country	country	string
postCode	postCode	string

Client

Name	Path	Type
code	code	string
salutation	salutation	string
name	name	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
preferredName	preferredName	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
division	division	Division
entityType	entityType	string
partner	partner	Staff
manager	manager	Staff
contacts	contacts	array of Contact
addresses	addresses	array of Address
acn	acn	string
abn	abn	string
tfn	tfn	string
gstRegistered	gstRegistered	boolean
taxClient	taxClient	boolean
created	created	string
lastModified	lastModified	string
wip	wip	string
location	location	string
status	status	string
group	group	Group
debtorClient	debtorClient	string
clientBrefcode	clientBrefcode	string
billercode	billercode	string
id	id	integer
customFields	customFields	array of CustomField

ClientDebtor

Name	Path	Type
debtorid	debtorid	integer
debtorname	debtorname	string
groupCode	groupCode	string
clientid	clientid	integer
clientType	clientType	string
isSeflDebtor	isSeflDebtor	boolean

ClientDetails

Name	Path	Type
code	code	string
salutation	salutation	string
name	name	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
preferredName	preferredName	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
division	division	Division
entityType	entityType	string
partner	partner	Staff
manager	manager	Staff
contacts	contacts	array of Contact
addresses	addresses	array of Address
acn	acn	string
abn	abn	string
gstRegistered	gstRegistered	boolean
taxClient	taxClient	boolean
created	created	string
lastModified	lastModified	string
wip	wip	string
location	location	string
status	status	string
group	group	Group
debtorClient	debtorClient	string
clientBrefcode	clientBrefcode	string
billercode	billercode	string
id	id	integer
customFields	customFields	array of CustomField
din	din	string
tfn	tfn	string
bankName	bankName	string
bankAccountName	bankAccountName	string
bankBSB	bankBSB	string
bankAccountNumber	bankAccountNumber	string

ClientDetails_Result

Name	Path	Type	Description
client	client	array of ClientDetails

ClientSummary

Name	Path	Type
id	id	integer
code	code	string
name	name	string

Client_Result

Name	Path	Type	Description
clients	clients	array of Client
pagination	pagination	Pagination

Contact

Name	Path	Type
id	id	integer
firstName	firstName	string
lastName	lastName	string
preferredName	preferredName	string
contactType	contactType	string
email	email	array of Email
phone	phone	array of Phone

ContactEntity

Name	Path	Type
salutation	salutation	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
gender	gender	string
phone	phone	array of Phone
email	email	array of Email
companyName	companyName	string
placeOfBirth	placeOfBirth	string
linkedInProfileID	linkedInProfileID	string
preferredName	preferredName	string
din	din	string
contactId	contactId	integer
dateOfBirth	dateOfBirth	string
created	created	string
lastModified	lastModified	string
addresses	addresses	array of Address
name	name	string
location	location	string
context	context	string
customFields	customFields	array of CustomField

Contact_Result

Name	Path	Type	Description
contacts	contacts	array of ContactEntity
pagination	pagination	Pagination

CustomField

Name	Path	Type	Description
id	id	integer
value	value	string

DebtorClient

Name	Path	Type
id	id	integer
code	code	string
name	name	string

Division

Name	Path	Type	Description
id	id	integer
name	name	string

DivisionWithDetails

Name	Path	Type
id	id	integer
name	name	string
billingEntityName	billingEntityName	string
billingEntityId	billingEntityId	string
lastModifiedAt	lastModifiedAt	string

Divisionext

Name	Path	Type
id	id	integer
name	name	string
billingEntityName	billingEntityName	string
billingEntityId	billingEntityId	string
lastModifiedAt	lastModifiedAt	string
lastModifiedBy	lastModifiedBy	string
created	created	string

Divisions_Result

Name	Path	Type	Description
divisions	divisions	array of Divisionext
pagination	pagination	Pagination

Email

Name	Path	Type
type	type	string
email	email	string
favourite	favourite	boolean
feeSynergy	feeSynergy	boolean

Group

Name	Path	Type
id	id	integer
code	code	string
name	name	string

GroupMember

Name	Path	Type
groupId	groupId	integer
memberId	memberId	string
name	name	string
roleName	roleName	string

InvoiceDetail_Result

Name	Path	Type	Description
invoices	invoices	array of InvoiceDetails
pagination	pagination	Pagination

InvoiceDetails

Name	Path	Type
id	id	integer
number	number	string
refNo	refNo	string
type	type	string
date	date	string
due	due	string
totalPayable	totalPayable	double
gst	gst	double
payment	payment	double
creditNote	creditNote	double
balance	balance	double
status	status	string
debtorClientId	debtorClientId	integer
debtorClientCode	debtorClientCode	string
debtorClientName	debtorClientName	string
debtorBrefcode	debtorBrefcode	string
billercode	billercode	string
invoiceLines	invoiceLines	array of InvoiceLines
invoiceJobs	invoiceJobs	array of JobInvoice
created	created	string
lastModified	lastModified	string

InvoiceLines

Name	Path	Type
id	id	integer
lineNumber	lineNumber	integer
lineDescription	lineDescription	string
lineTotal	lineTotal	double

JobInvoice

Name	Path	Type
id	id	integer
jobcode	jobcode	string
name	name	string
wip	wip	double
client	client	ClientSummary
financialYear	financialYear	string
partner	partner	Staff
manager	manager	Staff
division	division	DivisionWithDetails
created	created	string
lastModified	lastModified	string
debtorClient	debtorClient	string
invoiceid	invoiceid	integer

JobPriorityValues

Name	Path	Type	Description
jobPriorityId	jobPriorityId	integer
jobPriorityName	jobPriorityName	string

JobTemplate

Name	Path	Type
templateId	templateId	integer
templateName	templateName	string
description	description	string
estimateType	estimateType	string
turnaround	turnaround	integer
created	created	string
lastModified	lastModified	string

JobType

Name	Path	Type
jobTypeId	jobTypeId	integer
jobTypeName	jobTypeName	string
description	description	string
divisionId	divisionId	integer
created	created	string
lastModified	lastModified	string

JobTypeStatus

Name	Path	Type
jobTypeId	jobTypeId	integer
statusId	statusId	integer
statusName	statusName	string
categoryId	categoryId	integer
categoryName	categoryName	string

Jobdetail

Name	Path	Type
id	id	integer
jobCode	jobCode	string
jobType	jobType	string
name	name	string
priority	priority	string
dueDate	dueDate	string
estimatedTime	estimatedTime	double
wip	wip	double
client	client	ClientSummary
financialYear	financialYear	string
partner	partner	Staff
manager	manager	Staff
division	division	DivisionWithDetails
created	created	string
lastModified	lastModified	string
debtorClient	debtorClient	DebtorClient
status	status	string
statusCategory	statusCategory	string
statusOwner	statusOwner	UserDetail
completedTask	completedTask	integer
totalTask	totalTask	integer
tasks	tasks	array of TaskDetail
assignees	assignees	array of UserDetail
team	team	TaskDetail
customFields	customFields	array of CustomField

Jobs_Result

Name	Path	Type	Description
jobs	jobs	array of Jobdetail
pagination	pagination	Pagination

Pagination

Name	Path	Type
total_records	total_records	integer
current_page	current_page	integer
page_Size	page_Size	integer
total_pages	total_pages	integer
next_page	next_page	integer
next_pageurl	next_pageurl	string
prev_page	prev_page	integer
prev_pageurl	prev_pageurl	string

Phone

Name	Path	Type
type	type	string
number	number	string
favourite	favourite	boolean
feeSynergy	feeSynergy	boolean

Relationship

Name	Path	Type
relationshipId	relationshipId	string
type	type	string
entityId	entityId	string
name	name	string
entity	entity	string
startDate	startDate	string
endDate	endDate	string
units	units	integer

Relationships_Result

Name	Path	Type	Description
relationships	relationships	array of Relationship
pagination	pagination	Pagination

Staff

Name	Path	Type
id	id	string
name	name	string
email	email	string

TaskDetail

Name	Path	Type	Description
id	id	integer
name	name	string

Teams

Name	Path	Type
groupId	groupId	integer
teamId	teamId	integer
name	name	string
groupMembers	groupMembers	array of GroupMember

UserDetail

Name	Path	Type	Description
id	id	string
name	name	string

UsersWithDetails

Name	Path	Type
id	id	string
name	name	string
roleName	roleName	string
email	email	Email
firstName	firstName	string
lastName	lastName	string
phone	phone	Phone
address	address	Address
created	created	string
lastModified	lastModified	string

Users_Result

Name	Path	Type	Description
users	users	array of UsersWithDetails
pagination	pagination	Pagination