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 connector provides access to Kloud Connect Practice Management APIs, so clients, contacts, jobs, tasks, timesheets and invoices can be read and managed from Power Automate, Power Apps and Copilot Studio.

Features

Clients: list, get, create and update clients; client groups; tags; relationships; debtor clients; salutations, titles, industries and communication contacts
Contacts: list, create and update contacts
Divisions: list divisions
Invoices: list invoices and tax types
Jobs: list, get, create and update jobs; update job status and priority; job task groups and tasks
Tasks: list tasks; create and update job tasks; task types
Job templates: list, create and update templates, template task groups and template tasks
Timesheets: log time (up to 20 entries per request), list timesheet entries and non-billable time types
Users: list users, teams and roles; partners and managers for clients and jobs
Settings and lookups: custom fields, job types and statuses, job priorities, job status categories, email types, phone types and countries

What's new in this update

Added operations for creating contacts, job and template task groups, job tasks, task types, job templates, job types, job priorities and non-billable time types
Added operations for listing timesheet entries, tasks, roles, tax types, salutations, titles, industries, countries, email types and phone types
Added client communication contacts, clients available for grouping and contacts available for clients
Write operations now describe their response (ID, status, message and date)

Breaking changes

Update job status and priority (updateJobStatuses) is replaced by updateJobStatus, which now takes the job ID as an input
Log time (createTimesheet) now accepts a list of up to 20 time entries instead of a single entry
List job types, job templates, job priorities and job type statuses now return lists, and use the /v1/settings/workflows endpoints
List teams and get debtor client mapping now return lists

Limitations

Document management operations (folders, files and sites) are not part of this connector

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 contact	Creates a contact.
Create job	Creates a workflow job.
Create job priority	Creates a workflow job priority.
Create job task	Creates a task in a job task group.
Create job task group	Creates a task group on a workflow job.
Create job template	Creates a workflow job template.
Create job type	Creates a job type with its statuses.
Create non-billable time type	Creates a non-billable timesheet type.
Create task type	Creates a task type.
Create template task	Creates a task in a job template task group.
Create template task group	Creates a task group in a job template.
Get client by ID	Returns the details of a client.
Get custom fields by context	Returns the custom fields defined for a context: client, contact, job or all.
Get debtor client mapping	Returns the debtor clients mapped to a client.
Get job by ID	Returns the details of a workflow job.
List client groups	Returns a paged list of client groups and their member clients.
List client managers	Returns the users that can be selected as manager on a client.
List client partners	Returns the users that can be selected as partner on a client.
List client relationships	Returns a paged list of relationships for a client.
List client tags	Returns the available client tags.
List clients	Returns a paged list of clients.
List clients available for grouping	Returns the clients that can be added to a client group.
List communication contacts	Returns a paged list of client communication contact details.
List contacts	Returns a paged list of contacts.
List contacts available for clients	Returns the contacts that can be linked to a client.
List countries	Returns the available countries.
List divisions	Returns a paged list of divisions.
List email types	Returns the available email types.
List industries	Returns the industry names that can be assigned to a client.
List invoices	Returns a paged list of invoices.
List job managers	Returns the users that can be selected as manager on a job.
List job partners	Returns the users that can be selected as partner on a job.
List job priorities	Returns the available workflow job priorities.
List job status categories	Returns the available job status categories.
List job task group tasks	Returns the tasks in a task group of a workflow job.
List job task groups	Returns the task groups of a workflow job.
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 phone types	Returns the available phone types.
List roles	Returns the available user roles.
List salutations	Returns the salutations available for clients and contacts.
List tasks	Returns a paged list of job tasks.
List tax types	Returns the tax types available for invoices.
List teams	Returns the available teams.
List template task group tasks	Returns a task group and its tasks for a job template.
List template task groups	Returns the task groups and tasks of a job template.
List timesheet entries	Returns a paged list of timesheet time entries.
List titles	Returns the titles available for clients and contacts.
List users	Returns a paged list of users.
Log time	Creates one or more timesheet time entries (up to 20 per request).
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 priority	Renames a workflow job priority.
Update job status and priority	Updates the status and priority of a workflow job.
Update job task	Updates a task in a job task group.
Update job task group	Renames a task group on a workflow job.
Update job template	Updates a workflow job template by ID.
Update job type	Updates a job type by ID.
Update job type statuses	Updates the statuses of a job type.
Update non-billable time type	Updates a non-billable timesheet type by ID.
Update task type	Updates a task type by ID.
Update template task	Updates a task in a job template task group.
Update template task group	Renames a task group in a job template.

Create client

Operation ID:: createClients

Creates a client.

Parameters

Name	Key	Required	Type
entityType	entityType	True	string
clientCode	clientCode	True	string
salutation	salutation		string
title	title		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
placeOfBirth	placeOfBirth		string
dateOfDeath	dateOfDeath		date
deRegistrationDate	deRegistrationDate		date
startDate	startDate		date
endDate	endDate		date
gender	gender		string
typeId	typeId		integer
typeName	typeName		string
type	type		string
email	email		string
preferred	preferred		boolean
favourite	favourite		boolean
typeId	typeId		integer
typeName	typeName		string
type	type		string
countryId	countryId		integer
isdCode	isdCode		integer
number	number		string
preferred	preferred		boolean
favourite	favourite		boolean
linkedInProfileId	linkedInProfileId		string
website	website		string
annualReviewDate	annualReviewDate		date
formationDate	formationDate		date
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		string
abn	abn		string
acn	acn		string
din	din		string
taxAgent	taxAgent		string
gst	gst		boolean
resident	resident		boolean
bankName	bankName		string
bankAccountName	bankAccountName		string
bankBSB	bankBSB		string
bankAccountNumber	bankAccountNumber		string
id	id		integer
value	value		string
mailingName	mailingName		string
tagIds	tagIds		array of integer
clientBrefcode	clientBrefcode		string
enumEntityTypes	enumEntityTypes		string
enumTrustTypes	enumTrustTypes		string
enumGender	enumGender		string
enumContactTypes	enumContactTypes		string
enumAddressTypes	enumAddressTypes		string

Returns

Body: ResponseMessage

Create client group

Operation ID:: createClientGroup

Creates a client group.

Parameters

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

Returns

Body: ResponseMessage

Create contact

Operation ID:: createContacts

Creates a contact.

Parameters

Name	Key	Required	Type
salutation	salutation		string
title	title		string
firstName	firstName	True	string
middleName	middleName		string
lastName	lastName	True	string
gender	gender		string
typeId	typeId		integer
typeName	typeName		string
type	type		string
email	email		string
preferred	preferred		boolean
favourite	favourite		boolean
typeId	typeId		integer
typeName	typeName		string
type	type		string
countryId	countryId		integer
isdCode	isdCode		integer
number	number		string
preferred	preferred		boolean
favourite	favourite		boolean
placeOfBirth	placeOfBirth		string
linkedInProfileID	linkedInProfileID		string
dateOfBirth	dateOfBirth		date
dateOfDeath	dateOfDeath		date
preferredName	preferredName		string
din	din		string
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

Returns

Body: ResponseMessage

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

Returns

Body: ResponseMessage

Create job priority

Operation ID:: createJobPriority

Creates a workflow job priority.

Parameters

Name	Key	Required	Type	Description
Priority name	priorityName	True	string	Job priority name.

Returns

Body: ResponseMessage

Create job task

Operation ID:: createJobTasks

Creates a task in a job task group.

Parameters

Name	Key	Type
jobId	jobId	integer
taskName	taskName	string
status	status	string
taskTypeId	taskTypeId	integer
taskgroupId	taskgroupId	integer
taskLevelRoleId	taskLevelRoleId	integer
userId	userId	string
unit	unit	integer
taskCategory	taskCategory	string
startDate	startDate	date-time
dueDate	dueDate	date-time

Returns

Body: ResponseMessage

Create job task group

Operation ID:: createJobTaskGroup

Creates a task group on a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.
Task group name	taskgroupname	True	string	Task group name.

Returns

Body: ResponseMessage

Create job template

Operation ID:: createJobTemplate

Creates a workflow job template.

Parameters

Name	Key	Type
templateName	templateName	string
description	description	string
estimateType	estimateType	string
jobTypeId	jobTypeId	integer
turnaround	turnaround	integer

Returns

Body: ResponseMessage

Create job type

Operation ID:: createJobType

Creates a job type with its statuses.

Parameters

Name	Key	Type
jobTypeName	jobTypeName	string
description	description	string
divisionId	divisionId	integer
defaultTemplate	defaultTemplate	integer
debtorJobCategory	debtorJobCategory	string
relatedJobCategory	relatedJobCategory	string
statusId	statusId	integer
statusCatId	statusCatId	integer
description	description	string
statusName	statusName	string
enumJobCategoryTypes	enumJobCategoryTypes	string

Returns

Body: ResponseMessage

Create non-billable time type

Operation ID:: createNonBillableTimesheetType

Creates a non-billable timesheet type.

Parameters

Name	Key	Type
name	name	string
description	description	string
type	type	string

Returns

Body: ResponseMessage

Create task type

Operation ID:: createTaskType

Creates a task type.

Parameters

Name	Key	Type
taskType	taskType	string
description	description	string
taskCategory	taskCategory	string
enumTaskCategory	enumTaskCategory	string

Returns

Body: ResponseMessage

Create template task

Operation ID:: createTemplateTask

Creates a task in a job template task group.

Parameters

Name	Key	Type
templateId	templateId	integer
taskgroupId	taskgroupId	integer
taskTypeId	taskTypeId	integer
taskName	taskName	string
roleId	roleId	integer
unit	unit	integer
taskCategory	taskCategory	string
startAfterDays	startAfterDays	integer
dueAfterDays	dueAfterDays	integer

Returns

Body: ResponseMessage

Create template task group

Operation ID:: createTemplateTaskGroup

Creates a task group in a job template.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	integer	Job template identifier.
Task group name	taskgroupname	True	string	Task group name.

Returns

Body: ResponseMessage

Get client by ID

Operation ID:: getAClient

Returns the details of a client.

Parameters

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

Returns

Body: ClientDetails_Result

Get custom fields by context

Operation ID:: getFirmCustomfields

Returns the custom fields defined for a context: client, contact, job or all.

Parameters

Name	Key	Required	Type	Description
Context	context	True	string	Custom field context: client, contact, job or all.

Get debtor client mapping

Operation ID:: getClientsDebtor

Returns the debtor clients mapped to a client.

Parameters

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

Returns

response: array of ClientDebtor

Get job by ID

Operation ID:: getAJob

Returns the details of a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.

Returns

response: array of JobData

List client groups

Operation ID:: getClientGroups

Returns a paged list of client groups and their member clients.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Group code	groupCode	string	Filter by client group code.
Client code	clientCode	string	Filter by client code.

Returns

Body: ClientGroup_Result

List client managers

Operation ID:: getClientAreaManagers

Returns the users that can be selected as manager on a client.

Returns

response: array of UserModel

List client partners

Operation ID:: getClientAreaPartners

Returns the users that can be selected as partner on a client.

Returns

response: array of UserModel

List client relationships

Operation ID:: getClientRelationships

Returns a paged list of relationships for a client.

Parameters

Name	Key	Required	Type	Description
Page	page		integer	Results page number, starting at 1.
Page size	pageSize		integer	Number of items to return per page (maximum 1000).
Client ID	clientId	True	integer	Client identifier.

Returns

Body: Relationships_Result

List client tags

Operation ID:: getClientsTags

Returns the available client tags.

Returns

response: array of TagModel

List clients

Operation ID:: getClients

Returns a paged list of clients.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Partner ID	partnerId	string	Filter by partner (user) ID.
Debit client	isDebitClient	boolean	Filter by the debit-client flag.
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).
Group code	groupCode	string	Filter by client group code.
Client ID	clientId	integer	Filter by client ID.
Custom fields	isCustomField	boolean	Include custom fields in the results.

Returns

Body: Client_Result

List clients available for grouping

Operation ID:: getValidClientsForGrouping

Returns the clients that can be added to a client group.

Returns

response: array of ClientSummary

List communication contacts

Operation ID:: getClientCommunicationContacts

Returns a paged list of client communication contact details.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).

Returns

Body: ContactsInfo_result

List contacts

Operation ID:: getContacts

Returns a paged list of contacts.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).
Contact ID	contactId	integer	Filter by contact ID.
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 results.

Returns

Body: Contact_Result

List contacts available for clients

Operation ID:: getValidContactsForClients

Returns the contacts that can be linked to a client.

Returns

response: array of ClientContacts

List countries

Operation ID:: getCountries

Returns the available countries.

Returns

response: array of Country

List divisions

Operation ID:: getDivisions

Returns a paged list of divisions.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).

Returns

Body: Divisions_Result

List email types

Operation ID:: getEmailTypes

Returns the available email types.

Returns

response: array of EmailType

List industries

Operation ID:: getClientIndustries

Returns the industry names that can be assigned to a client.

Returns

Name	Path	Type	Description
		array of string

List invoices

Operation ID:: getInvoices

Returns a paged list of invoices.

Parameters

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

Returns

Body: InvoiceDetail_Result

List job managers

Operation ID:: getJobAreaManagers

Returns the users that can be selected as manager on a job.

Returns

response: array of UserModel

List job partners

Operation ID:: getJobAreaPartners

Returns the users that can be selected as partner on a job.

Returns

response: array of UserModel

List job priorities

Operation ID:: getJobPriorities

Returns the available workflow job priorities.

Returns

response: array of JobPriority

List job status categories

Operation ID:: getJobStatusCategories

Returns the available job status categories.

Returns

response: array of StatusCatagory

List job task group tasks

Operation ID:: getJobTaskGroupTasks

Returns the tasks in a task group of a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.
Task group ID	taskgroupId	True	integer	Task group identifier.

Returns

response: array of ClientProfileTask

List job task groups

Operation ID:: getJobTaskGroups

Returns the task groups of a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.

Returns

response: array of ClientProfileTaskGroupData

List job templates

Operation ID:: getJobTemplates

Returns the available workflow job templates.

Returns

response: array of JobTemplate

List job type statuses

Operation ID:: getJobTypeStatus

Returns the available workflow job type statuses.

Returns

response: array of JobTypeStatus

List job types

Operation ID:: getJobTypes

Returns the available workflow job types.

Returns

response: array of JobType

List jobs

Operation ID:: getJobs

Returns a paged list of workflow jobs.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Partner ID	partnerId	string	Filter by partner (user) ID.
Client name	clientName	string	Filter by client name.
Client code	clientcode	string	Filter by client code.
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).
Debit client	isDebitClient	boolean	Filter by the debit-client flag.
Custom fields	isCustomField	boolean	Include custom fields in the results.

Returns

Body: Jobs_Result

List non-billable time types

Operation ID:: getNonBillableTimesheetTypes

Returns the available non-billable timesheet types.

Returns

response: array of Leave

List phone types

Operation ID:: getPhoneTypes

Returns the available phone types.

Returns

response: array of PhoneType

List roles

Operation ID:: getUserRoles

Returns the available user roles.

Returns

response: array of Roledetails

List salutations

Operation ID:: getClientSalutations

Returns the salutations available for clients and contacts.

Returns

response: array of Salutation

List tasks

Operation ID:: getTasks

Returns a paged list of job tasks.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Status	status	string	Filter tasks by status.
Assignee ID	assigneeId	string	Filter tasks by the ID of the assigned user.
Days until due	daysUntilDue	integer	Filter tasks by the number of days until they are due.
Job ID	jobId	integer	Filter by job ID.

Returns

Body: Tasks_Result

List tax types

Operation ID:: getInvoiceTaxTypes

Returns the tax types available for invoices.

Returns

response: array of TaxTypes

List teams

Operation ID:: getTeams

Returns the available teams.

Returns

response: array of Teams

List template task group tasks

Operation ID:: getTemplateTaskGroupTasks

Returns a task group and its tasks for a job template.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	integer	Job template identifier.
Task group ID	taskgroupId	True	integer	Task group identifier.

Returns

response: array of CompositeTemplateTaskGroupViewModel

List template task groups

Operation ID:: getTemplateTaskGroups

Returns the task groups and tasks of a job template.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	integer	Job template identifier.

Returns

response: array of CompositeTemplateTaskGroupViewModel

List timesheet entries

Operation ID:: getTimesheets

Returns a paged list of timesheet time entries.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Status	status	string	Filter timesheet entries by status.
Job ID	jobId	integer	Filter by job ID.
Task ID	taskId	integer	Filter by task ID.
Client ID	clientId	integer	Filter by client ID.
From date	fromDate	string	Return entries on or after this date (yyyy-MM-dd). If no to date is given, today is used.
To date	toDate	string	Return entries on or before this date (yyyy-MM-dd).
Billable	isbillable	boolean	Filter by billable (true) or non-billable (false) entries.

Returns

Body: TimeSheet_Result

List titles

Operation ID:: getClientTitles

Returns the titles available for clients and contacts.

Returns

response: array of Title

List users

Operation ID:: getUsers

Returns a paged list of users.

Parameters

Name	Key	Type	Description
Page	page	integer	Results page number, starting at 1.
Page size	pageSize	integer	Number of items to return per page (maximum 1000).
Modified since	modifiedSince	string	Return records modified on or after this timestamp (ISO 8601).
Role name	rolename	string	Filter users by role name.

Returns

Body: Users_Result

Log time

Operation ID:: createTimesheet

Creates one or more timesheet time entries (up to 20 per request).

Parameters

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

Returns

response: array of PostJobLogTimeResponse

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
title	title		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
placeOfBirth	placeOfBirth		string
dateOfDeath	dateOfDeath		date
deRegistrationDate	deRegistrationDate		date
startDate	startDate		date
endDate	endDate		date
gender	gender		string
typeId	typeId		integer
typeName	typeName		string
type	type		string
email	email		string
preferred	preferred		boolean
favourite	favourite		boolean
typeId	typeId		integer
typeName	typeName		string
type	type		string
countryId	countryId		integer
isdCode	isdCode		integer
number	number		string
preferred	preferred		boolean
favourite	favourite		boolean
linkedInProfileId	linkedInProfileId		string
website	website		string
annualReviewDate	annualReviewDate		date
formationDate	formationDate		date
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		string
abn	abn		string
acn	acn		string
din	din		string
taxAgent	taxAgent		string
gst	gst		boolean
resident	resident		boolean
bankName	bankName		string
bankAccountName	bankAccountName		string
bankBSB	bankBSB		string
bankAccountNumber	bankAccountNumber		string
id	id		integer
value	value		string
mailingName	mailingName		string
tagIds	tagIds		array of integer
clientBrefcode	clientBrefcode		string
enumEntityTypes	enumEntityTypes		string
enumTrustTypes	enumTrustTypes		string
enumGender	enumGender		string
enumContactTypes	enumContactTypes		string
enumAddressTypes	enumAddressTypes		string

Returns

Body: ResponseMessage

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
tags	tags		array of integer
clientId	clientId		integer
isDebitorClient	isDebitorClient		boolean
relationIds	relationIds		array of integer
contactId	contactId		integer
context	context		string

Returns

Body: ResponseMessage

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
title	title		string
firstName	firstName	True	string
middleName	middleName		string
lastName	lastName	True	string
gender	gender		string
typeId	typeId		integer
typeName	typeName		string
type	type		string
email	email		string
preferred	preferred		boolean
favourite	favourite		boolean
typeId	typeId		integer
typeName	typeName		string
type	type		string
countryId	countryId		integer
isdCode	isdCode		integer
number	number		string
preferred	preferred		boolean
favourite	favourite		boolean
placeOfBirth	placeOfBirth		string
linkedInProfileID	linkedInProfileID		string
dateOfBirth	dateOfBirth		date
dateOfDeath	dateOfDeath		date
preferredName	preferredName		string
din	din		string
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

Returns

Body: ResponseMessage

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

Returns

Body: ResponseMessage

Update job priority

Operation ID:: updateJobPriority

Renames a workflow job priority.

Parameters

Name	Key	Required	Type	Description
Priority ID	priorityId	True	integer	Job priority identifier.
Priority name	priorityName	True	string	Job priority name.

Returns

Body: ResponseMessage

Update job status and priority

Operation ID:: updateJobStatus

Updates the status and priority of a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.
priority	priority		string
status	status		string
statusOwner	statusOwner		string

Returns

Body: ResponseMessage

Update job task

Operation ID:: updateJobTask

Updates a task in a job task group.

Parameters

Name	Key	Required	Type	Description
Task ID	taskId	True	integer	Task identifier.
jobId	jobId		integer
taskName	taskName		string
status	status		string
taskTypeId	taskTypeId		integer
taskgroupId	taskgroupId		integer
taskLevelRoleId	taskLevelRoleId		integer
userId	userId		string
unit	unit		integer
taskCategory	taskCategory		string
startDate	startDate		date-time
dueDate	dueDate		date-time

Returns

Body: ResponseMessage

Update job task group

Operation ID:: updateJobTaskGroup

Renames a task group on a workflow job.

Parameters

Name	Key	Required	Type	Description
Job ID	jobId	True	integer	Workflow job identifier.
Task group ID	taskgroupId	True	integer	Task group identifier.
Task group name	taskgroupname	True	string	Task group name.

Returns

Body: ResponseMessage

Update job template

Operation ID:: updateJobTemplate

Updates a workflow job template by ID.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	integer	Job template identifier.
templateName	templateName		string
description	description		string
jobTypeId	jobTypeId		integer
turnaround	turnaround		integer

Returns

Body: ResponseMessage

Update job type

Operation ID:: updateJobType

Updates a job type by ID.

Parameters

Name	Key	Required	Type	Description
Job type ID	id	True	integer	Job type identifier.
jobTypeName	jobTypeName		string
description	description		string
divisionId	divisionId		integer
defaultTemplate	defaultTemplate		integer
debtorJobCategory	debtorJobCategory		string
relatedJobCategory	relatedJobCategory		string
statusId	statusId		integer
statusCatId	statusCatId		integer
description	description		string
statusName	statusName		string
enumJobCategoryTypes	enumJobCategoryTypes		string

Returns

Body: ResponseMessage

Update job type statuses

Operation ID:: updateJobTypeStatuses

Updates the statuses of a job type.

Parameters

Name	Key	Required	Type	Description
Job type ID	jobtypeId	True	integer	Job type identifier.
statusId	statusId		integer
statusCatId	statusCatId		integer
description	description		string
statusName	statusName		string

Returns

Body: ResponseMessage

Update non-billable time type

Operation ID:: updateNonBillableTimesheetType

Updates a non-billable timesheet type by ID.

Parameters

Name	Key	Required	Type	Description
Non-billable type ID	id	True	integer	Non-billable time type identifier.
name	name		string
description	description		string

Returns

Body: ResponseMessage

Update task type

Operation ID:: updateTaskType

Updates a task type by ID.

Parameters

Name	Key	Required	Type	Description
Task type ID	tasktypeId	True	integer	Task type identifier.
taskType	taskType		string
description	description		string
taskCategory	taskCategory		string
enumTaskCategory	enumTaskCategory		string

Returns

Body: ResponseMessage

Update template task

Operation ID:: updateTemplateTask

Updates a task in a job template task group.

Parameters

Name	Key	Required	Type	Description
Task ID	taskId	True	integer	Task identifier.
templateId	templateId		integer
taskgroupId	taskgroupId		integer
taskTypeId	taskTypeId		integer
taskName	taskName		string
roleId	roleId		integer
unit	unit		integer
taskCategory	taskCategory		string
startAfterDays	startAfterDays		integer
dueAfterDays	dueAfterDays		integer

Returns

Body: ResponseMessage

Update template task group

Operation ID:: updateTemplateTaskGroup

Renames a task group in a job template.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	integer	Job template identifier.
Task group ID	taskgroupId	True	integer	Task group identifier.
Task group name	taskgroupname	True	string	Task group name.

Returns

Body: ResponseMessage

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
title	title	string
name	name	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
gender	gender	string
preferredName	preferredName	string
mailingName	mailingName	string
tradingAs	tradingAs	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
division	division	Division
entityType	entityType	string
industry	industry	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
din	din	string
gstRegistered	gstRegistered	boolean
taxClient	taxClient	boolean
isProspect	isProspect	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
placeOfBirth	placeOfBirth	string
trustType	trustType	string
dateOfDeath	dateOfDeath	string
formationDate	formationDate	string
annualReviewDate	annualReviewDate	string
deRegistrationDate	deRegistrationDate	string
startDate	startDate	string
endDate	endDate	string
id	id	integer
tags	tags	array of tag
customFields	customFields	array of CustomField

ClientContacts

Name	Path	Type
clientid	clientid	integer
contactid	contactid	integer
contactName	contactName	string
context	context	string

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
title	title	string
name	name	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
gender	gender	string
preferredName	preferredName	string
mailingName	mailingName	string
tradingAs	tradingAs	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
division	division	Division
entityType	entityType	string
industry	industry	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
isProspect	isProspect	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
placeOfBirth	placeOfBirth	string
trustType	trustType	string
dateOfDeath	dateOfDeath	string
formationDate	formationDate	string
annualReviewDate	annualReviewDate	string
deRegistrationDate	deRegistrationDate	string
startDate	startDate	string
endDate	endDate	string
id	id	integer
tags	tags	array of tag
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

ClientGroup_Result

Name	Path	Type	Description
clientGroups	clientGroups	array of GroupClients
pagination	pagination	Pagination

ClientProfileTask

Name	Path	Type
taskId	taskId	integer
taskGroupId	taskGroupId	integer
taskTitle	taskTitle	string
description	description	string
startDate	startDate	date-time
dueDate	dueDate	date-time
status	status	string
assignee	assignee	string
priority	priority	string
contextId	contextId	integer
contextType	contextType	string
reminders	reminders	string
createdBy	createdBy	string
created	created	string
lastmodified	lastmodified	string
jobTypeId	jobTypeId	integer
taskType	taskType	integer
unit	unit	integer
totalUnit	totalUnit	integer
roleId	roleId	integer
roleName	roleName	string
sequence	sequence	integer
assigneeUserDetails	assigneeUserDetails	array of TaskAssigneeUserDetails
isChecked	isChecked	boolean
documentsCount	documentsCount	integer
clientId	clientId	integer
taskCategory	taskCategory	TaskCategory
taskDependencyCount	taskDependencyCount	integer

ClientProfileTaskGroupData

Name	Path	Type
taskGroupId	taskGroupId	integer
jobId	jobId	integer
taskGroupName	taskGroupName	string
sequence	sequence	integer
createdBy	createdBy	string
created	created	string
lastmodified	lastmodified	string
taskCount	taskCount	integer
isTaskAllCheck	isTaskAllCheck	boolean
isSubTaskAllCheck	isSubTaskAllCheck	boolean
tasks	tasks	array of ClientProfileTask
statusCount	statusCount	StatusCount
assignees	assignees	string

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

CompositeTemplateTaskGroupViewModel

Name	Path	Type	Description
taskGroup	taskGroup	TaskTemplateGroupList
tasks	tasks	array of TaskTemplateViewDetailModel

Contact

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

ContactEntity

Name	Path	Type
salutation	salutation	string
title	title	string
firstName	firstName	string
middleName	middleName	string
lastName	lastName	string
gender	gender	string
email	email	array of Email
phone	phone	array of Phone
placeOfBirth	placeOfBirth	string
linkedInProfileID	linkedInProfileID	string
preferredName	preferredName	string
din	din	string
contactId	contactId	integer
dateOfBirth	dateOfBirth	string
dateOfDeath	dateOfDeath	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

ContactsInfo

Name	Path	Type
contactId	contactId	integer
contextType	contextType	integer
systemId	systemId	string
code	code	string
title	title	string
name	name	string
salutation	salutation	string
preferredName	preferredName	string
email	email	string
phone	phone	string
weburl	weburl	string
lastModified	lastModified	string

ContactsInfo_result

Name	Path	Type	Description
communicationcontacts	communicationcontacts	array of ContactsInfo
pagination	pagination	Pagination

Country

Name	Path	Type
countryId	countryId	integer
code	code	string
name	name	string
isdCode	isdCode	integer

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
typeId	typeId	integer
typeName	typeName	string
type	type	string
email	email	string
preferred	preferred	boolean
favourite	favourite	boolean

EmailType

Name	Path	Type
emailTypeId	emailTypeId	integer
emailTypeName	emailTypeName	string
createdBy	createdBy	string
created	created	string
lastModified	lastModified	string

EntityInfo

Name	Path	Type	Description
id	id	integer
name	name	string

Group

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

GroupClient

Name	Path	Type
clientId	clientId	integer
entityType	entityType	string
clientCode	clientCode	string
clientname	clientname	string
isDebtorClient	isDebtorClient	boolean
debtorClientId	debtorClientId	integer

GroupClients

Name	Path	Type
groupId	groupId	integer
groupCode	groupCode	string
groupName	groupName	string
contact	contact	groupContact
tags	tags	array of tag
clients	clients	array of GroupClient
createdBy	createdBy	string
created	created	string
lastmodified	lastmodified	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
taxName	taxName	string
taxRate	taxRate	double
gst	gst	double
payment	payment	double
creditNote	creditNote	double
creditAdjustment	creditAdjustment	double
feeReversal	feeReversal	double
badDebt	badDebt	double
balance	balance	double
status	status	string
debtorClientId	debtorClientId	integer
debtorClientCode	debtorClientCode	string
debtorClientName	debtorClientName	string
mailingName	mailingName	string
clientMailingName	clientMailingName	string
debtorBrefcode	debtorBrefcode	string
billercode	billercode	string
invoiceLines	invoiceLines	array of InvoiceLines
invoiceJobs	invoiceJobs	array of JobInvoice
created	created	string
lastModified	lastModified	string
templateName	templateName	string

InvoiceLines

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

JobData

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
frequency	frequency	string
period	period	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
archivedAt	archivedAt	string
templateId	templateId	integer
jobTypeId	jobTypeId	integer
description	description	string
startDate	startDate	string
jobCategory	jobCategory	string
estimateType	estimateType	string
billingMethod	billingMethod	string
statusId	statusId	integer
quoteAmount	quoteAmount	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

JobPriority

Name	Path	Type
jobPriorityId	jobPriorityId	integer
jobPriorityName	jobPriorityName	string
createdBy	createdBy	string
lastModified	lastModified	string

JobTemplate

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

JobType

Name	Path	Type
jobTypeId	jobTypeId	integer
jobTypeName	jobTypeName	string
description	description	string
divisionId	divisionId	integer
createdBy	createdBy	string
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
frequency	frequency	string
period	period	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
archivedAt	archivedAt	string

Jobs_Result

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

Leave

Name	Path	Type
id	id	integer
name	name	string
description	description	string
type	type	string
isActive	isActive	boolean
createdBy	createdBy	string
created	created	string
lastModified	lastModified	string

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
typeId	typeId	integer
typeName	typeName	string
type	type	string
countryId	countryId	integer
isdCode	isdCode	integer
number	number	string
preferred	preferred	boolean
favourite	favourite	boolean

PhoneType

Name	Path	Type
phoneTypeId	phoneTypeId	integer
phoneTypeName	phoneTypeName	string
createdBy	createdBy	string
created	created	string
lastModified	lastModified	string

PostJobLogTimeResponse

Name	Path	Type
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
starttime	starttime	time
units	units	double
timeSheetTime	timeSheetTime	time
rate	rate	double
description	description	string
rowNumber	rowNumber	integer
logTimeId	logTimeId	integer
isSuccess	isSuccess	boolean
message	message	string

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

ResponseMessage

Name	Path	Type
id	id	string
status	status	string
message	message	string
currentDate	currentDate	date-time

RoleUnit

Name	Path	Type	Description
roleId	roleId	integer
unit	unit	integer

Roledetails

Name	Path	Type
roleId	roleId	integer
accountingFirmId	accountingFirmId	integer
roleName	roleName	string
defaultRoleName	defaultRoleName	string
description	description	string
isSystem	isSystem	boolean

Salutation

Name	Path	Type	Description
id	id	integer
salutation	salutation	string

Staff

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

StatusCatagory

Name	Path	Type	Description
id	id	integer
name	name	string

StatusCount

Name	Path	Type
notStartedCount	notStartedCount	integer
inProgressCount	inProgressCount	integer
onHoldCount	onHoldCount	integer
reviewCount	reviewCount	integer
completedCount	completedCount	integer
totalCount	totalCount	integer

TagModel

Name	Path	Type
id	id	integer
name	name	string
isDisabled	isDisabled	boolean
createdBy	createdBy	string
created	created	string
lastModified	lastModified	string

TaskAssigneeUserDetails

Name	Path	Type
userId	userId	string
taskId	taskId	integer
shortName	shortName	string
fullName	fullName	string
cost	cost	double
rate	rate	double
time	time	double
unit	unit	integer
totalUnit	totalUnit	integer
isFirstUserForRole	isFirstUserForRole	boolean
roleId	roleId	integer
roleName	roleName	string

TaskCategory

: string

TaskDetail

Name	Path	Type	Description
id	id	integer
name	name	string

TaskModel

Name	Path	Type
taskId	taskId	integer
taskName	taskName	string
jobId	jobId	integer
jobName	jobName	string
jobManager	jobManager	Staff
jobPartner	jobPartner	Staff
jobClient	jobClient	clientInfo
jobDebtor	jobDebtor	clientInfo
jobDivision	jobDivision	EntityInfo
assignees	assignees	array of Staff
taskType	taskType	string
startDate	startDate	date-time
dueDate	dueDate	date-time
daysUntilDue	daysUntilDue	string
taskCategory	taskCategory	string
status	status	string
createdBy	createdBy	string
created	created	string
lastModified	lastModified	string

TaskTemplateGroupList

Name	Path	Type
templateId	templateId	integer
taskgroupId	taskgroupId	integer
taskGroupName	taskGroupName	string
createdBY	createdBY	string
created	created	string
lastmodified	lastmodified	string

TaskTemplateViewDetailModel

Name	Path	Type
taskId	taskId	integer
taskgroupId	taskgroupId	integer
taskType	taskType	string
taskTypeId	taskTypeId	integer
sequence	sequence	integer
taskName	taskName	string
keyFlag	keyFlag	string
createdBy	createdBy	string
created	created	string
lastmodified	lastmodified	string
roleId	roleId	integer
templateId	templateId	integer
unit	unit	integer
rolesUnits	rolesUnits	array of RoleUnit
taskMembers	taskMembers	array of string
taskCategory	taskCategory	TaskCategory
taskDependencyCount	taskDependencyCount	integer
startAfterDays	startAfterDays	integer
dueAfterDays	dueAfterDays	integer

Tasks_Result

Name	Path	Type	Description
tasks	tasks	array of TaskModel
pagination	pagination	Pagination

TaxTypes

Name	Path	Type
taxId	taxId	integer
taxName	taxName	string
taxRate	taxRate	double
effectiveFrom	effectiveFrom	string
effectiveTo	effectiveTo	string
isDefault	isDefault	boolean
created	created	string
lastModified	lastModified	string

Teams

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

TimeSheetLogs

Name	Path	Type
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
starttime	starttime	time
units	units	double
timeSheetTime	timeSheetTime	time
rate	rate	double
description	description	string
clientId	clientId	integer
logTimeId	logTimeId	integer
userId	userId	string
createdBy	createdBy	string
created	created	string
status	status	string

TimeSheet_Result

Name	Path	Type	Description
timeSheets	timeSheets	array of TimeSheetLogs
pagination	pagination	Pagination

Title

Name	Path	Type	Description
id	id	integer
title	title	string

UserDetail

Name	Path	Type	Description
id	id	string
name	name	string

UserModel

Name	Path	Type
id	id	string
name	name	string
roleName	roleName	string
firstName	firstName	string
lastName	lastName	string

UsersWithDetails

Name	Path	Type
id	id	string
name	name	string
roleName	roleName	string
firstName	firstName	string
lastName	lastName	string
email	email	Email
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

clientInfo

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

groupContact

Name	Path	Type
id	id	integer
name	name	string
contextType	contextType	integer

tag

Name	Path	Type	Description
tagId	tagId	integer
tagName	tagName	string