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/ |
| 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
Este conector fornece acesso às APIs de Gestão de Práticas do Kloud Connect, permitindo que clientes, contactos, tarefas, folhas de ponto e faturas possam ser lidos e geridos a partir do Power Automate, Power Apps e Copilot Studio.
Características
- Clientes: listar, obter, criar e atualizar clientes; grupos de clientes; etiquetas; relações; clientes devedores; saudações, títulos, setores e contactos de comunicação
- Contactos: liste, crie e atualize contactos
- Divisões: divisões de lista
- Faturas: liste faturas e tipos de impostos
- Tarefas: listar, obter, criar e atualizar tarefas; atualizar o estado e prioridades das tarefas; grupos de tarefas e tarefas de tarefas
- Tarefas: listar tarefas; criar e atualizar tarefas de trabalho; tipos de tarefas
- Modelos de tarefas: listar, criar e atualizar modelos, grupos de tarefas de modelos e tarefas de modelos
- Folhas de horas: registar o tempo (até 20 entradas por pedido), listar entradas de folha de horas e tipos de horas não faturáveis
- Utilizadores: listar utilizadores, equipas e funções; parceiros e gestores para clientes e empregos
- Definições e consultas: campos personalizados, tipos e estados de emprego, prioridades de emprego, categorias de estado de emprego, tipos de email, tipos de telefone e países
Quais são as novidades desta atualização?
- Foram adicionadas operações para criação de contactos, grupos de tarefas de tarefas e modelos, tarefas de tarefas, tipos de tarefas, modelos de tarefas, tipos de tarefas, prioridades de trabalho e tipos de tempo não faturáveis
- Foram adicionadas operações para listar entradas de folhas de ponto, tarefas, funções, tipos de impostos, saudações, títulos, indústrias, países, tipos de email e tipos de telefone
- Adicionaram contactos de comunicação com clientes, clientes disponíveis para agrupamento e contactos disponíveis para clientes
- As operações de escrita agora descrevem a sua resposta (ID, estado, mensagem e data)
Alterações de grande impacto
- Atualizar o estado do trabalho e a prioridade (
updateJobStatuses) são substituídos porupdateJobStatus, que agora recebe o ID do trabalho como entrada - O tempo de registo (
createTimesheet) agora aceita uma lista de até 20 entradas de tempo em vez de uma única entrada - Listar tipos de funções, modelos de funções, prioridades de tarefas e estados dos tipos de trabalho, agora devolve listas e usa os
/v1/settings/workflowsendpoints - Liste equipas e obtenha o mapeamento de clientes devedores agora para devolver listas
Limitations
- As operações de gestão documental (pastas, ficheiros e sites) não fazem parte deste conector
Authentication
OAuth 2.0 via Kloud Connect Identity Server
Suporte
support@kloudconnect.com.au
Ações
| Arranja emprego por ID |
Devolve os detalhes de um trabalho de fluxo de trabalho. |
| Atualizar cliente por ID |
Atualiza um cliente por ID. |
| Atualizar contato |
Atualiza um contacto por identificação. |
| Atualizar grupo de tarefas de trabalho |
Renomeia um grupo de tarefa num trabalho de workflow. |
| Atualizar modelo de emprego |
Atualiza um modelo de trabalho de workflow por ID. |
| Atualizar o estado e a prioridade do emprego |
Atualiza o estado e a prioridade de um trabalho de fluxo de trabalho. |
| Atualizar o grupo do cliente |
Atualiza o código de um cliente grupo a grupo. |
| Atualizar o tipo de tempo não faturável |
Atualiza um tipo de folha de horas não faturável por ID. |
| Atualizar o tipo de trabalho |
Atualiza o tipo de trabalho por ID. |
| Atualizar os estados dos tipos de trabalho |
Atualiza o estado de um tipo de trabalho. |
| Atualizar prioridade de trabalho |
Renomeia uma prioridade de trabalho de workflow. |
| Atualizar tipo de tarefa |
Atualiza um tipo de tarefa por ID. |
| Criar cliente |
Cria um cliente. |
| Criar contacto |
Cria um contato. |
| Criar grupo de clientes |
Cria um grupo cliente. |
| Criar grupo de tarefa de modelos |
Cria um grupo de tarefas num modelo de trabalho. |
| Criar grupo de tarefa de trabalho |
Cria um grupo de tarefas numa tarefa de workflow. |
| Criar modelo de emprego |
Cria um modelo de trabalho para o fluxo de trabalho. |
| Criar prioridade de trabalho |
Cria uma prioridade de trabalho no fluxo de trabalho. |
| Criar tarefa de trabalho |
Cria uma tarefa num grupo de trabalho de trabalho. |
| Criar tipo de tarefa |
Cria um tipo de tarefa. |
| Criar tipo de trabalho |
Cria um tipo de trabalho com os seus estados. |
| Criar trabalho |
Cria um trabalho de fluxo de trabalho. |
| Criar um tipo de tempo não faturável |
Cria um tipo de folha de horas não faturável. |
| Divisões de lista |
Devolve uma lista paginada das divisões. |
| Entradas da folha de horas da lista |
Devolve uma lista paginada de entradas de folha de horas. |
| Gestores de cargos de lista |
Devolve os utilizadores que podem ser selecionados como gestores numa tarefa. |
| Grupo de tarefa de atualização de modelos |
Renomeia um grupo de tarefas num modelo de trabalho. |
| Grupos de tarefas de modelos de listas |
Devolve os grupos de tarefas e tarefas de um modelo de trabalho. |
| Indústrias de lista |
Devolve os nomes das indústrias que podem ser atribuídos a um cliente. |
| Lista de categorias de estado profissional |
Devolve as categorias de estado de emprego disponíveis. |
| Lista de clientes |
Devolve uma lista de clientes paginada. |
| Lista de clientes disponíveis para agrupamento |
Devolve os clientes que podem ser adicionados a um grupo de clientes. |
| Lista de contactos de comunicação |
Devolve uma lista paginada com os contactos de comunicação do cliente. |
| Lista de contactos disponíveis para clientes |
Devolve os contactos que podem ser ligados a um cliente. |
| Lista de gestores de clientes |
Devolve os utilizadores que podem ser selecionados como gestores num cliente. |
| Lista de parceiros de trabalho |
Devolve os utilizadores que podem ser selecionados como parceiros num trabalho. |
| Lista de saudações |
Devolve as saudações disponíveis para clientes e contactos. |
| Lista de tarefas do grupo de tarefas do modelo |
Devolve um grupo de tarefas e as suas tarefas para um modelo de trabalho. |
| Lista de tipos de email |
Devolve os tipos de email disponíveis. |
| Lista de tipos de impostos |
Devolve os tipos de impostos disponíveis para faturas. |
| Lista de tipos de telefone |
Devolve os tipos de telefone disponíveis. |
| 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 de relações para um cliente. |
| 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 funções |
Devolve os papéis de utilizador disponíveis. |
| Listar grupos de clientes |
Devolve uma lista paginada dos grupos de clientes e dos seus clientes membros. |
| Listar grupos de tarefas de trabalho |
Devolve os grupos de tarefas de um trabalho de workflow. |
| Listar parceiros clientes |
Devolve os utilizadores que podem ser selecionados como parceiros num cliente. |
| Listar países |
Devolve os países disponíveis. |
| Listar tarefas |
Devolve uma lista paginada das tarefas do trabalho. |
| Listar tarefas do grupo de tarefa de tarefas |
Devolve as tarefas num grupo de tarefas de um trabalho de fluxo de trabalho. |
| 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 os campos personalizados definidos para um contexto: cliente, contacto, trabalho ou todos. |
| Obtenha o cliente por ID |
Devolve os dados de um cliente. |
| Obtenha o mapeamento dos clientes devedores |
Devolve os clientes devedores mapeados para um cliente. |
| Tarefa de atualização |
Atualiza um trabalho de fluxo de trabalho por ID. |
| Tarefa de atualização do modelo |
Atualiza uma tarefa num grupo de tarefas de modelos de trabalho. |
| Tarefa de atualização do trabalho |
Atualiza uma tarefa num grupo de tarefas de trabalho. |
| Tarefa de criar modelo |
Cria uma tarefa num grupo de tarefas de modelos de trabalho. |
| Tempo de registo |
Cria uma ou mais entradas de tempo em folha de horas (até 20 por pedido). |
| Títulos das listas |
Devolve os títulos disponíveis para clientes e contactos. |
Arranja emprego por ID
Devolve os detalhes de um trabalho de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
Devoluções
- response
- array of JobData
Atualizar cliente por ID
Atualiza um cliente por ID.
Parâmetros
| Nome | 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 | ||
|
title
|
title | 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 | ||
|
lugarOfBirth
|
placeOfBirth | string | ||
|
dataDeMorte
|
dateOfDeath | date | ||
|
deRegistoData
|
deRegistrationDate | date | ||
|
startDate
|
startDate | date | ||
|
data de término
|
endDate | date | ||
|
Género
|
gender | string | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
e-mail
|
string | |||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
paísId
|
countryId | integer | ||
|
isdCode
|
isdCode | integer | ||
|
number
|
number | string | ||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
site
|
website | string | ||
|
Data de Revisão Anual
|
annualReviewDate | date | ||
|
Data de formação
|
formationDate | date | ||
|
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 | string | ||
|
ABN
|
abn | string | ||
|
pode
|
acn | string | ||
|
Din
|
din | string | ||
|
taxAgent
|
taxAgent | string | ||
|
gst
|
gst | boolean | ||
|
residente
|
resident | boolean | ||
|
nome_do-banco
|
bankName | string | ||
|
NomeContaBancária
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | string | ||
|
BankAccountNumber
|
bankAccountNumber | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
correspondênciaNome
|
mailingName | string | ||
|
tagIds
|
tagIds | array of integer | ||
|
clientBrefcode
|
clientBrefcode | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGénero
|
enumGender | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Devoluções
- Corpo
- ResponseMessage
Atualizar contato
Atualiza um contacto por identificação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | integer |
Identificador de contacto. |
|
saudação
|
salutation | string | ||
|
title
|
title | string | ||
|
firstName
|
firstName | True | string | |
|
Nome do meio
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
Género
|
gender | string | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
e-mail
|
string | |||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
paísId
|
countryId | integer | ||
|
isdCode
|
isdCode | integer | ||
|
number
|
number | string | ||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
lugarOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
dateOfBirth
|
dateOfBirth | date | ||
|
dataDeMorte
|
dateOfDeath | date | ||
|
preferredName
|
preferredName | string | ||
|
Din
|
din | string | ||
|
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 |
Devoluções
- Corpo
- ResponseMessage
Atualizar grupo de tarefas de trabalho
Renomeia um grupo de tarefa num trabalho de workflow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
|
ID do grupo de tarefa
|
taskgroupId | True | integer |
Identificador do grupo de tarefa. |
|
Nome do grupo de tarefa
|
taskgroupname | True | string |
Nome do grupo de tarefa. |
Devoluções
- Corpo
- ResponseMessage
Atualizar modelo de emprego
Atualiza um modelo de trabalho de workflow por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | integer |
Identificador do modelo de trabalho. |
|
templateName
|
templateName | string | ||
|
description
|
description | string | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
Turnaround
|
turnaround | integer |
Devoluções
- Corpo
- ResponseMessage
Atualizar o estado e a prioridade do emprego
Atualiza o estado e a prioridade de um trabalho de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
|
priority
|
priority | string | ||
|
estado
|
status | string | ||
|
EstadoProprietário
|
statusOwner | string |
Devoluções
- Corpo
- ResponseMessage
Atualizar o grupo do cliente
Atualiza o código de um cliente grupo a grupo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
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 |
Devoluções
- Corpo
- ResponseMessage
Atualizar o tipo de tempo não faturável
Atualiza um tipo de folha de horas não faturável por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID de tipo não faturável
|
id | True | integer |
Identificador de tipo de tempo não faturável. |
|
Nome
|
name | string | ||
|
description
|
description | string |
Devoluções
- Corpo
- ResponseMessage
Atualizar o tipo de trabalho
Atualiza o tipo de trabalho por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do tipo de trabalho
|
id | True | integer |
Identificador do tipo de função. |
|
JobTypeName
|
jobTypeName | string | ||
|
description
|
description | string | ||
|
divisionId
|
divisionId | integer | ||
|
defaultTemplate
|
defaultTemplate | integer | ||
|
devedorCategoriaEmprego
|
debtorJobCategory | string | ||
|
RelacionadoEmpregoCategoria
|
relatedJobCategory | string | ||
|
statusId
|
statusId | integer | ||
|
statusCatId
|
statusCatId | integer | ||
|
description
|
description | string | ||
|
statusNome
|
statusName | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string |
Devoluções
- Corpo
- ResponseMessage
Atualizar os estados dos tipos de trabalho
Atualiza o estado de um tipo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do tipo de trabalho
|
jobtypeId | True | integer |
Identificador do tipo de função. |
|
statusId
|
statusId | integer | ||
|
statusCatId
|
statusCatId | integer | ||
|
description
|
description | string | ||
|
statusNome
|
statusName | string |
Devoluções
- Corpo
- ResponseMessage
Atualizar prioridade de trabalho
Renomeia uma prioridade de trabalho de workflow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID de prioridade
|
priorityId | True | integer |
Identificador de prioridade de trabalho. |
|
Nome da prioridade
|
priorityName | True | string |
Nome da prioridade do trabalho. |
Devoluções
- Corpo
- ResponseMessage
Atualizar tipo de tarefa
Atualiza um tipo de tarefa por ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do tipo de tarefa
|
tasktypeId | True | integer |
Identificador de tipo de tarefa. |
|
taskType
|
taskType | string | ||
|
description
|
description | string | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
enumTaskCategory
|
enumTaskCategory | string |
Devoluções
- Corpo
- ResponseMessage
Criar cliente
Cria um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
tipo de entidade
|
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 | ||
|
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 | ||
|
lugarOfBirth
|
placeOfBirth | string | ||
|
dataDeMorte
|
dateOfDeath | date | ||
|
deRegistoData
|
deRegistrationDate | date | ||
|
startDate
|
startDate | date | ||
|
data de término
|
endDate | date | ||
|
Género
|
gender | string | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
e-mail
|
string | |||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
paísId
|
countryId | integer | ||
|
isdCode
|
isdCode | integer | ||
|
number
|
number | string | ||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
site
|
website | string | ||
|
Data de Revisão Anual
|
annualReviewDate | date | ||
|
Data de formação
|
formationDate | date | ||
|
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 | string | ||
|
ABN
|
abn | string | ||
|
pode
|
acn | string | ||
|
Din
|
din | string | ||
|
taxAgent
|
taxAgent | string | ||
|
gst
|
gst | boolean | ||
|
residente
|
resident | boolean | ||
|
nome_do-banco
|
bankName | string | ||
|
NomeContaBancária
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | string | ||
|
BankAccountNumber
|
bankAccountNumber | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
correspondênciaNome
|
mailingName | string | ||
|
tagIds
|
tagIds | array of integer | ||
|
clientBrefcode
|
clientBrefcode | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGénero
|
enumGender | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Devoluções
- Corpo
- ResponseMessage
Criar contacto
Cria um contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
saudação
|
salutation | string | ||
|
title
|
title | string | ||
|
firstName
|
firstName | True | string | |
|
Nome do meio
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
Género
|
gender | string | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
e-mail
|
string | |||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
typeId
|
typeId | integer | ||
|
typeName
|
typeName | string | ||
|
tipo
|
type | string | ||
|
paísId
|
countryId | integer | ||
|
isdCode
|
isdCode | integer | ||
|
number
|
number | string | ||
|
preferido
|
preferred | boolean | ||
|
favorito
|
favourite | boolean | ||
|
lugarOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
dateOfBirth
|
dateOfBirth | date | ||
|
dataDeMorte
|
dateOfDeath | date | ||
|
preferredName
|
preferredName | string | ||
|
Din
|
din | string | ||
|
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 |
Devoluções
- Corpo
- ResponseMessage
Criar grupo de clientes
Cria um grupo cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
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 |
Devoluções
- Corpo
- ResponseMessage
Criar grupo de tarefa de modelos
Cria um grupo de tarefas num modelo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | integer |
Identificador do modelo de trabalho. |
|
Nome do grupo de tarefa
|
taskgroupname | True | string |
Nome do grupo de tarefa. |
Devoluções
- Corpo
- ResponseMessage
Criar grupo de tarefa de trabalho
Cria um grupo de tarefas numa tarefa de workflow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
|
Nome do grupo de tarefa
|
taskgroupname | True | string |
Nome do grupo de tarefa. |
Devoluções
- Corpo
- ResponseMessage
Criar modelo de emprego
Cria um modelo de trabalho para o fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
templateName
|
templateName | string | ||
|
description
|
description | string | ||
|
estimaçãoTipo
|
estimateType | string | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
Turnaround
|
turnaround | integer |
Devoluções
- Corpo
- ResponseMessage
Criar prioridade de trabalho
Cria uma prioridade de trabalho no fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome da prioridade
|
priorityName | True | string |
Nome da prioridade do trabalho. |
Devoluções
- Corpo
- ResponseMessage
Criar tarefa de trabalho
Cria uma tarefa num grupo de trabalho de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
Nome da tarefa
|
taskName | string | ||
|
estado
|
status | string | ||
|
TaskTypeId
|
taskTypeId | integer | ||
|
taskgroupId
|
taskgroupId | integer | ||
|
taskLevelRoleId
|
taskLevelRoleId | integer | ||
|
userId
|
userId | string | ||
|
unidade
|
unit | integer | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
startDate
|
startDate | date-time | ||
|
data de vencimento
|
dueDate | date-time |
Devoluções
- Corpo
- ResponseMessage
Criar tipo de tarefa
Cria um tipo de tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
taskType
|
taskType | string | ||
|
description
|
description | string | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
enumTaskCategory
|
enumTaskCategory | string |
Devoluções
- Corpo
- ResponseMessage
Criar tipo de trabalho
Cria um tipo de trabalho com os seus estados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
JobTypeName
|
jobTypeName | string | ||
|
description
|
description | string | ||
|
divisionId
|
divisionId | integer | ||
|
defaultTemplate
|
defaultTemplate | integer | ||
|
devedorCategoriaEmprego
|
debtorJobCategory | string | ||
|
RelacionadoEmpregoCategoria
|
relatedJobCategory | string | ||
|
statusId
|
statusId | integer | ||
|
statusCatId
|
statusCatId | integer | ||
|
description
|
description | string | ||
|
statusNome
|
statusName | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string |
Devoluções
- Corpo
- ResponseMessage
Criar trabalho
Cria um trabalho de fluxo de trabalho.
Parâmetros
| Nome | 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 |
Devoluções
- Corpo
- ResponseMessage
Criar um tipo de tempo não faturável
Cria um tipo de folha de horas não faturável.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Nome
|
name | string | ||
|
description
|
description | string | ||
|
tipo
|
type | string |
Devoluções
- Corpo
- ResponseMessage
Divisões de lista
Devolve uma lista paginada das divisões.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
Devoluções
- Corpo
- Divisions_Result
Entradas da folha de horas da lista
Devolve uma lista paginada de entradas de folha de horas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Status
|
status | string |
Filtrar as entradas da folha de horas por estado. |
|
|
ID do trabalho
|
jobId | integer |
Filtra por ID do trabalho. |
|
|
ID da tarefa
|
taskId | integer |
Filtrar por ID da tarefa. |
|
|
ID de Cliente
|
clientId | integer |
Filtrar por ID do cliente. |
|
|
Data inicial
|
fromDate | string |
Declare entradas a partir dessa data (yyy-MM-dd). Se não for dado o 'à data', hoje é usado. |
|
|
Data até
|
toDate | string |
Declarar entradas até ou antes desta data (yyy-MM-dd). |
|
|
Faturável
|
isbillable | boolean |
Filtrar por entradas faturáveis (verdadeiras) ou não faturáveis (falsas). |
Devoluções
- Corpo
- TimeSheet_Result
Gestores de cargos de lista
Devolve os utilizadores que podem ser selecionados como gestores numa tarefa.
Devoluções
- response
- array of UserModel
Grupo de tarefa de atualização de modelos
Renomeia um grupo de tarefas num modelo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | integer |
Identificador do modelo de trabalho. |
|
ID do grupo de tarefa
|
taskgroupId | True | integer |
Identificador do grupo de tarefa. |
|
Nome do grupo de tarefa
|
taskgroupname | True | string |
Nome do grupo de tarefa. |
Devoluções
- Corpo
- ResponseMessage
Grupos de tarefas de modelos de listas
Devolve os grupos de tarefas e tarefas de um modelo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | integer |
Identificador do modelo de trabalho. |
Devoluções
Indústrias de lista
Devolve os nomes das indústrias que podem ser atribuídos a um cliente.
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
|
array of string |
Lista de categorias de estado profissional
Lista de clientes
Devolve uma lista de clientes paginada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
ID de Parceiro
|
partnerId | string |
Filtrar por ID do parceiro (utilizador). |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtra pela bandeira de débito-cliente. |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
|
|
Código do grupo
|
groupCode | string |
Filtrar por código do grupo cliente. |
|
|
ID de Cliente
|
clientId | integer |
Filtrar por ID do cliente. |
|
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados nos resultados. |
Devoluções
- Corpo
- Client_Result
Lista de clientes disponíveis para agrupamento
Devolve os clientes que podem ser adicionados a um grupo de clientes.
Devoluções
- response
- array of ClientSummary
Lista de contactos de comunicação
Devolve uma lista paginada com os contactos de comunicação do cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
Devoluções
- Corpo
- ContactsInfo_result
Lista de contactos disponíveis para clientes
Devolve os contactos que podem ser ligados a um cliente.
Devoluções
- response
- array of ClientContacts
Lista de gestores de clientes
Devolve os utilizadores que podem ser selecionados como gestores num cliente.
Devoluções
- response
- array of UserModel
Lista de parceiros de trabalho
Devolve os utilizadores que podem ser selecionados como parceiros num trabalho.
Devoluções
- response
- array of UserModel
Lista de saudações
Lista de tarefas do grupo de tarefas do modelo
Devolve um grupo de tarefas e as suas tarefas para um modelo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | integer |
Identificador do modelo de trabalho. |
|
ID do grupo de tarefa
|
taskgroupId | True | integer |
Identificador do grupo de tarefa. |
Devoluções
Lista de tipos de email
Lista de tipos de impostos
Lista de tipos de telefone
Lista de utilizadores
Devolve uma lista paginada de utilizadores.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
|
|
Nome da função
|
rolename | string |
Filtrar utilizadores por nome do papel. |
Devoluções
- Corpo
- Users_Result
Lista prioridades do trabalho
Devolve as prioridades de trabalho disponíveis para o fluxo de trabalho.
Devoluções
- response
- array of JobPriority
Listar as relações com os clientes
Devolve uma lista paginada de relações para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
ID de Cliente
|
clientId | True | integer |
Identificador do cliente. |
Devoluções
- Corpo
- Relationships_Result
Listar contatos
Devolve uma lista de contactos paginada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
|
|
ID de contato
|
contactId | integer |
Filtrar por ID 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. |
Devoluções
- Corpo
- Contact_Result
Listar equipas
Listar estados do tipo de trabalho
Devolve os estados disponíveis dos tipos de trabalho do fluxo de trabalho.
Devoluções
- response
- array of JobTypeStatus
Listar etiquetas de cliente
Listar faturas
Devolve uma lista de faturas paginada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Projeto de lei preliminar
|
isDraftInvoice | boolean |
Filtra pela bandeira de rascunho-fatura. |
|
|
Inclua detalhes da fatura
|
includeInvoiceDetails | boolean |
Inclua os registos detalhados das faturas nos resultados. |
|
|
Status
|
status | string |
Filtra faturas por estado. |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtra pela bandeira de débito-cliente. |
|
|
Nome do cliente
|
clientname | string |
Filtra pelo nome do cliente. |
|
|
Código do cliente
|
clientcode | string |
Filtra por código do cliente. |
|
|
Nome do trabalho
|
jobname | string |
Filtra por nome do trabalho. |
|
|
Código de trabalho
|
jobcode | string |
Filtra por código de trabalho. |
|
|
ID da entidade de faturação
|
billingEntityId | string |
Filtrar por ID da entidade de faturação. |
Devoluções
- Corpo
- InvoiceDetail_Result
Listar funções
Listar grupos de clientes
Devolve uma lista paginada dos grupos de clientes e dos seus clientes membros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Código do grupo
|
groupCode | string |
Filtrar por código do grupo cliente. |
|
|
Código do cliente
|
clientCode | string |
Filtra por código do cliente. |
Devoluções
- Corpo
- ClientGroup_Result
Listar grupos de tarefas de trabalho
Devolve os grupos de tarefas de um trabalho de workflow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
Devoluções
- response
- array of ClientProfileTaskGroupData
Listar parceiros clientes
Devolve os utilizadores que podem ser selecionados como parceiros num cliente.
Devoluções
- response
- array of UserModel
Listar países
Listar tarefas
Devolve uma lista paginada das tarefas do trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
Status
|
status | string |
Filtra as tarefas por estado. |
|
|
ID do cessionário
|
assigneeId | string |
Filtra as tarefas pelo ID do utilizador atribuído. |
|
|
Dias até ao vencimento
|
daysUntilDue | integer |
Filtra as tarefas pelo número de dias até à data de vencimento. |
|
|
ID do trabalho
|
jobId | integer |
Filtra por ID do trabalho. |
Devoluções
- Corpo
- Tasks_Result
Listar tarefas do grupo de tarefa de tarefas
Devolve as tarefas num grupo de tarefas de um trabalho de fluxo de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
jobId | True | integer |
Identificador de trabalho do fluxo de trabalho. |
|
ID do grupo de tarefa
|
taskgroupId | True | integer |
Identificador do grupo de tarefa. |
Devoluções
- response
- array of ClientProfileTask
Listar vagas
Devolve uma lista paginada de trabalhos de workflow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Página
|
page | integer |
Número da página de resultados, começando em 1. |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens a devolver por página (máximo 1000). |
|
|
ID de Parceiro
|
partnerId | string |
Filtrar por ID do parceiro (utilizador). |
|
|
Nome do cliente
|
clientName | string |
Filtra pelo nome do cliente. |
|
|
Código do cliente
|
clientcode | string |
Filtra por código do cliente. |
|
|
Modificado desde
|
modifiedSince | string |
Registos de declaração modificados a partir deste carimbo temporal (ISO 8601). |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtra pela bandeira de débito-cliente. |
|
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados nos resultados. |
Devoluções
- Corpo
- Jobs_Result
Listas de modelos de emprego
Listas de tipos de funções
Devolve os tipos de trabalho disponíveis para o fluxo de trabalho.
Devoluções
- response
- array of JobType
Liste os tipos de tempo não faturáveis
Obtenha campos personalizados por contexto
Devolve os campos personalizados definidos para um contexto: cliente, contacto, trabalho ou todos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Contexto
|
context | True | string |
Contexto de campo personalizado: cliente, contacto, emprego ou todos. |
Obtenha o cliente por ID
Devolve os dados de um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID de Cliente
|
clientId | True | integer |
Identificador do cliente. |
|
Campos personalizados
|
isCustomField | boolean |
Inclua campos personalizados nos resultados. |
Devoluções
- Corpo
- ClientDetails_Result
Obtenha o mapeamento dos clientes devedores
Devolve os clientes devedores mapeados para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID de Cliente
|
clientId | True | integer |
Identificador do cliente. |
Devoluções
- response
- array of ClientDebtor
Tarefa de atualização
Atualiza um trabalho de fluxo de trabalho por ID.
Parâmetros
| Nome | 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 |
Devoluções
- Corpo
- ResponseMessage
Tarefa de atualização do modelo
Atualiza uma tarefa num grupo de tarefas de modelos de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID da tarefa
|
taskId | True | integer |
Identificador de tarefa. |
|
templateId
|
templateId | integer | ||
|
taskgroupId
|
taskgroupId | integer | ||
|
TaskTypeId
|
taskTypeId | integer | ||
|
Nome da tarefa
|
taskName | string | ||
|
roleId
|
roleId | integer | ||
|
unidade
|
unit | integer | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
startAfterDays
|
startAfterDays | integer | ||
|
dueAfterDays
|
dueAfterDays | integer |
Devoluções
- Corpo
- ResponseMessage
Tarefa de atualização do trabalho
Atualiza uma tarefa num grupo de tarefas de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID da tarefa
|
taskId | True | integer |
Identificador de tarefa. |
|
jobId
|
jobId | integer | ||
|
Nome da tarefa
|
taskName | string | ||
|
estado
|
status | string | ||
|
TaskTypeId
|
taskTypeId | integer | ||
|
taskgroupId
|
taskgroupId | integer | ||
|
taskLevelRoleId
|
taskLevelRoleId | integer | ||
|
userId
|
userId | string | ||
|
unidade
|
unit | integer | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
startDate
|
startDate | date-time | ||
|
data de vencimento
|
dueDate | date-time |
Devoluções
- Corpo
- ResponseMessage
Tarefa de criar modelo
Cria uma tarefa num grupo de tarefas de modelos de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
templateId
|
templateId | integer | ||
|
taskgroupId
|
taskgroupId | integer | ||
|
TaskTypeId
|
taskTypeId | integer | ||
|
Nome da tarefa
|
taskName | string | ||
|
roleId
|
roleId | integer | ||
|
unidade
|
unit | integer | ||
|
tarefaCategoria
|
taskCategory | string | ||
|
startAfterDays
|
startAfterDays | integer | ||
|
dueAfterDays
|
dueAfterDays | integer |
Devoluções
- Corpo
- ResponseMessage
Tempo de registo
Cria uma ou mais entradas de tempo em folha de horas (até 20 por pedido).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
isfaturabilmente
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Hora de início
|
starttime | time | ||
|
unidades
|
units | double | ||
|
Time
|
timeSheetTime | time | ||
|
Taxa
|
rate | double | ||
|
description
|
description | string |
Devoluções
- response
- array of PostJobLogTimeResponse
Títulos das listas
Definições
Endereço
| Nome | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
código
|
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 | |
|
correspondênciaNome
|
mailingName | string | |
|
tradingAs
|
tradingAs | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
Divisão
|
division | Division | |
|
tipo de entidade
|
entityType | string | |
|
indústria
|
industry | 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 | |
|
Din
|
din | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
isProspect
|
isProspect | 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 | |
|
lugarOfBirth
|
placeOfBirth | string | |
|
tipoDeConfiança
|
trustType | string | |
|
dataDeMorte
|
dateOfDeath | string | |
|
Data de formação
|
formationDate | string | |
|
Data de Revisão Anual
|
annualReviewDate | string | |
|
deRegistoData
|
deRegistrationDate | string | |
|
startDate
|
startDate | string | |
|
data de término
|
endDate | string | |
|
id
|
id | integer | |
|
tags
|
tags | array of tag | |
|
customFields
|
customFields | array of CustomField |
ContactosClientes
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ID de cliente
|
clientid | integer | |
|
contactid
|
contactid | integer | |
|
contactName
|
contactName | string | |
|
contexto
|
context | string |
ClienteDevedor
| Nome | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
código
|
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 | |
|
correspondênciaNome
|
mailingName | string | |
|
tradingAs
|
tradingAs | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
Divisão
|
division | Division | |
|
tipo de entidade
|
entityType | string | |
|
indústria
|
industry | 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 | |
|
isProspect
|
isProspect | 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 | |
|
lugarOfBirth
|
placeOfBirth | string | |
|
tipoDeConfiança
|
trustType | string | |
|
dataDeMorte
|
dateOfDeath | string | |
|
Data de formação
|
formationDate | string | |
|
Data de Revisão Anual
|
annualReviewDate | string | |
|
deRegistoData
|
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 | |
|
nome_do-banco
|
bankName | string | |
|
NomeContaBancária
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
BankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
cliente
|
client | array of ClientDetails |
ClientGroup_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of GroupClients | |
|
paginação
|
pagination | Pagination |
ClienteProfileTask
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
taskId
|
taskId | integer | |
|
TaskGroupId
|
taskGroupId | integer | |
|
taretaTítulo
|
taskTitle | string | |
|
description
|
description | string | |
|
startDate
|
startDate | date-time | |
|
data de vencimento
|
dueDate | date-time | |
|
estado
|
status | string | |
|
detentor
|
assignee | string | |
|
priority
|
priority | string | |
|
contextId
|
contextId | integer | |
|
contextType
|
contextType | string | |
|
Lembretes
|
reminders | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
Última modificação
|
lastmodified | string | |
|
jobTypeId
|
jobTypeId | integer | |
|
taskType
|
taskType | integer | |
|
unidade
|
unit | integer | |
|
totalUnit
|
totalUnit | integer | |
|
roleId
|
roleId | integer | |
|
nome_da-função
|
roleName | string | |
|
sequência
|
sequence | integer | |
|
assigneeUserDetails
|
assigneeUserDetails | array of TaskAssigneeUserDetails | |
|
isChecked
|
isChecked | boolean | |
|
documentosContagem
|
documentsCount | integer | |
|
clientId
|
clientId | integer | |
|
tarefaCategoria
|
taskCategory | TaskCategory | |
|
TarefaDependencyCount
|
taskDependencyCount | integer |
ClienteProfileTaskGroupData
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
TaskGroupId
|
taskGroupId | integer | |
|
jobId
|
jobId | integer | |
|
Nome do Grupo de Tarefa
|
taskGroupName | string | |
|
sequência
|
sequence | integer | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
Última modificação
|
lastmodified | string | |
|
taskCount
|
taskCount | integer | |
|
isTaskAllCheck
|
isTaskAllCheck | boolean | |
|
isSubTaskAllCheck
|
isSubTaskAllCheck | boolean | |
|
tasks
|
tasks | array of ClientProfileTask | |
|
statusCount
|
statusCount | StatusCount | |
|
cessionários
|
assignees | string |
Resumo do Cliente
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
Nome
|
name | string |
Client_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
paginação
|
pagination | Pagination |
CompositeTemplateTaskGroupViewModel
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Grupo de Tarefa
|
taskGroup | TaskTemplateGroupList | |
|
tasks
|
tasks | array of TaskTemplateViewDetailModel |
Contact
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
ContactType
|
contactType | string | |
|
contextType
|
contextType | integer | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone |
ContactEntity
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
saudação
|
salutation | string | |
|
title
|
title | string | |
|
firstName
|
firstName | string | |
|
Nome do meio
|
middleName | string | |
|
lastName
|
lastName | string | |
|
Género
|
gender | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
lugarOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
Din
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
dataDeMorte
|
dateOfDeath | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
contactos
|
contacts | array of ContactEntity | |
|
paginação
|
pagination | Pagination |
ContactsInfo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
contactId
|
contactId | integer | |
|
contextType
|
contextType | integer | |
|
systemId
|
systemId | string | |
|
código
|
code | string | |
|
title
|
title | string | |
|
Nome
|
name | string | |
|
saudação
|
salutation | string | |
|
preferredName
|
preferredName | string | |
|
e-mail
|
string | ||
|
phone
|
phone | string | |
|
weburl
|
weburl | string | |
|
últimaModificação
|
lastModified | string |
ContactsInfo_result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Contactos de Comunicação
|
communicationcontacts | array of ContactsInfo | |
|
paginação
|
pagination | Pagination |
País
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
paísId
|
countryId | integer | |
|
código
|
code | string | |
|
Nome
|
name | string | |
|
isdCode
|
isdCode | integer |
Campo Personalizado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
Cliente Devedor
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
Nome
|
name | string |
Divisão
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string |
DivisãoComDetalhes
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string | |
|
faturaçãoNomeEntidade
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
última modificação em
|
lastModifiedAt | string |
Divisionext
| Nome | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Divisões
|
divisions | array of Divisionext | |
|
paginação
|
pagination | Pagination |
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
typeId
|
typeId | integer | |
|
typeName
|
typeName | string | |
|
tipo
|
type | string | |
|
e-mail
|
string | ||
|
preferido
|
preferred | boolean | |
|
favorito
|
favourite | boolean |
EmailType
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
emailTypeId
|
emailTypeId | integer | |
|
emailNomeTipo
|
emailTypeName | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
EntityInfo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string |
Grupo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
Nome
|
name | string |
GroupClient
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
clientId
|
clientId | integer | |
|
tipo de entidade
|
entityType | string | |
|
ClientCode
|
clientCode | string | |
|
Nome do Cliente
|
clientname | string | |
|
isCliente Devedor
|
isDebtorClient | boolean | |
|
devedorClienteId
|
debtorClientId | integer |
GroupClientes
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
groupCode
|
groupCode | string | |
|
groupName
|
groupName | string | |
|
contacto
|
contact | groupContact | |
|
tags
|
tags | array of tag | |
|
clients
|
clients | array of GroupClient | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
Última modificação
|
lastmodified | string |
Membro do Grupo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
ID do membro
|
memberId | string | |
|
Nome
|
name | string | |
|
nome_da-função
|
roleName | string |
InvoiceDetail_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
paginação
|
pagination | Pagination |
InvoiceDetails
| Nome | 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 | |
|
Nome do imposto
|
taxName | string | |
|
taxRate
|
taxRate | double | |
|
gst
|
gst | double | |
|
pagamento
|
payment | double | |
|
créditoNota
|
creditNote | double | |
|
Ajuste de crédito
|
creditAdjustment | double | |
|
feeReversal
|
feeReversal | double | |
|
Má Dívida
|
badDebt | double | |
|
saldo
|
balance | double | |
|
estado
|
status | string | |
|
devedorClienteId
|
debtorClientId | integer | |
|
DevedorClienteCode
|
debtorClientCode | string | |
|
DevedorNomeCliente.
|
debtorClientName | string | |
|
correspondênciaNome
|
mailingName | string | |
|
clienteMailingName
|
clientMailingName | 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 | |
|
templateName
|
templateName | string |
InvoiceLines
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
número da linha
|
lineNumber | integer | |
|
Descrição da linha
|
lineDescription | string | |
|
linhaTotal
|
lineTotal | double |
JobData
| Nome | 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 | |
|
frequência
|
frequency | string | |
|
period
|
period | 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 | |
|
arquivadoEm
|
archivedAt | string | |
|
templateId
|
templateId | integer | |
|
jobTypeId
|
jobTypeId | integer | |
|
description
|
description | string | |
|
startDate
|
startDate | string | |
|
EmpregoCategoria
|
jobCategory | string | |
|
estimaçãoTipo
|
estimateType | string | |
|
Método de faturação
|
billingMethod | string | |
|
statusId
|
statusId | integer | |
|
quoteAmount
|
quoteAmount | double |
JobInvoice
| Nome | 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 |
JobPriority
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
empregoNomePrioridade
|
jobPriorityName | string | |
|
criado por
|
createdBy | string | |
|
últimaModificação
|
lastModified | string |
JobTemplate
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimaçãoTipo
|
estimateType | string | |
|
Turnaround
|
turnaround | integer | |
|
jobTypeId
|
jobTypeId | integer | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
Tipo de trabalho
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
JobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
EmpregoTipoEstado-de-Trabalho
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusNome
|
statusName | string | |
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Trabalho
| Nome | 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 | |
|
frequência
|
frequency | string | |
|
period
|
period | 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 | |
|
arquivadoEm
|
archivedAt | string |
Jobs_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
paginação
|
pagination | Pagination |
Sair
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string | |
|
description
|
description | string | |
|
tipo
|
type | string | |
|
estáAtivo
|
isActive | boolean | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
Pagination
| Nome | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
typeId
|
typeId | integer | |
|
typeName
|
typeName | string | |
|
tipo
|
type | string | |
|
paísId
|
countryId | integer | |
|
isdCode
|
isdCode | integer | |
|
number
|
number | string | |
|
preferido
|
preferred | boolean | |
|
favorito
|
favourite | boolean |
Tipo de Telefone
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
phoneTypeId
|
phoneTypeId | integer | |
|
NomeTipo do Telefone
|
phoneTypeName | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
PósTrabalhoLogTimeResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
isfaturabilmente
|
isbillable | boolean | |
|
jobId
|
jobId | integer | |
|
taskId
|
taskId | integer | |
|
nonbillableId
|
nonbillableId | integer | |
|
date
|
date | date | |
|
Hora de início
|
starttime | time | |
|
unidades
|
units | double | |
|
Time
|
timeSheetTime | time | |
|
Taxa
|
rate | double | |
|
description
|
description | string | |
|
Número da linha
|
rowNumber | integer | |
|
logTimeId
|
logTimeId | integer | |
|
éSucesso
|
isSuccess | boolean | |
|
mensagem
|
message | string |
Relationship
| Nome | 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
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
paginação
|
pagination | Pagination |
ResponseMessage
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | string | |
|
estado
|
status | string | |
|
mensagem
|
message | string | |
|
Data atual
|
currentDate | date-time |
Função Unidade
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
roleId
|
roleId | integer | |
|
unidade
|
unit | integer |
Detalhes dos papéis
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
roleId
|
roleId | integer | |
|
accountingFirmId
|
accountingFirmId | integer | |
|
nome_da-função
|
roleName | string | |
|
defaultRoleName
|
defaultRoleName | string | |
|
description
|
description | string | |
|
isSystem
|
isSystem | boolean |
Saudação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
saudação
|
salutation | string |
Funcionários
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | string | |
|
Nome
|
name | string | |
|
e-mail
|
string |
EstadoCatágoria
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string |
StatusCount
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
notStartedCount
|
notStartedCount | integer | |
|
inProgressCount
|
inProgressCount | integer | |
|
onHoldCount
|
onHoldCount | integer | |
|
Contagem de críticas
|
reviewCount | integer | |
|
completadoContagem
|
completedCount | integer | |
|
contagemTotal
|
totalCount | integer |
TagModel
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string | |
|
isDisabled
|
isDisabled | boolean | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
TaskAssigneeUserDetails
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
userId
|
userId | string | |
|
taskId
|
taskId | integer | |
|
shortNome
|
shortName | string | |
|
Nome completo
|
fullName | string | |
|
custo
|
cost | double | |
|
Taxa
|
rate | double | |
|
time
|
time | double | |
|
unidade
|
unit | integer | |
|
totalUnit
|
totalUnit | integer | |
|
isFirstUserForRole
|
isFirstUserForRole | boolean | |
|
roleId
|
roleId | integer | |
|
nome_da-função
|
roleName | string |
CategoriaDeTarefa
TaskDetail
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string |
Modelo de Tarefa
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
taskId
|
taskId | integer | |
|
Nome da tarefa
|
taskName | string | |
|
jobId
|
jobId | integer | |
|
nome do trabalho
|
jobName | string | |
|
gestor de emprego
|
jobManager | Staff | |
|
empregoParceiro
|
jobPartner | Staff | |
|
empregoCliente
|
jobClient | clientInfo | |
|
empregoDevedor
|
jobDebtor | clientInfo | |
|
TrabalhoDivisão
|
jobDivision | EntityInfo | |
|
cessionários
|
assignees | array of Staff | |
|
taskType
|
taskType | string | |
|
startDate
|
startDate | date-time | |
|
data de vencimento
|
dueDate | date-time | |
|
diasAté ao Fim
|
daysUntilDue | string | |
|
tarefaCategoria
|
taskCategory | string | |
|
estado
|
status | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
TaskTemplateGroupList
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
taskgroupId
|
taskgroupId | integer | |
|
Nome do Grupo de Tarefa
|
taskGroupName | string | |
|
createdBY
|
createdBY | string | |
|
criado
|
created | string | |
|
Última modificação
|
lastmodified | string |
TaskTemplateViewDetailModel
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
taskId
|
taskId | integer | |
|
taskgroupId
|
taskgroupId | integer | |
|
taskType
|
taskType | string | |
|
TaskTypeId
|
taskTypeId | integer | |
|
sequência
|
sequence | integer | |
|
Nome da tarefa
|
taskName | string | |
|
keyFlag
|
keyFlag | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
Última modificação
|
lastmodified | string | |
|
roleId
|
roleId | integer | |
|
templateId
|
templateId | integer | |
|
unidade
|
unit | integer | |
|
Funções Unidades
|
rolesUnits | array of RoleUnit | |
|
tarefaMembros
|
taskMembers | array of string | |
|
tarefaCategoria
|
taskCategory | TaskCategory | |
|
TarefaDependencyCount
|
taskDependencyCount | integer | |
|
startAfterDays
|
startAfterDays | integer | |
|
dueAfterDays
|
dueAfterDays | integer |
Tasks_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
tasks
|
tasks | array of TaskModel | |
|
paginação
|
pagination | Pagination |
TaxTipos
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
taxId
|
taxId | integer | |
|
Nome do imposto
|
taxName | string | |
|
taxRate
|
taxRate | double | |
|
effectiveFrom
|
effectiveFrom | string | |
|
eficazPara
|
effectiveTo | string | |
|
isDefault
|
isDefault | boolean | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
Teams
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
Nome
|
name | string | |
|
membros do grupo
|
groupMembers | array of GroupMember |
TimeSheetLogs
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
isfaturabilmente
|
isbillable | boolean | |
|
jobId
|
jobId | integer | |
|
taskId
|
taskId | integer | |
|
nonbillableId
|
nonbillableId | integer | |
|
date
|
date | date | |
|
Hora de início
|
starttime | time | |
|
unidades
|
units | double | |
|
Time
|
timeSheetTime | time | |
|
Taxa
|
rate | double | |
|
description
|
description | string | |
|
clientId
|
clientId | integer | |
|
logTimeId
|
logTimeId | integer | |
|
userId
|
userId | string | |
|
criado por
|
createdBy | string | |
|
criado
|
created | string | |
|
estado
|
status | string |
TimeSheet_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Folhas de Horas
|
timeSheets | array of TimeSheetLogs | |
|
paginação
|
pagination | Pagination |
Title
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
title
|
title | string |
UserDetail
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | string | |
|
Nome
|
name | string |
UserModel
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | string | |
|
Nome
|
name | string | |
|
nome_da-função
|
roleName | string | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string |
UsersWithDetails
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | string | |
|
Nome
|
name | string | |
|
nome_da-função
|
roleName | string | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
e-mail
|
|||
|
phone
|
phone | Phone | |
|
Endereço
|
address | Address | |
|
criado
|
created | string | |
|
últimaModificação
|
lastModified | string |
Users_Result
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
paginação
|
pagination | Pagination |
clienteInfo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string | |
|
código
|
code | string |
groupContact
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
Nome
|
name | string | |
|
contextType
|
contextType | integer |
etiqueta
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
tagId
|
tagId | integer | |
|
tagName
|
tagName | string |