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/ |
| 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
Isso fornece acesso às APIs de Gerenciamento de Práticas do Kloud Connect.
Features
- Listar clientes
- Criar clientes
- Listar Contatos
- Criar Contatos
- Listar faturas
- Criar Quadro de Horários
- Listar tarefas
- Criar tarefas
- Listar trabalhos
- Criar trabalhos
- Acessar dados de gerenciamento 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 contato por ID. |
| Atualizar grupo de clientes |
Atualiza um grupo de clientes por código de grupo. |
| Atualizar o status e a prioridade do trabalho |
Atualiza o status e a prioridade para trabalhos de fluxo de trabalho. |
| Atualizar trabalho |
Atualiza um trabalho de fluxo de trabalho por ID. |
| Criar cliente |
Cria um cliente. |
| Criar grupo de clientes |
Cria um grupo de clientes. |
| Criar trabalho |
Cria um trabalho de fluxo de trabalho. |
| Listar clientes |
Retorna uma lista paginada de clientes. |
| Listar contatos |
Retorna uma lista paginada de contatos. |
| Listar divisões |
Retorna uma lista paginada de divisões. |
| Listar equipes |
Retorna as equipes disponíveis. |
| Listar faturas |
Retorna uma lista paginada de faturas. |
| 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 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 de cliente. |
| Listar status de tipo de trabalho |
Retorna os status de tipo de trabalho de fluxo de trabalho 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 usuários |
Retorna uma lista paginada de usuários. |
| Obter campos personalizados por contexto |
Retorna campos personalizados para o contexto especificado. |
| Obter cliente por ID |
Retorna detalhes de um cliente por ID. |
| obter grupos de clientes |
obter grupos de clientes |
| Obter mapeamento de cliente devedor |
Retorna o mapeamento de cliente devedor para um cliente. |
| Tempo de log |
Cria uma entrada de horário de quadro de horários. |
Atualizar cliente por ID
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 | ||
|
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-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Gênero
|
gender | string | ||
|
tipo
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
tipo
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
site
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
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 | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
residente
|
resident | boolean | ||
|
bankName
|
bankName | string | ||
|
bankAccountName
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | integer | ||
|
bankAccountNumber
|
bankAccountNumber | integer | ||
|
contactId
|
contactId | integer | ||
|
Contacttype
|
contactType | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGender
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Atualizar contato
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 | ||
|
firstName
|
firstName | True | string | |
|
nome do meio
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
Gênero
|
gender | string | ||
|
tipo
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
tipo
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
CompanyName
|
companyName | string | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
preferredName
|
preferredName | string | ||
|
Din
|
din | string | ||
|
dateOfBirth
|
dateOfBirth | date-time | ||
|
isImportent
|
isImportent | boolean | ||
|
addressType
|
addressType | string | ||
|
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 |
Atualizar grupo de clientes
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 | ||
|
partnerId
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
Atualizar o status e a prioridade do trabalho
Atualiza o status e a prioridade para trabalhos de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
status
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Atualizar trabalho
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 |
Criar cliente
Cria um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
entityType
|
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 | ||
|
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-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Gênero
|
gender | string | ||
|
tipo
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
tipo
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
site
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
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 | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Residente
|
resident | boolean | ||
|
bankName
|
bankName | string | ||
|
bankAccountName
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | integer | ||
|
bankAccountNumber
|
bankAccountNumber | integer | ||
|
contactId
|
contactId | integer | ||
|
Contacttype
|
contactType | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGender
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Criar grupo de clientes
Cria um grupo de clientes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
groupName
|
groupName | string | ||
|
partnerId
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
Criar trabalho
Cria um trabalho de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
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 |
Listar clientes
Retorna uma lista paginada de clientes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página 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 sinalizador de débito-cliente. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar clientes modificados em/após esse carimbo de data/hora (ISO 8601). |
|
|
Código do grupo
|
groupCode | string |
Filtrar por código de grupo. |
|
|
ID do cliente
|
clientId | integer |
Filtrar por ID do cliente. |
|
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados. |
Retornos
- Body
- Client_Result
Listar contatos
Retorna uma lista paginada de contatos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de contatos a serem retornados por página. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar contatos modificados em ou após esse carimbo de data/hora. |
|
|
ID de contato
|
contactId | integer |
Filtrar contatos por identificador 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 do contato. |
Retornos
- Body
- Contact_Result
Listar divisões
Retorna uma lista paginada de divisões.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de divisões a serem retornadas por página. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar divisões modificadas em ou após esse carimbo de data/hora. |
Retornos
- Body
- Divisions_Result
Listar equipes
Listar faturas
Retorna uma lista paginada de faturas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de faturas a serem retornadas por página. |
|
|
Fatura de rascunho
|
isDraftInvoice | boolean |
Filtrar faturas por sinalizador de fatura de rascunho. |
|
|
Incluir detalhes da fatura
|
includeInvoiceDetails | boolean |
Inclua registros de detalhes da fatura na resposta. |
|
|
Status
|
status | string |
Filtrar faturas por status. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar faturas modificadas em ou após esse carimbo de data/hora. |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtrar faturas por sinalizador de cliente de débito. |
|
|
Nome do cliente
|
clientname | string |
Filtrar faturas pelo nome do cliente. |
|
|
Código do cliente
|
clientcode | string |
Filtrar faturas por código do cliente. |
|
|
Nome do trabalho
|
jobname | string |
Filtrar faturas por nome de trabalho. |
|
|
Código do trabalho
|
jobcode | string |
Filtrar faturas por código de trabalho. |
|
|
ID da entidade de cobrança
|
billingEntityId | string |
Filtrar faturas por meio do identificador de entidade de cobrança. |
Retornos
- Body
- InvoiceDetail_Result
Listar marcas de cliente
Retorna as marcas de cliente disponíveis.
Listar modelos de trabalho
Listar prioridades de trabalho
Retorna as prioridades de trabalho de fluxo de trabalho disponíveis.
Retornos
- Body
- JobPriorityValues
Listar relações de cliente
Retorna uma lista paginada de relações de cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
clientId | True | integer |
Identificador de cliente. |
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de relações a serem retornadas por página. |
Retornos
- Body
- Relationships_Result
Listar status de tipo de trabalho
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
Listar trabalhos
Retorna uma lista paginada de trabalhos de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de trabalhos a serem retornados por página. |
|
|
ID de Parceiro
|
partnerId | string |
Filtrar trabalhos por identificador de parceiro. |
|
|
Nome do cliente
|
clientName | string |
Filtrar trabalhos por nome do cliente. |
|
|
Código do cliente
|
clientcode | string |
Filtrar trabalhos por código do cliente. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar trabalhos modificados em ou após esse carimbo de data/hora. |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtrar trabalhos por sinalizador de cliente de débito. |
|
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados nos resultados do trabalho. |
Retornos
- Body
- Jobs_Result
Listar usuários
Retorna uma lista paginada de usuários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de usuários a serem retornados por página. |
|
|
Modificado desde
|
modifiedSince | string |
Retornar usuários modificados no carimbo de data/hora ou após esse carimbo de data/hora. |
|
|
Nome da função
|
rolename | string |
Filtrar usuários por nome de função. |
Retornos
- Body
- Users_Result
Obter campos personalizados por contexto
Retorna campos personalizados para o contexto especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Contexto
|
context | True | string |
Contexto de campos personalizados. |
Obter cliente por ID
Retorna detalhes de um cliente por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
clientId | True | integer |
Identificador de cliente. |
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados. |
Retornos
- Body
- ClientDetails_Result
obter grupos de clientes
obter grupos de clientes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página resultados. |
|
|
Tamanho da página
|
pageSize | integer |
Número de grupos de clientes a serem retornados por página. |
|
|
Código do grupo
|
groupCode | string |
Filtrar grupos de clientes por código de grupo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
contact
|
clientGroups.contact | string |
contact |
|
tags
|
clientGroups.tags | array of |
tags |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
entityType
|
clientGroups.clients.entityType | string |
entityType |
|
clientname
|
clientGroups.clients.clientname | string |
clientname |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debtorClientId
|
clientGroups.clients.debtorClientId | integer |
debtorClientId |
|
Createdby
|
clientGroups.createdBY | string |
Createdby |
|
criado
|
clientGroups.created | string |
criado |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
total_de_registros
|
pagination.total_records | integer |
total_de_registros |
|
current_page
|
pagination.current_page | integer |
current_page |
|
page_Size
|
pagination.page_Size | integer |
page_Size |
|
total_pages
|
pagination.total_pages | integer |
total_pages |
|
next_page
|
pagination.next_page | integer |
next_page |
|
next_pageurl
|
pagination.next_pageurl | string |
next_pageurl |
|
|
pagination.prev_page | integer |
prev_page |
|
prev_pageurl
|
pagination.prev_pageurl | string |
prev_pageurl |
Obter mapeamento de cliente devedor
Retorna o mapeamento de cliente devedor para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
clientId | True | integer |
Identificador de cliente. |
Retornos
- Body
- ClientDebtor
Tempo de log
Cria uma entrada de horário de quadro de horários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
unidades
|
units | double | ||
|
hora de início
|
starttime | string | ||
|
Velocidade
|
rate | double | ||
|
description
|
description | string |
Definições
Endereço
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 | Description |
|---|---|---|---|
|
codificar
|
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 | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
divisão
|
division | Division | |
|
entityType
|
entityType | 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 | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | 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 | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
debtorid
|
debtorid | integer | |
|
nome do devedor
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
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 | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
divisão
|
division | Division | |
|
entityType
|
entityType | 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 | |
|
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 | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField | |
|
Din
|
din | string | |
|
Tfn
|
tfn | string | |
|
bankName
|
bankName | string | |
|
bankAccountName
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
bankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
cliente
|
client | array of ClientDetails |
ClientSummary
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
codificar
|
code | string | |
|
nome
|
name | string |
Client_Result
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
paginação
|
pagination | Pagination |
Contato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
Contacttype
|
contactType | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone |
ContactEntity
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
saudação
|
salutation | string | |
|
firstName
|
firstName | string | |
|
nome do meio
|
middleName | string | |
|
lastName
|
lastName | string | |
|
Gênero
|
gender | string | |
|
phone
|
phone | array of Phone | |
|
email
|
array of Email | ||
|
CompanyName
|
companyName | string | |
|
placeOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
Din
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
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 |
CustomField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DebtorClient
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string |
Divisionext
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 |
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string | |
|
email
|
string | ||
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Grupo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
codificar
|
code | string | |
|
nome
|
name | string |
Membro do Grupo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
número
|
number | string | |
|
refNo
|
refNo | string | |
|
tipo
|
type | string | |
|
date
|
date | string | |
|
para conclusão
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
pagamento
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
saldo
|
balance | double | |
|
status
|
status | string | |
|
debtorClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
debtorClientName
|
debtorClientName | 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 |
InvoiceLines
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Número da linha
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 |
JobPriorityValues
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
Modelo de trabalho
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Reviravolta
|
turnaround | integer | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
Tipo de Trabalho
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
JobTypeStatus
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 | |
|
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 |
Jobs_Result
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
paginação
|
pagination | Pagination |
Pagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 | Description |
|---|---|---|---|
|
tipo
|
type | string | |
|
número
|
number | string | |
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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 |
Equipe
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
email
|
string |
TaskDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string |
Teams
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
nome
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string |
UsersWithDetails
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
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 |