KC (Pré-visualização)

A KC Practice Management permite o acesso seguro a dados de clientes e empresas, permitindo aos utilizadores recuperar e gerir informação de forma eficiente através de fluxos de trabalho automatizados.

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

Serviço Class Regions
Estúdio Copiloto Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões Power Apps exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contact
Name Suporte Kloud Connect
URL https://www.kloudconnect.com.au/
Email support@kloudconnect.com.au
Metadados do conector
Editor Kloud Connect
Sítio Web https://www.kloudconnect.com.au/
Política de privacidade https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf
Categorias Gestão Empresarial; Finanças

Gestão da Prática Kloud Connect

Descrição geral

Isto proporciona acesso às APIs de Gestão de Práticas do Kloud Connect.

Características

  • Lista de clientes
  • Criar Clientes
  • Listar Contatos
  • Criar Contactos
  • Listar faturas
  • Criar Folha de Horas
  • Lista de Tarefas
  • Criar Tarefas
  • Listar Vagas
  • Criar Empregos
  • Aceder a dados de gestão de práticas

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 contacto por identificação.
Atualizar o estado e a prioridade do emprego

Atualiza o estado e a prioridade para trabalhos de workflow.
Atualizar o grupo do cliente

Atualiza o código de um cliente grupo a grupo.
Criar cliente

Cria um cliente.
Criar grupo de clientes

Cria um grupo cliente.
Criar trabalho

Cria um trabalho de fluxo de trabalho.
Divisões de lista

Devolve uma lista paginada das divisões.
Lista de clientes

Devolve uma lista de clientes paginada.
Lista de utilizadores

Devolve uma lista paginada de utilizadores.
Lista prioridades do trabalho

Devolve as prioridades de trabalho disponíveis para o fluxo de trabalho.
Listar as relações com os clientes

Devolve uma lista paginada das relações com clientes.
Listar contatos

Devolve uma lista de contactos paginada.
Listar equipas

Devolve as equipas disponíveis.
Listar estados do tipo de trabalho

Devolve os estados disponíveis dos tipos de trabalho do fluxo de trabalho.
Listar etiquetas de cliente

Devolve as etiquetas de cliente disponíveis.
Listar faturas

Devolve uma lista de faturas paginada.
Listar vagas

Devolve uma lista paginada de trabalhos de workflow.
Listas de modelos de emprego

Devolve os modelos de trabalho de workflow disponíveis.
Listas de tipos de funções

Devolve os tipos de trabalho disponíveis para o fluxo de trabalho.
Liste os tipos de tempo não faturáveis

Devolve os tipos de folhas de horas não faturáveis disponíveis.
Obtenha campos personalizados por contexto

Devolve campos personalizados para o contexto especificado.
Obtenha o cliente por ID

Dados de devolução para um cliente por identificação.
Obtenha o mapeamento dos clientes devedores

Devolve o mapeamento do cliente devedor para um cliente.
obter Grupos de Clientes

obter Grupos de Clientes
Tarefa de atualização

Atualiza um trabalho de fluxo de trabalho por ID.
Tempo de registo

Cria uma folha de pontos, introdução de horas.

Atualizar cliente por ID

ID da Operação:
updateAClient

Atualiza um cliente por ID.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID de Cliente
 clientId True integer

Identificador do cliente.
tipo de entidade
 entityType True string
ClientCode
 clientCode True string
saudação
 salutation string
firstName
 firstName string
Nome do meio
 middleName string
lastName
 lastName string
trustName
 trustName string
tipoDeConfiança
 trustType string
Nome da empresa
 companyName string
Nome da negociação
 tradingName string
Nome da parceria
 partnershipName string
smsfName
 smsfName string
softwareType
 softwareType string
softwareName
 softwareName string
ID do parceiro
 partnerId True string
managerId
 managerId string
divisionId
 divisionId True integer
Prospecto
 prospect boolean
preferredName
 preferredName string
data de nascimento
 dateofbirth date-time
lugarOfBirth
 placeOfBirth string
Género
 gender string
tipo
 type string
e-mail
 email string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
tipo
 type string
number
 number string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
linkedInProfileId
 linkedInProfileId string
site
 website string
Data de Revisão Anual
 annualReviewDate date-time
Data de formação
 formationDate date-time
addressType
 addressType string
unidade
 unit string
cuidadosOf
 careOf string
endereçoLine1
 addressLine1 string
endereçoLine2
 addressLine2 string
subúrbio
 suburb string
state
 state string
país
 country string
Código postal
 postCode string
indústria
 industry string
função
 role string
salário
 salary string
Rendimento anual
 annualIncome string
isTaxClient
 isTaxClient boolean
isLodgeActivity
 isLodgeActivity boolean
tfn
 tfn integer
ABN
 abn integer
pode
 acn integer
Din
 din integer
taxAgent
 taxAgent string
gst
 gst boolean
residente
 resident boolean
nome_do-banco
 bankName string
NomeContaBancária
 bankAccountName string
bankBSB
 bankBSB integer
BankAccountNumber
 bankAccountNumber integer
contactId
 contactId integer
ContactType
 contactType string
id
 id integer
value
 value string
enumEntityTypes
 enumEntityTypes string
enumTrustTypes
 enumTrustTypes string
enumGénero
 enumGender string
enumEmailTypes
 enumEmailTypes string
enumPhoneTypes
 enumPhoneTypes string
enumContactTypes
 enumContactTypes string
enumAddressTypes
 enumAddressTypes string

Atualizar contato

ID da Operação:
updateAContact

Atualiza um contacto por identificação.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID de contato
 contactId True integer

Identificador de contacto.
saudação
 salutation string
firstName
 firstName True string
Nome do meio
 middleName string
lastName
 lastName True string
Género
 gender string
tipo
 type string
number
 number string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
tipo
 type string
e-mail
 email string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
Nome da empresa
 companyName string
lugarOfBirth
 placeOfBirth string
linkedInProfileID
 linkedInProfileID string
preferredName
 preferredName string
Din
 din string
dateOfBirth
 dateOfBirth date-time
isImportent
 isImportent boolean
addressType
 addressType string
unidade
 unit string
cuidadosOf
 careOf string
endereçoLine1
 addressLine1 string
endereçoLine2
 addressLine2 string
subúrbio
 suburb string
state
 state string
país
 country string
Código postal
 postCode string
id
 id integer
value
 value string
enumAddressTypes
 enumAddressTypes string

Atualizar o estado e a prioridade do emprego

ID da Operação:
updateJobStatuses

Atualiza o estado e a prioridade para trabalhos de workflow.

Parâmetros

Name Chave Obrigatório Tipo Descrição
jobId
 jobId integer
priority
 priority string
estado
 status string
EstadoProprietário
 statusOwner string

Atualizar o grupo do cliente

ID da Operação:
updateClientGroup

Atualiza o código de um cliente grupo a grupo.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Código do grupo
 groupCode True string

Código do grupo de clientes.
groupName
 groupName string
ID do parceiro
 partnerId string
tags
 tags array of integer
clientId
 clientId integer
isDebitorClient
 isDebitorClient boolean
relationIds
 relationIds array of integer
contactId
 contactId integer

Criar cliente

ID da Operação:
createClients

Cria um cliente.

Parâmetros

Name Chave Obrigatório Tipo Descrição
tipo de entidade
 entityType True string
ClientCode
 clientCode True string
saudação
 salutation string
firstName
 firstName string
Nome do meio
 middleName string
lastName
 lastName string
trustName
 trustName string
tipoDeConfiança
 trustType string
Nome da empresa
 companyName string
Nome da negociação
 tradingName string
Nome da parceria
 partnershipName string
smsfName
 smsfName string
softwareType
 softwareType string
softwareName
 softwareName string
ID do parceiro
 partnerId True string
managerId
 managerId string
divisionId
 divisionId True integer
Prospecto
 prospect boolean
preferredName
 preferredName string
data de nascimento
 dateofbirth date-time
lugarOfBirth
 placeOfBirth string
Género
 gender string
tipo
 type string
e-mail
 email string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
tipo
 type string
number
 number string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean
linkedInProfileId
 linkedInProfileId string
site
 website string
Data de Revisão Anual
 annualReviewDate date-time
Data de formação
 formationDate date-time
addressType
 addressType string
unidade
 unit string
cuidadosOf
 careOf string
endereçoLine1
 addressLine1 string
endereçoLine2
 addressLine2 string
subúrbio
 suburb string
state
 state string
país
 country string
Código postal
 postCode string
indústria
 industry string
função
 role string
salário
 salary string
Rendimento anual
 annualIncome string
isTaxClient
 isTaxClient boolean
isLodgeActivity
 isLodgeActivity boolean
tfn
 tfn integer
ABN
 abn integer
pode
 acn integer
Din
 din integer
taxAgent
 taxAgent string
gst
 gst boolean
residente
 resident boolean
nome_do-banco
 bankName string
NomeContaBancária
 bankAccountName string
bankBSB
 bankBSB integer
BankAccountNumber
 bankAccountNumber integer
contactId
 contactId integer
ContactType
 contactType string
id
 id integer
value
 value string
enumEntityTypes
 enumEntityTypes string
enumTrustTypes
 enumTrustTypes string
enumGénero
 enumGender string
enumEmailTypes
 enumEmailTypes string
enumPhoneTypes
 enumPhoneTypes string
enumContactTypes
 enumContactTypes string
enumAddressTypes
 enumAddressTypes string

Criar grupo de clientes

ID da Operação:
createClientGroup

Cria um grupo cliente.

Parâmetros

Name Chave Obrigatório Tipo Descrição
groupName
 groupName string
ID do parceiro
 partnerId string
tags
 tags array of integer
clientId
 clientId integer
isDebitorClient
 isDebitorClient boolean
relationIds
 relationIds array of integer
contactId
 contactId integer

Criar trabalho

ID da Operação:
createJobs

Cria um trabalho de fluxo de trabalho.

Parâmetros

Name Chave Obrigatório Tipo Descrição
clientId
 clientId integer
divisionId
 divisionId integer
devorclientId
 debtorclientId integer
jobTypeId
 jobTypeId integer
EmpregoCategoria
 jobCategory string
nome do trabalho
 jobName string
financialYear
 financialYear integer
templateId
 templateId integer
managerId
 managerId string
ID do parceiro
 partnerId string
startDate
 startDate date-time
data de vencimento
 dueDate date-time
estimaçãoTipo
 estimateType string
priority
 priority string
description
 description string
Método de faturação
 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

Divisões de lista

ID da Operação:
getDivisions

Devolve uma lista paginada das divisões.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de divisões a devolver por página.
Modificado desde
 modifiedSince string

Divisões de retorno modificadas a partir desse timestamp.

Devoluções

Corpo
Divisions_Result

Lista de clientes

ID da Operação:
getClients

Devolve uma lista de clientes paginada.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados (baseado em 1).
Tamanho da página
 pageSize integer

Número de itens por página.
ID de Parceiro
 partnerId string

Filtrar por identificador de parceiro.
Cliente de débito
 isDebitClient boolean

Filtrar por flag de cliente de débito.
Modificado desde
 modifiedSince string

Clientes de devolução modificados a/após este carimbo temporal (ISO 8601).
Código do grupo
 groupCode string

Filtra por código de grupo.
ID de Cliente
 clientId integer

Filtrar por ID do cliente.
Campos personalizados
 isCustomField boolean

Inclua campos personalizados.

Devoluções

Corpo
Client_Result

Lista de utilizadores

ID da Operação:
getUsers

Devolve uma lista paginada de utilizadores.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de utilizadores a devolver por página.
Modificado desde
 modifiedSince string

Devolver utilizadores modificados a partir desse timestamp.
Nome da função
 rolename string

Filtrar utilizadores por nome do papel.

Devoluções

Corpo
Users_Result

Lista prioridades do trabalho

ID da Operação:
getJobPriorities

Devolve as prioridades de trabalho disponíveis para o fluxo de trabalho.

Devoluções

Corpo
JobPriorityValues

Listar as relações com os clientes

ID da Operação:
getClientRelationships

Devolve uma lista paginada das relações com clientes.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID de Cliente
 clientId True integer

Identificador do cliente.
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de relações a devolver por página.

Devoluções

Corpo
Relationships_Result

Listar contatos

ID da Operação:
getContacts

Devolve uma lista de contactos paginada.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de contactos a devolver por página.
Modificado desde
 modifiedSince string

Contactos de retorno modificados a partir deste carimbo temporal ou posteriores.
ID de contato
 contactId integer

Filtrar contactos por identificador de contacto.
Filtro de ID de cliente
 isClientId boolean

Indica se o filtro de ID de contacto deve ser tratado como um ID de cliente.
Campos personalizados
 isCustomField boolean

Inclua campos personalizados nos resultados de contacto.

Devoluções

Corpo
Contact_Result

Listar equipas

ID da Operação:
getTeams

Devolve as equipas disponíveis.

Devoluções

Corpo
Teams

Listar estados do tipo de trabalho

ID da Operação:
getJobTypeStatus

Devolve os estados disponíveis dos tipos de trabalho do fluxo de trabalho.

Devoluções

Corpo
JobTypeStatus

Listar etiquetas de cliente

ID da Operação:
getClientsTags

Devolve as etiquetas de cliente disponíveis.

Listar faturas

ID da Operação:
getInvoices

Devolve uma lista de faturas paginada.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de faturas a devolver por página.
Projeto de lei preliminar
 isDraftInvoice boolean

Filtra as faturas pelo flag de rascunho.
Inclua detalhes da fatura
 includeInvoiceDetails boolean

Inclua os registos detalhados da fatura na resposta.
Status
 status string

Filtra faturas por estado.
Modificado desde
 modifiedSince string

Devolva faturas modificadas a partir desse carimbo temporal.
Cliente de débito
 isDebitClient boolean

Filtrar faturas pelo flag de débito do cliente.
Nome do cliente
 clientname string

Filtre as faturas pelo nome do cliente.
Código do cliente
 clientcode string

Filtra faturas por código do cliente.
Nome do trabalho
 jobname string

Filtra as faturas por nome do trabalho.
Código de trabalho
 jobcode string

Filtra as faturas por código de trabalho.
ID da entidade de faturação
 billingEntityId string

Filtre faturas por identificador da entidade de faturação.

Devoluções

Corpo
InvoiceDetail_Result

Listar vagas

ID da Operação:
getJobs

Devolve uma lista paginada de trabalhos de workflow.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de trabalhos para devolver por página.
ID de Parceiro
 partnerId string

Filtra os empregos por identificador de parceiro.
Nome do cliente
 clientName string

Filtra os empregos pelo nome do cliente.
Código do cliente
 clientcode string

Filtrar trabalhos por código do cliente.
Modificado desde
 modifiedSince string

Devolve trabalhos modificados a partir desse carimbo temporal.
Cliente de débito
 isDebitClient boolean

Filtra os empregos por flag de cliente de débito.
Campos personalizados
 isCustomField boolean

Inclua campos personalizados nos resultados do trabalho.

Devoluções

Corpo
Jobs_Result

Listas de modelos de emprego

ID da Operação:
getJobTemplates

Devolve os modelos de trabalho de workflow disponíveis.

Devoluções

Corpo
JobTemplate

Listas de tipos de funções

ID da Operação:
getJobTypes

Devolve os tipos de trabalho disponíveis para o fluxo de trabalho.

Devoluções

Corpo
JobType

Liste os tipos de tempo não faturáveis

ID da Operação:
getNonBillableTimesheetTypes

Devolve os tipos de folhas de horas não faturáveis disponíveis.

Obtenha campos personalizados por contexto

ID da Operação:
getFirmCustomfields

Devolve campos personalizados para o contexto especificado.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Contexto
 context True string

Contexto dos campos personalizados.

Obtenha o cliente por ID

ID da Operação:
getAClient

Dados de devolução para um cliente por identificação.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID de Cliente
 clientId True integer

Identificador do cliente.
Campos personalizados
 isCustomField boolean

Inclua campos personalizados.

Devoluções

Corpo
ClientDetails_Result

Obtenha o mapeamento dos clientes devedores

ID da Operação:
getClientsDebtor

Devolve o mapeamento do cliente devedor para um cliente.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID de Cliente
 clientId True integer

Identificador do cliente.

Devoluções

Corpo
ClientDebtor

obter Grupos de Clientes

ID da Operação:
getClientGroups

obter Grupos de Clientes

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página
 page integer

Número da página de resultados.
Tamanho da página
 pageSize integer

Número de grupos de clientes a devolver por página.
Código do grupo
 groupCode string

Filtra grupos de clientes por código de grupo.

Devoluções

Name Caminho Tipo Descrição
clientGroups
 clientGroups array of object

clientGroups
groupId
 clientGroups.groupId integer

groupId
groupCode
 clientGroups.groupCode string

groupCode
groupName
 clientGroups.groupName string

groupName
contacto
 clientGroups.contact string

contacto
tags
 clientGroups.tags array of

tags
clients
 clientGroups.clients array of object

clients
clientId
 clientGroups.clients.clientId integer

clientId
tipo de entidade
 clientGroups.clients.entityType string

tipo de entidade
Nome do Cliente
 clientGroups.clients.clientname string

Nome do Cliente
isCliente Devedor
 clientGroups.clients.isDebtorClient boolean

isCliente Devedor
devedorClienteId
 clientGroups.clients.debtorClientId integer

devedorClienteId
createdBY
 clientGroups.createdBY string

createdBY
criado
 clientGroups.created string

criado
Última modificação
 clientGroups.lastmodified string

Última modificação
registos_totais
 pagination.total_records integer

registos_totais
current_page
 pagination.current_page integer

current_page
page_Size
 pagination.page_Size integer

page_Size
total de páginas
 pagination.total_pages integer

total de páginas
next_page
 pagination.next_page integer

next_page
next_pageurl
 pagination.next_pageurl string

next_pageurl
pagination.prev_page integer

prev_page
prev_pageurl
 pagination.prev_pageurl string

prev_pageurl

Tarefa de atualização

ID da Operação:
updateAJob

Atualiza um trabalho de fluxo de trabalho por ID.

Parâmetros

Name Chave Obrigatório Tipo Descrição
ID do trabalho
 jobId True integer

Identificador de trabalho do fluxo de trabalho.
clientId
 clientId integer
divisionId
 divisionId integer
devorclientId
 debtorclientId integer
jobTypeId
 jobTypeId integer
EmpregoCategoria
 jobCategory string
nome do trabalho
 jobName string
financialYear
 financialYear integer
templateId
 templateId integer
managerId
 managerId string
ID do parceiro
 partnerId string
startDate
 startDate date-time
data de vencimento
 dueDate date-time
estimaçãoTipo
 estimateType string
priority
 priority string
description
 description string
Método de faturação
 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

Tempo de registo

ID da Operação:
createTimesheet

Cria uma folha de pontos, introdução de horas.

Parâmetros

Name Chave Obrigatório Tipo Descrição
isfaturabilmente
 isbillable boolean
jobId
 jobId integer
taskId
 taskId integer
nonbillableId
 nonbillableId integer
date
 date date
unidades
 units double
Hora de início
 starttime string
Taxa
 rate double
description
 description string

Definições

Endereço

Name Caminho Tipo Descrição
addressType
 addressType string
unidade
 unit string
cuidadosOf
 careOf string
endereçoLine1
 addressLine1 string
endereçoLine2
 addressLine2 string
subúrbio
 suburb string
state
 state string
país
 country string
Código postal
 postCode string

Client

Name Caminho Tipo Descrição
código
 code string
saudação
 salutation string
Nome
 name string
firstName
 firstName string
Nome do meio
 middleName string
lastName
 lastName string
preferredName
 preferredName string
dateOfBirth
 dateOfBirth string
e-mail
 email array of Email
phone
 phone array of Phone
Divisão
 division Division
tipo de entidade
 entityType string
parceiro
 partner Staff
gestor
 manager Staff
contactos
 contacts array of Contact
addresses
 addresses array of Address
pode
 acn string
ABN
 abn string
tfn
 tfn string
gstRegistered
 gstRegistered boolean
taxClient
 taxClient boolean
criado
 created string
últimaModificação
 lastModified string
WIP
 wip string
localização
 location string
estado
 status string
agrupar
 group Group
DevedorCliente
 debtorClient string
clientBrefcode
 clientBrefcode string
Código de Faturamento
 billercode string
id
 id integer
customFields
 customFields array of CustomField

ClienteDevedor

Name Caminho Tipo Descrição
Debtorid
 debtorid integer
Nome do Devedor
 debtorname string
groupCode
 groupCode string
ID de cliente
 clientid integer
clientType
 clientType string
isSeflDebtor
 isSeflDebtor boolean

Detalhes do Cliente

Name Caminho Tipo Descrição
código
 code string
saudação
 salutation string
Nome
 name string
firstName
 firstName string
Nome do meio
 middleName string
lastName
 lastName string
preferredName
 preferredName string
dateOfBirth
 dateOfBirth string
e-mail
 email array of Email
phone
 phone array of Phone
Divisão
 division Division
tipo de entidade
 entityType string
parceiro
 partner Staff
gestor
 manager Staff
contactos
 contacts array of Contact
addresses
 addresses array of Address
pode
 acn string
ABN
 abn string
gstRegistered
 gstRegistered boolean
taxClient
 taxClient boolean
criado
 created string
últimaModificação
 lastModified string
WIP
 wip string
localização
 location string
estado
 status string
agrupar
 group Group
DevedorCliente
 debtorClient string
clientBrefcode
 clientBrefcode string
Código de Faturamento
 billercode string
id
 id integer
customFields
 customFields array of CustomField
Din
 din string
tfn
 tfn string
nome_do-banco
 bankName string
NomeContaBancária
 bankAccountName string
bankBSB
 bankBSB string
BankAccountNumber
 bankAccountNumber string

ClientDetails_Result

Name Caminho Tipo Descrição
cliente
 client array of ClientDetails

Resumo do Cliente

Name Caminho Tipo Descrição
id
 id integer
código
 code string
Nome
 name string

Client_Result

Name Caminho Tipo Descrição
clients
 clients array of Client
paginação
 pagination Pagination

Contact

Name Caminho Tipo Descrição
id
 id integer
firstName
 firstName string
lastName
 lastName string
preferredName
 preferredName string
ContactType
 contactType string
e-mail
 email array of Email
phone
 phone array of Phone

ContactEntity

Name Caminho Tipo Descrição
saudação
 salutation string
firstName
 firstName string
Nome do meio
 middleName string
lastName
 lastName string
Género
 gender string
phone
 phone array of Phone
e-mail
 email array of Email
Nome da empresa
 companyName string
lugarOfBirth
 placeOfBirth string
linkedInProfileID
 linkedInProfileID string
preferredName
 preferredName string
Din
 din string
contactId
 contactId integer
dateOfBirth
 dateOfBirth string
criado
 created string
últimaModificação
 lastModified string
addresses
 addresses array of Address
Nome
 name string
localização
 location string
contexto
 context string
customFields
 customFields array of CustomField

Contact_Result

Name Caminho Tipo Descrição
contactos
 contacts array of ContactEntity
paginação
 pagination Pagination

Campo Personalizado

Name Caminho Tipo Descrição
id
 id integer
value
 value string

Cliente Devedor

Name Caminho Tipo Descrição
id
 id integer
código
 code string
Nome
 name string

Divisão

Name Caminho Tipo Descrição
id
 id integer
Nome
 name string

DivisãoComDetalhes

Name Caminho Tipo Descrição
id
 id integer
Nome
 name string
faturaçãoNomeEntidade
 billingEntityName string
billingEntityId
 billingEntityId string
última modificação em
 lastModifiedAt string

Divisionext

Name Caminho Tipo Descrição
id
 id integer
Nome
 name string
faturaçãoNomeEntidade
 billingEntityName string
billingEntityId
 billingEntityId string
última modificação em
 lastModifiedAt string
última modificação por
 lastModifiedBy string
criado
 created string

Divisions_Result

Name Caminho Tipo Descrição
Divisões
 divisions array of Divisionext
paginação
 pagination Pagination

Email

Name Caminho Tipo Descrição
tipo
 type string
e-mail
 email string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean

Grupo

Name Caminho Tipo Descrição
id
 id integer
código
 code string
Nome
 name string

Membro do Grupo

Name Caminho Tipo Descrição
groupId
 groupId integer
ID do membro
 memberId string
Nome
 name string
nome_da-função
 roleName string

InvoiceDetail_Result

Name Caminho Tipo Descrição
invoices
 invoices array of InvoiceDetails
paginação
 pagination Pagination

InvoiceDetails

Name Caminho Tipo Descrição
id
 id integer
number
 number string
refNo
 refNo string
tipo
 type string
date
 date string
devido
 due string
totalPayable
 totalPayable double
gst
 gst double
pagamento
 payment double
créditoNota
 creditNote double
saldo
 balance double
estado
 status string
devedorClienteId
 debtorClientId integer
DevedorClienteCode
 debtorClientCode string
DevedorNomeCliente.
 debtorClientName string
devedorBrefcode
 debtorBrefcode string
Código de Faturamento
 billercode string
invoiceLines
 invoiceLines array of InvoiceLines
invoiceJobs
 invoiceJobs array of JobInvoice
criado
 created string
últimaModificação
 lastModified string

InvoiceLines

Name Caminho Tipo Descrição
id
 id integer
número da linha
 lineNumber integer
Descrição da linha
 lineDescription string
linhaTotal
 lineTotal double

JobInvoice

Name Caminho Tipo Descrição
id
 id integer
Código de trabalho
 jobcode string
Nome
 name string
WIP
 wip double
cliente
 client ClientSummary
financialYear
 financialYear string
parceiro
 partner Staff
gestor
 manager Staff
Divisão
 division DivisionWithDetails
criado
 created string
últimaModificação
 lastModified string
DevedorCliente
 debtorClient string
ID da fatura
 invoiceid integer

ValoresDePrioridade do Emprego

Name Caminho Tipo Descrição
jobPriorityId
 jobPriorityId integer
empregoNomePrioridade
 jobPriorityName string

JobTemplate

Name Caminho Tipo Descrição
templateId
 templateId integer
templateName
 templateName string
description
 description string
estimaçãoTipo
 estimateType string
Turnaround
 turnaround integer
criado
 created string
últimaModificação
 lastModified string

Tipo de trabalho

Name Caminho Tipo Descrição
jobTypeId
 jobTypeId integer
JobTypeName
 jobTypeName string
description
 description string
divisionId
 divisionId integer
criado
 created string
últimaModificação
 lastModified string

EmpregoTipoEstado-de-Trabalho

Name Caminho Tipo Descrição
jobTypeId
 jobTypeId integer
statusId
 statusId integer
statusNome
 statusName string
categoryId
 categoryId integer
categoryName
 categoryName string

Trabalho

Name Caminho Tipo Descrição
id
 id integer
jobCode
 jobCode string
jobType
 jobType string
Nome
 name string
priority
 priority string
data de vencimento
 dueDate string
estimadoTempo
 estimatedTime double
WIP
 wip double
cliente
 client ClientSummary
financialYear
 financialYear string
parceiro
 partner Staff
gestor
 manager Staff
Divisão
 division DivisionWithDetails
criado
 created string
últimaModificação
 lastModified string
DevedorCliente
 debtorClient DebtorClient
estado
 status string
EstadoCategoria
 statusCategory string
EstadoProprietário
 statusOwner UserDetail
concluídaTarefa
 completedTask integer
totalTarefa
 totalTask integer
tasks
 tasks array of TaskDetail
cessionários
 assignees array of UserDetail
equipa
 team TaskDetail
customFields
 customFields array of CustomField

Jobs_Result

Name Caminho Tipo Descrição
jobs
 jobs array of Jobdetail
paginação
 pagination Pagination

Pagination

Name Caminho Tipo Descrição
registos_totais
 total_records integer
current_page
 current_page integer
page_Size
 page_Size integer
total de páginas
 total_pages integer
next_page
 next_page integer
next_pageurl
 next_pageurl string
prev_page
 prev_page integer
prev_pageurl
 prev_pageurl string

Telemóvel

Name Caminho Tipo Descrição
tipo
 type string
number
 number string
favorito
 favourite boolean
feeSynergy
 feeSynergy boolean

Relationship

Name Caminho Tipo Descrição
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

Name Caminho Tipo Descrição
relationships
 relationships array of Relationship
paginação
 pagination Pagination

Funcionários

Name Caminho Tipo Descrição
id
 id string
Nome
 name string
e-mail
 email string

TaskDetail

Name Caminho Tipo Descrição
id
 id integer
Nome
 name string

Teams

Name Caminho Tipo Descrição
groupId
 groupId integer
teamId
 teamId integer
Nome
 name string
membros do grupo
 groupMembers array of GroupMember

UserDetail

Name Caminho Tipo Descrição
id
 id string
Nome
 name string

UsersWithDetails

Name Caminho Tipo Descrição
id
 id string
Nome
 name string
nome_da-função
 roleName string
e-mail
 email Email
firstName
 firstName string
lastName
 lastName string
phone
 phone Phone
Endereço
 address Address
criado
 created string
últimaModificação
 lastModified string

Users_Result

Name Caminho Tipo Descrição
users
 users array of UsersWithDetails
paginação
 pagination Pagination