KC (versão prévia)

O KC Practice Management permite acesso seguro a dados de cliente e de negócios, permitindo que os usuários recuperem e gerenciem informações com eficiência por meio de fluxos de trabalho automatizados.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte ao Kloud Connect
URL	https://www.kloudconnect.com.au/
Email	support@kloudconnect.com.au

Metadados do conector
Publicador	Kloud Connect
Site	https://www.kloudconnect.com.au/
Política de privacidade	https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf
Categories	Gestão de empresas; Financiar

Gestão de Práticas do Kloud Connect

Visão geral

Esse conector fornece acesso às APIs de Gerenciamento de Práticas do Kloud Connect para que clientes, contatos, trabalhos, tarefas, quadros de horários e faturas possam ser lidos e gerenciados de Power Automate, Power Apps e Copilot Studio.

Features

Clientes: listar, obter, criar e atualizar clientes; grupos de clientes; marcas; relações; clientes devedores; saudações, títulos, setores e contatos de comunicação
Contatos: listar, criar e atualizar contatos
Divisões: listar divisões
Faturas: listar faturas e tipos de impostos
Trabalhos: listar, obter, criar e atualizar trabalhos; atualizar o status e a prioridade do trabalho; tarefas e grupos de tarefas de trabalho
Tarefas: listar tarefas; criar e atualizar tarefas de trabalho; tipos de tarefa
Modelos de trabalho: listar, criar e atualizar modelos, grupos de tarefas de modelo e tarefas de modelo
Quadros de horários: tempo de log (até 20 entradas por solicitação), entradas de quadro de horários de lista e tipos de tempo não faturáveis
Usuários: listar usuários, equipes e funções; parceiros e gerentes para clientes e trabalhos
Configurações e pesquisas: campos personalizados, tipos de trabalho e status, prioridades de trabalho, categorias de status do trabalho, tipos de email, tipos de telefone e países

Novidades nesta atualização

Adição de operações para a criação de contatos, grupos de tarefas de trabalho e modelo, tarefas de trabalho, tipos de tarefa, modelos de trabalho, tipos de trabalho, prioridades de trabalho e tipos de tempo não faturáveis
Operações adicionadas para listar entradas de quadro de horários, tarefas, funções, tipos de impostos, saudações, títulos, setores, países, tipos de email e tipos de telefone
Adicionados contatos de comunicação do cliente, clientes disponíveis para agrupamento e contatos disponíveis para clientes
As operações de gravação agora descrevem sua resposta (ID, status, mensagem e data)

Alterações críticas

Atualizar o status e a prioridade do trabalho (updateJobStatuses) é substituído por updateJobStatus, que agora usa a ID do trabalho como entrada
O tempo de log (createTimesheet) agora aceita uma lista de até 20 entradas de tempo em vez de uma única entrada
Listar tipos de trabalho, modelos de trabalho, prioridades de trabalho e status de tipo de trabalho agora retornam listas e usam os /v1/settings/workflows pontos de extremidade
Listar equipes e obter o mapeamento de cliente devedor agora listas de retorno

Limitations

As operações de gerenciamento de documentos (pastas, arquivos e sites) não fazem parte desse conector

Authentication

OAuth 2.0 via Kloud Connect Identity Server

Suporte

support@kloudconnect.com.au

Ações

Atualizar cliente por ID	Atualiza um cliente por ID.
Atualizar contato	Atualiza um contato por ID.
Atualizar grupo de clientes	Atualiza um grupo de clientes por código de grupo.
Atualizar grupo de tarefas de modelo	Renomeia um grupo de tarefas em um modelo de trabalho.
Atualizar grupo de tarefas de trabalho	Renomeia um grupo de tarefas em um trabalho de fluxo de trabalho.
Atualizar modelo de trabalho	Atualiza um modelo de trabalho de fluxo de trabalho por ID.
Atualizar o status e a prioridade do trabalho	Atualiza o status e a prioridade de um trabalho de fluxo de trabalho.
Atualizar o tipo de hora não faturável	Atualiza um tipo de quadro de horários não faturável por ID.
Atualizar prioridade de trabalho	Renomeia uma prioridade de trabalho de fluxo de trabalho.
Atualizar status do tipo de trabalho	Atualiza os status de um tipo de trabalho.
Atualizar tarefa de modelo	Atualiza uma tarefa em um grupo de tarefas de modelo de trabalho.
Atualizar tarefa de trabalho	Atualiza uma tarefa em um grupo de tarefas de trabalho.
Atualizar tipo de tarefa	Atualiza um tipo de tarefa por ID.
Atualizar tipo de trabalho	Atualiza um tipo de trabalho por ID.
Atualizar trabalho	Atualiza um trabalho de fluxo de trabalho por ID.
Criar cliente	Cria um cliente.
Criar contato	Cria um contato.
Criar grupo de clientes	Cria um grupo de clientes.
Criar grupo de tarefas de modelo	Cria um grupo de tarefas em um modelo de trabalho.
Criar grupo de tarefas de trabalho	Cria um grupo de tarefas em um trabalho de fluxo de trabalho.
Criar modelo de trabalho	Cria um modelo de trabalho de fluxo de trabalho.
Criar prioridade de trabalho	Cria uma prioridade de trabalho de fluxo de trabalho.
Criar tarefa de modelo	Cria uma tarefa em um grupo de tarefas de modelo de trabalho.
Criar tarefa de trabalho	Cria uma tarefa em um grupo de tarefas de trabalho.
Criar tipo de hora não faturável	Cria um tipo de quadro de horários não faturável.
Criar tipo de tarefa	Cria um tipo de tarefa.
Criar tipo de trabalho	Cria um tipo de trabalho com seus status.
Criar trabalho	Cria um trabalho de fluxo de trabalho.
Listar categorias de status do trabalho	Retorna as categorias de status do trabalho disponíveis.
Listar clientes	Retorna uma lista paginada de clientes.
Listar clientes disponíveis para agrupamento	Retorna os clientes que podem ser adicionados a um grupo de clientes.
Listar contatos	Retorna uma lista paginada de contatos.
Listar contatos de comunicação	Retorna uma lista paginada de detalhes de contato de comunicação do cliente.
Listar contatos disponíveis para clientes	Retorna os contatos que podem ser vinculados a um cliente.
Listar divisões	Retorna uma lista paginada de divisões.
Listar entradas de quadro de horários	Retorna uma lista paginada de entradas de tempo do quadro de horários.
Listar equipes	Retorna as equipes disponíveis.
Listar faturas	Retorna uma lista paginada de faturas.
Listar funções	Retorna as funções de usuário disponíveis.
Listar gerentes de cliente	Retorna os usuários que podem ser selecionados como gerente em um cliente.
Listar gerentes de trabalho	Retorna os usuários que podem ser selecionados como gerente em um trabalho.
Listar grupos de clientes	Retorna uma lista de páginas de grupos de clientes e seus clientes membros.
Listar grupos de tarefas de modelo	Retorna os grupos de tarefas e as tarefas de um modelo de trabalho.
Listar grupos de tarefas de trabalho	Retorna os grupos de tarefas de um trabalho de fluxo de trabalho.
Listar marcas de cliente	Retorna as marcas de cliente disponíveis.
Listar modelos de trabalho	Retorna os modelos de trabalho de fluxo de trabalho disponíveis.
Listar parceiros cliente	Retorna os usuários que podem ser selecionados como parceiros em um cliente.
Listar parceiros de trabalho	Retorna os usuários que podem ser selecionados como parceiros em um trabalho.
Listar países	Retorna os países disponíveis.
Listar prioridades de trabalho	Retorna as prioridades de trabalho de fluxo de trabalho disponíveis.
Listar relações de cliente	Retorna uma lista paginada de relações para um cliente.
Listar saudações	Retorna as saudações disponíveis para clientes e contatos.
Listar setores	Retorna os nomes do setor que podem ser atribuídos a um cliente.
Listar status de tipo de trabalho	Retorna os status de tipo de trabalho de fluxo de trabalho disponíveis.
Listar tarefas	Retorna uma lista paginada de tarefas de trabalho.
Listar tarefas do grupo de tarefas de trabalho	Retorna as tarefas em um grupo de tarefas de um trabalho de fluxo de trabalho.
Listar tarefas do grupo de tarefas do modelo	Retorna um grupo de tarefas e suas tarefas para um modelo de trabalho.
Listar tipos de email	Retorna os tipos de email disponíveis.
Listar tipos de impostos	Retorna os tipos de impostos disponíveis para faturas.
Listar tipos de telefone	Retorna os tipos de telefone disponíveis.
Listar tipos de tempo não faturáveis	Retorna os tipos de quadro de horários não faturáveis disponíveis.
Listar tipos de trabalho	Retorna os tipos de trabalho de fluxo de trabalho disponíveis.
Listar trabalhos	Retorna uma lista paginada de trabalhos de fluxo de trabalho.
Listar títulos	Retorna os títulos disponíveis para clientes e contatos.
Listar usuários	Retorna uma lista paginada de usuários.
Obter campos personalizados por contexto	Retorna os campos personalizados definidos para um contexto: cliente, contato, trabalho ou tudo.
Obter cliente por ID	Retorna os detalhes de um cliente.
Obter mapeamento de cliente devedor	Retorna os clientes devedores mapeados para um cliente.
Obter trabalho por ID	Retorna os detalhes de um trabalho de fluxo de trabalho.
Tempo de log	Cria uma ou mais entradas de tempo de quadro de horários (até 20 por solicitação).

Atualizar cliente por ID

ID da operação:: updateAClient

Atualiza um cliente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	clientId	True	integer	Identificador de cliente.
entityType	entityType	True	string
clientCode	clientCode	True	string
saudação	salutation		string
title	title		string
firstName	firstName		string
nome do meio	middleName		string
lastName	lastName		string
trustName	trustName		string
tipoDeConfiança	trustType		string
CompanyName	companyName		string
nome de negociação	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
Perspectiva	prospect		boolean
preferredName	preferredName		string
dateofBirth	dateofBirth		date
placeOfBirth	placeOfBirth		string
dateOfDeath	dateOfDeath		date
deRegistrationDate	deRegistrationDate		date
startDate	startDate		date
data de término	endDate		date
Gênero	gender		string
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
email	email		string
preferido	preferred		boolean
favorito	favourite		boolean
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
countryId	countryId		integer
isdCode	isdCode		integer
número	number		string
preferido	preferred		boolean
favorito	favourite		boolean
linkedInProfileId	linkedInProfileId		string
site	website		string
annualReviewDate	annualReviewDate		date
formationDate	formationDate		date
addressType	addressType		string
unidade	unit		string
careOf	careOf		string
endereçoLinha1	addressLine1		string
endereçoLinha2	addressLine2		string
subúrbio	suburb		string
estado	state		string
country	country		string
Cp	postCode		string
setor	industry		string
função	role		string
salário	salary		string
annualIncome	annualIncome		string
isTaxClient	isTaxClient		boolean
isLodgeActivity	isLodgeActivity		boolean
Tfn	tfn		string
Abn	abn		string
Cna	acn		string
Din	din		string
taxAgent	taxAgent		string
Gst	gst		boolean
Residente	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

Retornos

Body: ResponseMessage

Atualizar contato

ID da operação:: updateAContact

Atualiza um contato por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de contato	contactId	True	integer	Identificador de contato.
saudação	salutation		string
title	title		string
firstName	firstName	True	string
nome do meio	middleName		string
lastName	lastName	True	string
Gênero	gender		string
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
email	email		string
preferido	preferred		boolean
favorito	favourite		boolean
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
countryId	countryId		integer
isdCode	isdCode		integer
número	number		string
preferido	preferred		boolean
favorito	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
unidade	unit		string
careOf	careOf		string
endereçoLinha1	addressLine1		string
endereçoLinha2	addressLine2		string
subúrbio	suburb		string
estado	state		string
country	country		string
Cp	postCode		string
id	id		integer
value	value		string
enumAddressTypes	enumAddressTypes		string

Retornos

Body: ResponseMessage

Atualizar grupo de clientes

ID da operação:: updateClientGroup

Atualiza um grupo de clientes por código de grupo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Código do grupo	groupCode	True	string	Código do grupo de clientes.
groupName	groupName		string
tags	tags		array of integer
clientId	clientId		integer
isDebitorClient	isDebitorClient		boolean
relationIds	relationIds		array of integer
contactId	contactId		integer
contexto	context		string

Retornos

Body: ResponseMessage

Atualizar grupo de tarefas de modelo

ID da operação:: updateTemplateTaskGroup

Renomeia um grupo de tarefas em um modelo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	integer	Identificador de modelo de trabalho.
ID do grupo de tarefas	taskgroupId	True	integer	Identificador do grupo de tarefas.
Nome do grupo de tarefas	taskgroupname	True	string	Nome do grupo de tarefas.

Retornos

Body: ResponseMessage

Atualizar grupo de tarefas de trabalho

ID da operação:: updateJobTaskGroup

Renomeia um grupo de tarefas em um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.
ID do grupo de tarefas	taskgroupId	True	integer	Identificador do grupo de tarefas.
Nome do grupo de tarefas	taskgroupname	True	string	Nome do grupo de tarefas.

Retornos

Body: ResponseMessage

Atualizar modelo de trabalho

ID da operação:: updateJobTemplate

Atualiza um modelo de trabalho de fluxo de trabalho por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	integer	Identificador de modelo de trabalho.
templateName	templateName		string
description	description		string
jobTypeId	jobTypeId		integer
Reviravolta	turnaround		integer

Retornos

Body: ResponseMessage

Atualizar o status e a prioridade do trabalho

ID da operação:: updateJobStatus

Atualiza o status e a prioridade de um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.
priority	priority		string
status	status		string
statusOwner	statusOwner		string

Retornos

Body: ResponseMessage

Atualizar o tipo de hora não faturável

ID da operação:: updateNonBillableTimesheetType

Atualiza um tipo de quadro de horários não faturável por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tipo não faturável	id	True	integer	Identificador de tipo de hora não faturável.
nome	name		string
description	description		string

Retornos

Body: ResponseMessage

Atualizar prioridade de trabalho

ID da operação:: updateJobPriority

Renomeia uma prioridade de trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de prioridade	priorityId	True	integer	Identificador de prioridade do trabalho.
Nome da prioridade	priorityName	True	string	Nome da prioridade do trabalho.

Retornos

Body: ResponseMessage

Atualizar status do tipo de trabalho

ID da operação:: updateJobTypeStatuses

Atualiza os status de um tipo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tipo de trabalho	jobtypeId	True	integer	Identificador de tipo de trabalho.
statusId	statusId		integer
statusCatId	statusCatId		integer
description	description		string
statusName	statusName		string

Retornos

Body: ResponseMessage

Atualizar tarefa de modelo

ID da operação:: updateTemplateTask

Atualiza uma tarefa em um grupo de tarefas de modelo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tarefa	taskId	True	integer	Identificador de tarefa.
templateId	templateId		integer
taskgroupId	taskgroupId		integer
taskTypeId	taskTypeId		integer
taskName	taskName		string
roleId	roleId		integer
unidade	unit		integer
taskCategory	taskCategory		string
startAfterDays	startAfterDays		integer
dueAfterDays	dueAfterDays		integer

Retornos

Body: ResponseMessage

Atualizar tarefa de trabalho

ID da operação:: updateJobTask

Atualiza uma tarefa em um grupo de tarefas de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da tarefa	taskId	True	integer	Identificador de tarefa.
jobId	jobId		integer
taskName	taskName		string
status	status		string
taskTypeId	taskTypeId		integer
taskgroupId	taskgroupId		integer
taskLevelRoleId	taskLevelRoleId		integer
userId	userId		string
unidade	unit		integer
taskCategory	taskCategory		string
startDate	startDate		date-time
data de vencimento	dueDate		date-time

Retornos

Body: ResponseMessage

Atualizar tipo de tarefa

ID da operação:: updateTaskType

Atualiza um tipo de tarefa por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tipo de tarefa	tasktypeId	True	integer	Identificador de tipo de tarefa.
taskType	taskType		string
description	description		string
taskCategory	taskCategory		string
enumTaskCategory	enumTaskCategory		string

Retornos

Body: ResponseMessage

Atualizar tipo de trabalho

ID da operação:: updateJobType

Atualiza um tipo de trabalho por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tipo de trabalho	id	True	integer	Identificador de tipo de trabalho.
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

Retornos

Body: ResponseMessage

Atualizar trabalho

ID da operação:: updateAJob

Atualiza um trabalho de fluxo de trabalho por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.
clientId	clientId		integer
divisionId	divisionId		integer
debtorclientId	debtorclientId		integer
jobTypeId	jobTypeId		integer
Jobcategory	jobCategory		string
Nome do Trabalho	jobName		string
financialYear	financialYear		integer
templateId	templateId		integer
managerId	managerId		string
partnerId	partnerId		string
startDate	startDate		date-time
data de vencimento	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

Retornos

Body: ResponseMessage

Criar cliente

ID da operação:: createClients

Cria um cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo
entityType	entityType	True	string
clientCode	clientCode	True	string
saudação	salutation		string
title	title		string
firstName	firstName		string
nome do meio	middleName		string
lastName	lastName		string
trustName	trustName		string
tipoDeConfiança	trustType		string
CompanyName	companyName		string
nome de negociação	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
Perspectiva	prospect		boolean
preferredName	preferredName		string
dateofBirth	dateofBirth		date
placeOfBirth	placeOfBirth		string
dateOfDeath	dateOfDeath		date
deRegistrationDate	deRegistrationDate		date
startDate	startDate		date
data de término	endDate		date
Gênero	gender		string
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
email	email		string
preferido	preferred		boolean
favorito	favourite		boolean
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
countryId	countryId		integer
isdCode	isdCode		integer
número	number		string
preferido	preferred		boolean
favorito	favourite		boolean
linkedInProfileId	linkedInProfileId		string
site	website		string
annualReviewDate	annualReviewDate		date
formationDate	formationDate		date
addressType	addressType		string
unidade	unit		string
careOf	careOf		string
endereçoLinha1	addressLine1		string
endereçoLinha2	addressLine2		string
subúrbio	suburb		string
estado	state		string
country	country		string
Cp	postCode		string
setor	industry		string
função	role		string
salário	salary		string
annualIncome	annualIncome		string
isTaxClient	isTaxClient		boolean
isLodgeActivity	isLodgeActivity		boolean
Tfn	tfn		string
Abn	abn		string
Cna	acn		string
Din	din		string
taxAgent	taxAgent		string
Gst	gst		boolean
Residente	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

Retornos

Body: ResponseMessage

Criar contato

ID da operação:: createContacts

Cria um contato.

Parâmetros

Nome	Chave	Obrigatório	Tipo
saudação	salutation		string
title	title		string
firstName	firstName	True	string
nome do meio	middleName		string
lastName	lastName	True	string
Gênero	gender		string
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
email	email		string
preferido	preferred		boolean
favorito	favourite		boolean
ID do tipo	typeId		integer
typeName	typeName		string
tipo	type		string
countryId	countryId		integer
isdCode	isdCode		integer
número	number		string
preferido	preferred		boolean
favorito	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
unidade	unit		string
careOf	careOf		string
endereçoLinha1	addressLine1		string
endereçoLinha2	addressLine2		string
subúrbio	suburb		string
estado	state		string
country	country		string
Cp	postCode		string
id	id		integer
value	value		string
enumAddressTypes	enumAddressTypes		string

Retornos

Body: ResponseMessage

Criar grupo de clientes

ID da operação:: createClientGroup

Cria um grupo de clientes.

Parâmetros

Nome	Chave	Tipo
groupName	groupName	string
tags	tags	array of integer
clientId	clientId	integer
isDebitorClient	isDebitorClient	boolean
relationIds	relationIds	array of integer
contactId	contactId	integer
contexto	context	string

Retornos

Body: ResponseMessage

Criar grupo de tarefas de modelo

ID da operação:: createTemplateTaskGroup

Cria um grupo de tarefas em um modelo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	integer	Identificador de modelo de trabalho.
Nome do grupo de tarefas	taskgroupname	True	string	Nome do grupo de tarefas.

Retornos

Body: ResponseMessage

Criar grupo de tarefas de trabalho

ID da operação:: createJobTaskGroup

Cria um grupo de tarefas em um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.
Nome do grupo de tarefas	taskgroupname	True	string	Nome do grupo de tarefas.

Retornos

Body: ResponseMessage

Criar modelo de trabalho

ID da operação:: createJobTemplate

Cria um modelo de trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Tipo
templateName	templateName	string
description	description	string
estimateType	estimateType	string
jobTypeId	jobTypeId	integer
Reviravolta	turnaround	integer

Retornos

Body: ResponseMessage

Criar prioridade de trabalho

ID da operação:: createJobPriority

Cria uma prioridade de trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome da prioridade	priorityName	True	string	Nome da prioridade do trabalho.

Retornos

Body: ResponseMessage

Criar tarefa de modelo

ID da operação:: createTemplateTask

Cria uma tarefa em um grupo de tarefas de modelo de trabalho.

Parâmetros

Nome	Chave	Tipo
templateId	templateId	integer
taskgroupId	taskgroupId	integer
taskTypeId	taskTypeId	integer
taskName	taskName	string
roleId	roleId	integer
unidade	unit	integer
taskCategory	taskCategory	string
startAfterDays	startAfterDays	integer
dueAfterDays	dueAfterDays	integer

Retornos

Body: ResponseMessage

Criar tarefa de trabalho

ID da operação:: createJobTasks

Cria uma tarefa em um grupo de tarefas de trabalho.

Parâmetros

Nome	Chave	Tipo
jobId	jobId	integer
taskName	taskName	string
status	status	string
taskTypeId	taskTypeId	integer
taskgroupId	taskgroupId	integer
taskLevelRoleId	taskLevelRoleId	integer
userId	userId	string
unidade	unit	integer
taskCategory	taskCategory	string
startDate	startDate	date-time
data de vencimento	dueDate	date-time

Retornos

Body: ResponseMessage

Criar tipo de hora não faturável

ID da operação:: createNonBillableTimesheetType

Cria um tipo de quadro de horários não faturável.

Parâmetros

Nome	Chave	Tipo
nome	name	string
description	description	string
tipo	type	string

Retornos

Body: ResponseMessage

Criar tipo de tarefa

ID da operação:: createTaskType

Cria um tipo de tarefa.

Parâmetros

Nome	Chave	Tipo
taskType	taskType	string
description	description	string
taskCategory	taskCategory	string
enumTaskCategory	enumTaskCategory	string

Retornos

Body: ResponseMessage

Criar tipo de trabalho

ID da operação:: createJobType

Cria um tipo de trabalho com seus status.

Parâmetros

Nome	Chave	Tipo
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

Retornos

Body: ResponseMessage

Criar trabalho

ID da operação:: createJobs

Cria um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Tipo
clientId	clientId	integer
divisionId	divisionId	integer
debtorclientId	debtorclientId	integer
jobTypeId	jobTypeId	integer
Jobcategory	jobCategory	string
Nome do Trabalho	jobName	string
financialYear	financialYear	integer
templateId	templateId	integer
managerId	managerId	string
partnerId	partnerId	string
startDate	startDate	date-time
data de vencimento	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

Retornos

Body: ResponseMessage

Listar categorias de status do trabalho

ID da operação:: getJobStatusCategories

Retorna as categorias de status do trabalho disponíveis.

Retornos

response: array of StatusCatagory

Listar clientes

ID da operação:: getClients

Retorna uma lista paginada de clientes.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
ID de Parceiro	partnerId	string	Filtrar por ID de parceiro (usuário).
Cliente de débito	isDebitClient	boolean	Filtrar pelo sinalizador de débito-cliente.
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).
Código do grupo	groupCode	string	Filtrar pelo código do grupo de clientes.
ID do cliente	clientId	integer	Filtrar por ID do cliente.
Campos personalizados	isCustomField	boolean	Inclua campos personalizados nos resultados.

Retornos

Body: Client_Result

Listar clientes disponíveis para agrupamento

ID da operação:: getValidClientsForGrouping

Retorna os clientes que podem ser adicionados a um grupo de clientes.

Retornos

response: array of ClientSummary

Listar contatos

ID da operação:: getContacts

Retorna uma lista paginada de contatos.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).
ID de contato	contactId	integer	Filtrar por ID de contato.
Filtro de ID do cliente	isClientId	boolean	Indica se o filtro de ID de contato deve ser tratado como uma ID do cliente.
Campos personalizados	isCustomField	boolean	Inclua campos personalizados nos resultados.

Retornos

Body: Contact_Result

Listar contatos de comunicação

ID da operação:: getClientCommunicationContacts

Retorna uma lista paginada de detalhes de contato de comunicação do cliente.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).

Retornos

Body: ContactsInfo_result

Listar contatos disponíveis para clientes

ID da operação:: getValidContactsForClients

Retorna os contatos que podem ser vinculados a um cliente.

Retornos

response: array of ClientContacts

Listar divisões

ID da operação:: getDivisions

Retorna uma lista paginada de divisões.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).

Retornos

Body: Divisions_Result

Listar entradas de quadro de horários

ID da operação:: getTimesheets

Retorna uma lista paginada de entradas de tempo do quadro de horários.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Status	status	string	Filtrar entradas de quadro de horários por status.
ID do trabalho	jobId	integer	Filtrar por ID do trabalho.
ID da tarefa	taskId	integer	Filtrar por ID da tarefa.
ID do cliente	clientId	integer	Filtrar por ID do cliente.
Data Inicial	fromDate	string	Retornar entradas em ou após esta data (yyy-MM-dd). Se nenhuma data for fornecida, hoje será usado.
Data final	toDate	string	Retornar entradas em ou antes desta data (yyy-MM-dd).
Faturável	isbillable	boolean	Filtrar por entradas faturáveis (true) ou não faturáveis (false).

Retornos

Body: TimeSheet_Result

Listar equipes

ID da operação:: getTeams

Retorna as equipes disponíveis.

Retornos

response: array of Teams

Listar faturas

ID da operação:: getInvoices

Retorna uma lista paginada de faturas.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Fatura de rascunho	isDraftInvoice	boolean	Filtrar pelo sinalizador de rascunho de fatura.
Incluir detalhes da fatura	includeInvoiceDetails	boolean	Inclua registros de detalhes da fatura nos resultados.
Status	status	string	Filtrar faturas por status.
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).
Cliente de débito	isDebitClient	boolean	Filtrar pelo sinalizador de débito-cliente.
Nome do cliente	clientname	string	Filtrar pelo nome do cliente.
Código do cliente	clientcode	string	Filtrar por código do cliente.
Nome do trabalho	jobname	string	Filtrar por nome do trabalho.
Código do trabalho	jobcode	string	Filtrar por código de trabalho.
ID da entidade de cobrança	billingEntityId	string	Filtrar por ID da entidade de cobrança.

Retornos

Body: InvoiceDetail_Result

Listar funções

ID da operação:: getUserRoles

Retorna as funções de usuário disponíveis.

Retornos

response: array of Roledetails

Listar gerentes de cliente

ID da operação:: getClientAreaManagers

Retorna os usuários que podem ser selecionados como gerente em um cliente.

Retornos

response: array of UserModel

Listar gerentes de trabalho

ID da operação:: getJobAreaManagers

Retorna os usuários que podem ser selecionados como gerente em um trabalho.

Retornos

response: array of UserModel

Listar grupos de clientes

ID da operação:: getClientGroups

Retorna uma lista de páginas de grupos de clientes e seus clientes membros.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Código do grupo	groupCode	string	Filtrar pelo código do grupo de clientes.
Código do cliente	clientCode	string	Filtrar por código do cliente.

Retornos

Body: ClientGroup_Result

Listar grupos de tarefas de modelo

ID da operação:: getTemplateTaskGroups

Retorna os grupos de tarefas e as tarefas de um modelo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	integer	Identificador de modelo de trabalho.

Retornos

response: array of CompositeTemplateTaskGroupViewModel

Listar grupos de tarefas de trabalho

ID da operação:: getJobTaskGroups

Retorna os grupos de tarefas de um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.

Retornos

response: array of ClientProfileTaskGroupData

Listar marcas de cliente

ID da operação:: getClientsTags

Retorna as marcas de cliente disponíveis.

Retornos

response: array of TagModel

Listar modelos de trabalho

ID da operação:: getJobTemplates

Retorna os modelos de trabalho de fluxo de trabalho disponíveis.

Retornos

response: array of JobTemplate

Listar parceiros cliente

ID da operação:: getClientAreaPartners

Retorna os usuários que podem ser selecionados como parceiros em um cliente.

Retornos

response: array of UserModel

Listar parceiros de trabalho

ID da operação:: getJobAreaPartners

Retorna os usuários que podem ser selecionados como parceiros em um trabalho.

Retornos

response: array of UserModel

Listar países

ID da operação:: getCountries

Retorna os países disponíveis.

Retornos

response: array of Country

Listar prioridades de trabalho

ID da operação:: getJobPriorities

Retorna as prioridades de trabalho de fluxo de trabalho disponíveis.

Retornos

response: array of JobPriority

Listar relações de cliente

ID da operação:: getClientRelationships

Retorna uma lista paginada de relações para um cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Página	page		integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize		integer	Número de itens a serem retornados por página (máximo de 1000).
ID do cliente	clientId	True	integer	Identificador de cliente.

Retornos

Body: Relationships_Result

Listar saudações

ID da operação:: getClientSalutations

Retorna as saudações disponíveis para clientes e contatos.

Retornos

response: array of Salutation

Listar setores

ID da operação:: getClientIndustries

Retorna os nomes do setor que podem ser atribuídos a um cliente.

Retornos

Nome	Caminho	Tipo	Description
		array of string

Listar status de tipo de trabalho

ID da operação:: getJobTypeStatus

Retorna os status de tipo de trabalho de fluxo de trabalho disponíveis.

Retornos

response: array of JobTypeStatus

Listar tarefas

ID da operação:: getTasks

Retorna uma lista paginada de tarefas de trabalho.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Status	status	string	Filtrar tarefas por status.
ID do atribuídor	assigneeId	string	Filtre tarefas pela ID do usuário atribuído.
Dias até o vencimento	daysUntilDue	integer	Filtre as tarefas pelo número de dias até que elas sejam concluídas.
ID do trabalho	jobId	integer	Filtrar por ID do trabalho.

Retornos

Body: Tasks_Result

Listar tarefas do grupo de tarefas de trabalho

ID da operação:: getJobTaskGroupTasks

Retorna as tarefas em um grupo de tarefas de um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.
ID do grupo de tarefas	taskgroupId	True	integer	Identificador do grupo de tarefas.

Retornos

response: array of ClientProfileTask

Listar tarefas do grupo de tarefas do modelo

ID da operação:: getTemplateTaskGroupTasks

Retorna um grupo de tarefas e suas tarefas para um modelo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Modelo	templateId	True	integer	Identificador de modelo de trabalho.
ID do grupo de tarefas	taskgroupId	True	integer	Identificador do grupo de tarefas.

Retornos

response: array of CompositeTemplateTaskGroupViewModel

Listar tipos de email

ID da operação:: getEmailTypes

Retorna os tipos de email disponíveis.

Retornos

response: array of EmailType

Listar tipos de impostos

ID da operação:: getInvoiceTaxTypes

Retorna os tipos de impostos disponíveis para faturas.

Retornos

response: array of TaxTypes

Listar tipos de telefone

ID da operação:: getPhoneTypes

Retorna os tipos de telefone disponíveis.

Retornos

response: array of PhoneType

Listar tipos de tempo não faturáveis

ID da operação:: getNonBillableTimesheetTypes

Retorna os tipos de quadro de horários não faturáveis disponíveis.

Retornos

response: array of Leave

Listar tipos de trabalho

ID da operação:: getJobTypes

Retorna os tipos de trabalho de fluxo de trabalho disponíveis.

Retornos

response: array of JobType

Listar trabalhos

ID da operação:: getJobs

Retorna uma lista paginada de trabalhos de fluxo de trabalho.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
ID de Parceiro	partnerId	string	Filtrar por ID de parceiro (usuário).
Nome do cliente	clientName	string	Filtrar pelo nome do cliente.
Código do cliente	clientcode	string	Filtrar por código do cliente.
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).
Cliente de débito	isDebitClient	boolean	Filtrar pelo sinalizador de débito-cliente.
Campos personalizados	isCustomField	boolean	Inclua campos personalizados nos resultados.

Retornos

Body: Jobs_Result

Listar títulos

ID da operação:: getClientTitles

Retorna os títulos disponíveis para clientes e contatos.

Retornos

response: array of Title

Listar usuários

ID da operação:: getUsers

Retorna uma lista paginada de usuários.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Número da página resultados, começando em 1.
Tamanho da página	pageSize	integer	Número de itens a serem retornados por página (máximo de 1000).
Modificado desde	modifiedSince	string	Retornar registros modificados em ou após este carimbo de data/hora (ISO 8601).
Nome da função	rolename	string	Filtrar usuários por nome de função.

Retornos

Body: Users_Result

Obter campos personalizados por contexto

ID da operação:: getFirmCustomfields

Retorna os campos personalizados definidos para um contexto: cliente, contato, trabalho ou tudo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Contexto	context	True	string	Contexto de campo personalizado: cliente, contato, trabalho ou tudo.

Obter cliente por ID

ID da operação:: getAClient

Retorna os detalhes de um cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	clientId	True	integer	Identificador de cliente.
Campos personalizados	isCustomField		boolean	Inclua campos personalizados nos resultados.

Retornos

Body: ClientDetails_Result

Obter mapeamento de cliente devedor

ID da operação:: getClientsDebtor

Retorna os clientes devedores mapeados para um cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	clientId	True	integer	Identificador de cliente.

Retornos

response: array of ClientDebtor

Obter trabalho por ID

ID da operação:: getAJob

Retorna os detalhes de um trabalho de fluxo de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do trabalho	jobId	True	integer	Identificador de trabalho de fluxo de trabalho.

Retornos

response: array of JobData

Tempo de log

ID da operação:: createTimesheet

Cria uma ou mais entradas de tempo de quadro de horários (até 20 por solicitação).

Parâmetros

Nome	Chave	Tipo
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
hora de início	starttime	time
unidades	units	double
timeSheetTime	timeSheetTime	time
Velocidade	rate	double
description	description	string

Retornos

response: array of PostJobLogTimeResponse

Definições

Endereço

Nome	Caminho	Tipo
addressType	addressType	string
unidade	unit	string
careOf	careOf	string
endereçoLinha1	addressLine1	string
endereçoLinha2	addressLine2	string
subúrbio	suburb	string
estado	state	string
country	country	string
Cp	postCode	string

Client

Nome	Caminho	Tipo
codificar	code	string
saudação	salutation	string
title	title	string
nome	name	string
firstName	firstName	string
nome do meio	middleName	string
lastName	lastName	string
Gênero	gender	string
preferredName	preferredName	string
mailingName	mailingName	string
tradingAs	tradingAs	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
divisão	division	Division
entityType	entityType	string
setor	industry	string
parceiro	partner	Staff
gerente	manager	Staff
contacts	contacts	array of Contact
addresses	addresses	array of Address
Cna	acn	string
Abn	abn	string
Tfn	tfn	string
Din	din	string
gstRegistered	gstRegistered	boolean
taxClient	taxClient	boolean
isProspect	isProspect	boolean
criado	created	string
últimaModificação	lastModified	string
wip	wip	string
local	location	string
status	status	string
agrupar	group	Group
debtorClient	debtorClient	string
clientBrefcode	clientBrefcode	string
billercode	billercode	string
placeOfBirth	placeOfBirth	string
tipoDeConfiança	trustType	string
dateOfDeath	dateOfDeath	string
formationDate	formationDate	string
annualReviewDate	annualReviewDate	string
deRegistrationDate	deRegistrationDate	string
startDate	startDate	string
data de término	endDate	string
id	id	integer
tags	tags	array of tag
customFields	customFields	array of CustomField

ClientContacts

Nome	Caminho	Tipo
clientid	clientid	integer
contactid	contactid	integer
contactName	contactName	string
contexto	context	string

ClientDebtor

Nome	Caminho	Tipo
debtorid	debtorid	integer
nome do devedor	debtorname	string
groupCode	groupCode	string
clientid	clientid	integer
clientType	clientType	string
isSeflDebtor	isSeflDebtor	boolean

ClientDetails

Nome	Caminho	Tipo
codificar	code	string
saudação	salutation	string
title	title	string
nome	name	string
firstName	firstName	string
nome do meio	middleName	string
lastName	lastName	string
Gênero	gender	string
preferredName	preferredName	string
mailingName	mailingName	string
tradingAs	tradingAs	string
dateOfBirth	dateOfBirth	string
email	email	array of Email
phone	phone	array of Phone
divisão	division	Division
entityType	entityType	string
setor	industry	string
parceiro	partner	Staff
gerente	manager	Staff
contacts	contacts	array of Contact
addresses	addresses	array of Address
Cna	acn	string
Abn	abn	string
gstRegistered	gstRegistered	boolean
taxClient	taxClient	boolean
isProspect	isProspect	boolean
criado	created	string
últimaModificação	lastModified	string
wip	wip	string
local	location	string
status	status	string
agrupar	group	Group
debtorClient	debtorClient	string
clientBrefcode	clientBrefcode	string
billercode	billercode	string
placeOfBirth	placeOfBirth	string
tipoDeConfiança	trustType	string
dateOfDeath	dateOfDeath	string
formationDate	formationDate	string
annualReviewDate	annualReviewDate	string
deRegistrationDate	deRegistrationDate	string
startDate	startDate	string
data de término	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

Nome	Caminho	Tipo	Description
cliente	client	array of ClientDetails

ClientGroup_Result

Nome	Caminho	Tipo	Description
clientGroups	clientGroups	array of GroupClients
paginação	pagination	Pagination

ClientProfileTask

Nome	Caminho	Tipo
taskId	taskId	integer
taskGroupId	taskGroupId	integer
taskTitle	taskTitle	string
description	description	string
startDate	startDate	date-time
data de vencimento	dueDate	date-time
status	status	string
destinatário	assignee	string
priority	priority	string
contextId	contextId	integer
contextType	contextType	string
Lembretes	reminders	string
createdBy	createdBy	string
criado	created	string
lastmodified	lastmodified	string
jobTypeId	jobTypeId	integer
taskType	taskType	integer
unidade	unit	integer
totalUnit	totalUnit	integer
roleId	roleId	integer
roleName	roleName	string
sequência	sequence	integer
assigneeUserDetails	assigneeUserDetails	array of TaskAssigneeUserDetails
isChecked	isChecked	boolean
documentsCount	documentsCount	integer
clientId	clientId	integer
taskCategory	taskCategory	TaskCategory
taskDependencyCount	taskDependencyCount	integer

ClientProfileTaskGroupData

Nome	Caminho	Tipo
taskGroupId	taskGroupId	integer
jobId	jobId	integer
taskGroupName	taskGroupName	string
sequência	sequence	integer
createdBy	createdBy	string
criado	created	string
lastmodified	lastmodified	string
taskCount	taskCount	integer
isTaskAllCheck	isTaskAllCheck	boolean
isSubTaskAllCheck	isSubTaskAllCheck	boolean
tarefas	tasks	array of ClientProfileTask
statusCount	statusCount	StatusCount
Cessionários	assignees	string

ClientSummary

Nome	Caminho	Tipo
id	id	integer
codificar	code	string
nome	name	string

Client_Result

Nome	Caminho	Tipo	Description
clients	clients	array of Client
paginação	pagination	Pagination

CompositeTemplateTaskGroupViewModel

Nome	Caminho	Tipo	Description
taskGroup	taskGroup	TaskTemplateGroupList
tarefas	tasks	array of TaskTemplateViewDetailModel

Contato

Nome	Caminho	Tipo
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

Nome	Caminho	Tipo
saudação	salutation	string
title	title	string
firstName	firstName	string
nome do meio	middleName	string
lastName	lastName	string
Gênero	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
criado	created	string
últimaModificação	lastModified	string
addresses	addresses	array of Address
nome	name	string
local	location	string
contexto	context	string
customFields	customFields	array of CustomField

Contact_Result

Nome	Caminho	Tipo	Description
contacts	contacts	array of ContactEntity
paginação	pagination	Pagination

ContactsInfo

Nome	Caminho	Tipo
contactId	contactId	integer
contextType	contextType	integer
systemId	systemId	string
codificar	code	string
title	title	string
nome	name	string
saudação	salutation	string
preferredName	preferredName	string
email	email	string
phone	phone	string
weburl	weburl	string
últimaModificação	lastModified	string

ContactsInfo_result

Nome	Caminho	Tipo	Description
communicationcontacts	communicationcontacts	array of ContactsInfo
paginação	pagination	Pagination

Country

Nome	Caminho	Tipo
countryId	countryId	integer
codificar	code	string
nome	name	string
isdCode	isdCode	integer

CustomField

Nome	Caminho	Tipo	Description
id	id	integer
value	value	string

DebtorClient

Nome	Caminho	Tipo
id	id	integer
codificar	code	string
nome	name	string

Divisão

Nome	Caminho	Tipo	Description
id	id	integer
nome	name	string

DivisionWithDetails

Nome	Caminho	Tipo
id	id	integer
nome	name	string
billingEntityName	billingEntityName	string
billingEntityId	billingEntityId	string
lastModifiedAt	lastModifiedAt	string

Divisionext

Nome	Caminho	Tipo
id	id	integer
nome	name	string
billingEntityName	billingEntityName	string
billingEntityId	billingEntityId	string
lastModifiedAt	lastModifiedAt	string
lastModifiedBy	lastModifiedBy	string
criado	created	string

Divisions_Result

Nome	Caminho	Tipo	Description
Divisões	divisions	array of Divisionext
paginação	pagination	Pagination

Email

Nome	Caminho	Tipo
ID do tipo	typeId	integer
typeName	typeName	string
tipo	type	string
email	email	string
preferido	preferred	boolean
favorito	favourite	boolean

EmailType

Nome	Caminho	Tipo
emailTypeId	emailTypeId	integer
emailTypeName	emailTypeName	string
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

EntityInfo

Nome	Caminho	Tipo	Description
id	id	integer
nome	name	string

Grupo

Nome	Caminho	Tipo
id	id	integer
codificar	code	string
nome	name	string

GroupClient

Nome	Caminho	Tipo
clientId	clientId	integer
entityType	entityType	string
clientCode	clientCode	string
clientname	clientname	string
isDebtorClient	isDebtorClient	boolean
debtorClientId	debtorClientId	integer

GroupClients

Nome	Caminho	Tipo
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
criado	created	string
lastmodified	lastmodified	string

Membro do Grupo

Nome	Caminho	Tipo
groupId	groupId	integer
memberId	memberId	string
nome	name	string
roleName	roleName	string

InvoiceDetail_Result

Nome	Caminho	Tipo	Description
invoices	invoices	array of InvoiceDetails
paginação	pagination	Pagination

InvoiceDetails

Nome	Caminho	Tipo
id	id	integer
número	number	string
refNo	refNo	string
tipo	type	string
date	date	string
para conclusão	due	string
totalPayable	totalPayable	double
taxName	taxName	string
taxa de impostos	taxRate	double
Gst	gst	double
pagamento	payment	double
creditNote	creditNote	double
creditAdjustment	creditAdjustment	double
feeReversal	feeReversal	double
badDebt	badDebt	double
saldo	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
linhas de fatura	invoiceLines	array of InvoiceLines
invoiceJobs	invoiceJobs	array of JobInvoice
criado	created	string
últimaModificação	lastModified	string
templateName	templateName	string

InvoiceLines

Nome	Caminho	Tipo
id	id	integer
Número da linha	lineNumber	integer
lineDescription	lineDescription	string
Linetotal	lineTotal	double

JobData

Nome	Caminho	Tipo
id	id	integer
jobCode	jobCode	string
jobType	jobType	string
nome	name	string
priority	priority	string
data de vencimento	dueDate	string
estimatedTime	estimatedTime	double
wip	wip	double
cliente	client	ClientSummary
financialYear	financialYear	string
frequência	frequency	string
period	period	string
parceiro	partner	Staff
gerente	manager	Staff
divisão	division	DivisionWithDetails
criado	created	string
últimaModificação	lastModified	string
debtorClient	debtorClient	DebtorClient
status	status	string
statusCategory	statusCategory	string
statusOwner	statusOwner	UserDetail
completedTask	completedTask	integer
totalTask	totalTask	integer
tarefas	tasks	array of TaskDetail
Cessionários	assignees	array of UserDetail
equipe	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

Nome	Caminho	Tipo
id	id	integer
código de trabalho	jobcode	string
nome	name	string
wip	wip	double
cliente	client	ClientSummary
financialYear	financialYear	string
parceiro	partner	Staff
gerente	manager	Staff
divisão	division	DivisionWithDetails
criado	created	string
últimaModificação	lastModified	string
debtorClient	debtorClient	string
invoiceid	invoiceid	integer

JobPriority

Nome	Caminho	Tipo
jobPriorityId	jobPriorityId	integer
jobPriorityName	jobPriorityName	string
createdBy	createdBy	string
últimaModificação	lastModified	string

Modelo de trabalho

Nome	Caminho	Tipo
templateId	templateId	integer
templateName	templateName	string
description	description	string
estimateType	estimateType	string
Reviravolta	turnaround	integer
jobTypeId	jobTypeId	integer
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

Tipo de Trabalho

Nome	Caminho	Tipo
jobTypeId	jobTypeId	integer
jobTypeName	jobTypeName	string
description	description	string
divisionId	divisionId	integer
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

JobTypeStatus

Nome	Caminho	Tipo
jobTypeId	jobTypeId	integer
statusId	statusId	integer
statusName	statusName	string
categoryId	categoryId	integer
categoryName	categoryName	string

Jobdetail

Nome	Caminho	Tipo
id	id	integer
jobCode	jobCode	string
jobType	jobType	string
nome	name	string
priority	priority	string
data de vencimento	dueDate	string
estimatedTime	estimatedTime	double
wip	wip	double
cliente	client	ClientSummary
financialYear	financialYear	string
frequência	frequency	string
period	period	string
parceiro	partner	Staff
gerente	manager	Staff
divisão	division	DivisionWithDetails
criado	created	string
últimaModificação	lastModified	string
debtorClient	debtorClient	DebtorClient
status	status	string
statusCategory	statusCategory	string
statusOwner	statusOwner	UserDetail
completedTask	completedTask	integer
totalTask	totalTask	integer
tarefas	tasks	array of TaskDetail
Cessionários	assignees	array of UserDetail
equipe	team	TaskDetail
customFields	customFields	array of CustomField
archivedAt	archivedAt	string

Jobs_Result

Nome	Caminho	Tipo	Description
jobs	jobs	array of Jobdetail
paginação	pagination	Pagination

Sair

Nome	Caminho	Tipo
id	id	integer
nome	name	string
description	description	string
tipo	type	string
estáAtivo	isActive	boolean
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

Pagination

Nome	Caminho	Tipo
total_de_registros	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

Telefone

Nome	Caminho	Tipo
ID do tipo	typeId	integer
typeName	typeName	string
tipo	type	string
countryId	countryId	integer
isdCode	isdCode	integer
número	number	string
preferido	preferred	boolean
favorito	favourite	boolean

PhoneType

Nome	Caminho	Tipo
phoneTypeId	phoneTypeId	integer
phoneTypeName	phoneTypeName	string
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

PostJobLogTimeResponse

Nome	Caminho	Tipo
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
hora de início	starttime	time
unidades	units	double
timeSheetTime	timeSheetTime	time
Velocidade	rate	double
description	description	string
rowNumber	rowNumber	integer
logTimeId	logTimeId	integer
isSuccess	isSuccess	boolean
mensagem	message	string

Relação

Nome	Caminho	Tipo
relationshipId	relationshipId	string
tipo	type	string
entityId	entityId	string
nome	name	string
entidade	entity	string
startDate	startDate	string
data de término	endDate	string
unidades	units	integer

Relationships_Result

Nome	Caminho	Tipo	Description
relationships	relationships	array of Relationship
paginação	pagination	Pagination

ResponseMessage

Nome	Caminho	Tipo
id	id	string
status	status	string
mensagem	message	string
currentDate	currentDate	date-time

RoleUnit

Nome	Caminho	Tipo	Description
roleId	roleId	integer
unidade	unit	integer

Roledetails

Nome	Caminho	Tipo
roleId	roleId	integer
accountingFirmId	accountingFirmId	integer
roleName	roleName	string
defaultRoleName	defaultRoleName	string
description	description	string
isSystem	isSystem	boolean

Saudação

Nome	Caminho	Tipo	Description
id	id	integer
saudação	salutation	string

Equipe

Nome	Caminho	Tipo
id	id	string
nome	name	string
email	email	string

StatusCatagory

Nome	Caminho	Tipo	Description
id	id	integer
nome	name	string

StatusCount

Nome	Caminho	Tipo
notStartedCount	notStartedCount	integer
inProgressCount	inProgressCount	integer
onHoldCount	onHoldCount	integer
reviewCount	reviewCount	integer
completedCount	completedCount	integer
contagem total	totalCount	integer

TagModel

Nome	Caminho	Tipo
id	id	integer
nome	name	string
isDisabled	isDisabled	boolean
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

TaskAssigneeUserDetails

Nome	Caminho	Tipo
userId	userId	string
taskId	taskId	integer
shortName	shortName	string
fullName	fullName	string
cost	cost	double
Velocidade	rate	double
time	time	double
unidade	unit	integer
totalUnit	totalUnit	integer
isFirstUserForRole	isFirstUserForRole	boolean
roleId	roleId	integer
roleName	roleName	string

Categoria de Tarefa

: string

TaskDetail

Nome	Caminho	Tipo	Description
id	id	integer
nome	name	string

TaskModel

Nome	Caminho	Tipo
taskId	taskId	integer
taskName	taskName	string
jobId	jobId	integer
Nome do Trabalho	jobName	string
gerenciador de trabalhos	jobManager	Staff
jobPartner	jobPartner	Staff
jobClient	jobClient	clientInfo
jobDebtor	jobDebtor	clientInfo
jobDivision	jobDivision	EntityInfo
Cessionários	assignees	array of Staff
taskType	taskType	string
startDate	startDate	date-time
data de vencimento	dueDate	date-time
daysUntilDue	daysUntilDue	string
taskCategory	taskCategory	string
status	status	string
createdBy	createdBy	string
criado	created	string
últimaModificação	lastModified	string

TaskTemplateGroupList

Nome	Caminho	Tipo
templateId	templateId	integer
taskgroupId	taskgroupId	integer
taskGroupName	taskGroupName	string
Createdby	createdBY	string
criado	created	string
lastmodified	lastmodified	string

TaskTemplateViewDetailModel

Nome	Caminho	Tipo
taskId	taskId	integer
taskgroupId	taskgroupId	integer
taskType	taskType	string
taskTypeId	taskTypeId	integer
sequência	sequence	integer
taskName	taskName	string
keyFlag	keyFlag	string
createdBy	createdBy	string
criado	created	string
lastmodified	lastmodified	string
roleId	roleId	integer
templateId	templateId	integer
unidade	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

Nome	Caminho	Tipo	Description
tarefas	tasks	array of TaskModel
paginação	pagination	Pagination

TaxTypes

Nome	Caminho	Tipo
taxId	taxId	integer
taxName	taxName	string
taxa de impostos	taxRate	double
effectiveFrom	effectiveFrom	string
effectiveTo	effectiveTo	string
isDefault	isDefault	boolean
criado	created	string
últimaModificação	lastModified	string

Teams

Nome	Caminho	Tipo
groupId	groupId	integer
teamId	teamId	integer
nome	name	string
groupMembers	groupMembers	array of GroupMember

TimeSheetLogs

Nome	Caminho	Tipo
isbillable	isbillable	boolean
jobId	jobId	integer
taskId	taskId	integer
nonbillableId	nonbillableId	integer
date	date	date
hora de início	starttime	time
unidades	units	double
timeSheetTime	timeSheetTime	time
Velocidade	rate	double
description	description	string
clientId	clientId	integer
logTimeId	logTimeId	integer
userId	userId	string
createdBy	createdBy	string
criado	created	string
status	status	string

TimeSheet_Result

Nome	Caminho	Tipo	Description
quadros de horários	timeSheets	array of TimeSheetLogs
paginação	pagination	Pagination

Title

Nome	Caminho	Tipo	Description
id	id	integer
title	title	string

UserDetail

Nome	Caminho	Tipo	Description
id	id	string
nome	name	string

UserModel

Nome	Caminho	Tipo
id	id	string
nome	name	string
roleName	roleName	string
firstName	firstName	string
lastName	lastName	string

UsersWithDetails

Nome	Caminho	Tipo
id	id	string
nome	name	string
roleName	roleName	string
firstName	firstName	string
lastName	lastName	string
email	email	Email
phone	phone	Phone
address	address	Address
criado	created	string
últimaModificação	lastModified	string

Users_Result

Nome	Caminho	Tipo	Description
users	users	array of UsersWithDetails
paginação	pagination	Pagination

clientInfo

Nome	Caminho	Tipo
id	id	integer
nome	name	string
codificar	code	string

groupContact

Nome	Caminho	Tipo
id	id	integer
nome	name	string
contextType	contextType	integer

marca

Nome	Caminho	Tipo	Description
tagId	tagId	integer
tagName	tagName	string