KC (anteprima)
KC Practice Management consente l'accesso sicuro ai dati client e aziendali, consentendo agli utenti di recuperare e gestire le informazioni in modo efficiente tramite flussi di lavoro automatizzati.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree Power Automate ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Standard | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Azure cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree Power Apps ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree Power Automate ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto di Kloud Connect |
| URL | https://www.kloudconnect.com.au/ |
| Posta elettronica | support@kloudconnect.com.au |
| Metadati del connettore | |
|---|---|
| Editore | Kloud Connect |
| Sito web | https://www.kloudconnect.com.au/ |
| Informativa sulla privacy | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Categories | Gestione aziendale; Finanza |
Gestione delle pratiche di Connect Disaud
Overview
In questo modo è possibile accedere alle API di gestione delle procedure di Connect Di Kloud.
Features
- Elencare i client
- Creare client
- Elenca contatti
- Creare contatti
- Elencare le fatture
- Crea scheda attività
- Elencare le attività
- Creare attività
- Elenca lavori
- Creare lavori
- Accedere ai dati di gestione delle procedure di accesso
Authentication
OAuth 2.0 tramite Il server di gestione delle identità di Kloud Connect
Support
support@kloudconnect.com.au
Azioni
| Aggiornare il client in base all'ID |
Aggiorna un client in base all'ID. |
| Aggiornare il gruppo client |
Aggiorna un gruppo client in base al codice di gruppo. |
| Aggiornare il processo |
Aggiorna un processo del flusso di lavoro in base all'ID. |
| Aggiornare lo stato e la priorità del processo |
Aggiorna lo stato e la priorità per i processi del flusso di lavoro. |
| Aggiornare un contatto |
Aggiorna un contatto in base all'ID. |
| Creare il client |
Crea un client. |
| Creare il processo |
Crea un processo del flusso di lavoro. |
| Creare un gruppo client |
Crea un gruppo client. |
| Elencare gli stati del tipo di processo |
Restituisce gli stati del tipo di processo del flusso di lavoro disponibili. |
| Elencare gli utenti |
Restituisce un elenco di utenti con paging. |
| Elencare i client |
Restituisce un elenco di client con paging. |
| Elencare i contatti |
Restituisce un elenco di contatti di paging. |
| Elencare i lavori |
Restituisce un elenco di processi del flusso di lavoro di paging. |
| Elencare i modelli di processo |
Restituisce i modelli di processo del flusso di lavoro disponibili. |
| Elencare i tag client |
Restituisce i tag client disponibili. |
| Elencare i team |
Restituisce i team disponibili. |
| Elencare i tipi di processo |
Restituisce i tipi di processo del flusso di lavoro disponibili. |
| Elencare i tipi di tempo non fatturabili |
Restituisce i tipi di scheda attività non fatturabili disponibili. |
| Elencare le divisioni |
Restituisce un elenco di divisioni a pagina. |
| Elencare le fatture |
Restituisce un elenco di fatture con paging. |
| Elencare le priorità dei processi |
Restituisce le priorità del processo del flusso di lavoro disponibili. |
| Elencare le relazioni client |
Restituisce un elenco di relazioni client con paging. |
| Ora del log |
Crea una voce della scheda attività. |
| Ottenere campi personalizzati in base al contesto |
Restituisce campi personalizzati per il contesto specificato. |
| ottenere gruppi di client |
ottenere gruppi di client |
| Ottenere il client in base all'ID |
Restituisce i dettagli per un client in base all'ID. |
| Ottenere il mapping dei clienti debitori |
Restituisce il mapping dei clienti debitori per un cliente. |
Aggiornare il client in base all'ID
Aggiorna un client in base all'ID.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del cliente
|
clientId | True | integer |
Client identifier. (Identificatore cliente.) |
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
saluto
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
secondo nome
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
tipo di fiducia
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
Nome di trading
|
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 | |
|
Prospettiva
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Genere
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
Numero
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
sito web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
unità
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
indirizzoLinea1
|
addressLine1 | string | ||
|
indirizzoLinea2
|
addressLine2 | string | ||
|
sobborgo
|
suburb | string | ||
|
Stato
|
state | string | ||
|
Paese
|
country | string | ||
|
codice postale
|
postCode | string | ||
|
industria
|
industry | string | ||
|
Ruolo
|
role | string | ||
|
stipendio
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
potere
|
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 |
Aggiornare il gruppo client
Aggiorna un gruppo client in base al codice di gruppo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Codice gruppo
|
groupCode | True | string |
Codice del gruppo client. |
|
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 |
Aggiornare il processo
Aggiorna un processo del flusso di lavoro in base all'ID.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID lavoro
|
jobId | True | integer |
Identificatore del processo del flusso di lavoro. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debitclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
Jobcategory
|
jobCategory | string | ||
|
nomeLavoro
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
DueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Priorità
|
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 |
Aggiornare lo stato e la priorità del processo
Aggiorna lo stato e la priorità per i processi del flusso di lavoro.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
Priorità
|
priority | string | ||
|
stato
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Aggiornare un contatto
Aggiorna un contatto in base all'ID.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contatto
|
contactId | True | integer |
Identificatore del contatto. |
|
saluto
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
secondo nome
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
Genere
|
gender | string | ||
|
type
|
type | string | ||
|
Numero
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
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 | ||
|
unità
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
indirizzoLinea1
|
addressLine1 | string | ||
|
indirizzoLinea2
|
addressLine2 | string | ||
|
sobborgo
|
suburb | string | ||
|
Stato
|
state | string | ||
|
Paese
|
country | string | ||
|
codice postale
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Creare il client
Crea un client.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
saluto
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
secondo nome
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
tipo di fiducia
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
Nome di trading
|
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 | |
|
Prospettiva
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Genere
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
Numero
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
sito web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
unità
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
indirizzoLinea1
|
addressLine1 | string | ||
|
indirizzoLinea2
|
addressLine2 | string | ||
|
sobborgo
|
suburb | string | ||
|
Stato
|
state | string | ||
|
Paese
|
country | string | ||
|
codice postale
|
postCode | string | ||
|
industria
|
industry | string | ||
|
Ruolo
|
role | string | ||
|
stipendio
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
potere
|
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 |
Creare il processo
Crea un processo del flusso di lavoro.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debitclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
nomeLavoro
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
DueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Priorità
|
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 |
Creare un gruppo client
Crea un gruppo client.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
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 |
Elencare gli stati del tipo di processo
Restituisce gli stati del tipo di processo del flusso di lavoro disponibili.
Valori restituiti
- Corpo
- JobTypeStatus
Elencare gli utenti
Restituisce un elenco di utenti con paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di utenti da restituire per pagina. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituisce gli utenti modificati in o dopo questo timestamp. |
|
|
Nome del ruolo
|
rolename | string |
Filtrare gli utenti in base al nome del ruolo. |
Valori restituiti
- Corpo
- Users_Result
Elencare i client
Restituisce un elenco di client con paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati (in base 1). |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di elementi per pagina. |
|
|
ID del partner
|
partnerId | string |
Filtrare in base all'identificatore del partner. |
|
|
Client di debito
|
isDebitClient | boolean |
Filtrare in base al flag del client di debito. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituisce i client modificati in/dopo questo timestamp (ISO 8601). |
|
|
Codice gruppo
|
groupCode | string |
Filtrare in base al codice del gruppo. |
|
|
ID del cliente
|
clientId | integer |
Filtrare in base all'ID client. |
|
|
Campi personalizzati
|
isCustomField | boolean |
Includere campi personalizzati. |
Valori restituiti
- Corpo
- Client_Result
Elencare i contatti
Restituisce un elenco di contatti di paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di contatti da restituire per pagina. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituisce i contatti modificati in o dopo questo timestamp. |
|
|
ID contatto
|
contactId | integer |
Filtrare i contatti in base all'identificatore di contatto. |
|
|
Filtro ID client
|
isClientId | boolean |
Indica se il filtro id contatto deve essere considerato come ID client. |
|
|
Campi personalizzati
|
isCustomField | boolean |
Includere campi personalizzati nei risultati dei contatti. |
Valori restituiti
- Corpo
- Contact_Result
Elencare i lavori
Restituisce un elenco di processi del flusso di lavoro di paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di processi da restituire per pagina. |
|
|
ID del partner
|
partnerId | string |
Filtrare i processi in base all'identificatore del partner. |
|
|
Nome del client
|
clientName | string |
Filtrare i processi in base al nome del client. |
|
|
Codice client
|
clientcode | string |
Filtrare i processi in base al codice client. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituisce i processi modificati in o dopo questo timestamp. |
|
|
Client di debito
|
isDebitClient | boolean |
Filtrare i processi in base al flag client di debito. |
|
|
Campi personalizzati
|
isCustomField | boolean |
Includere campi personalizzati nei risultati del processo. |
Valori restituiti
- Corpo
- Jobs_Result
Elencare i modelli di processo
Restituisce i modelli di processo del flusso di lavoro disponibili.
Valori restituiti
- Corpo
- JobTemplate
Elencare i tag client
Restituisce i tag client disponibili.
Elencare i team
Elencare i tipi di processo
Elencare i tipi di tempo non fatturabili
Restituisce i tipi di scheda attività non fatturabili disponibili.
Elencare le divisioni
Restituisce un elenco di divisioni a pagina.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di divisioni da restituire per pagina. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituisce le divisioni modificate in o dopo questo timestamp. |
Valori restituiti
- Corpo
- Divisions_Result
Elencare le fatture
Restituisce un elenco di fatture con paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di fatture da restituire per pagina. |
|
|
Bozza fattura
|
isDraftInvoice | boolean |
Filtrare le fatture in base al flag della fattura bozza. |
|
|
Includi dettagli fattura
|
includeInvoiceDetails | boolean |
Includere i record dei dettagli della fattura nella risposta. |
|
|
Condizione
|
status | string |
Filtrare le fatture in base allo stato. |
|
|
Modificato dopo
|
modifiedSince | string |
Restituire le fatture modificate in o dopo questo timestamp. |
|
|
Client di debito
|
isDebitClient | boolean |
Filtrare le fatture in base al flag client di debito. |
|
|
Nome del client
|
clientname | string |
Filtrare le fatture in base al nome del client. |
|
|
Codice client
|
clientcode | string |
Filtrare le fatture in base al codice client. |
|
|
Nome attività
|
jobname | string |
Filtrare le fatture in base al nome del processo. |
|
|
Codice del processo
|
jobcode | string |
Filtrare le fatture in base al codice del processo. |
|
|
ID entità di fatturazione
|
billingEntityId | string |
Filtrare le fatture in base all'identificatore dell'entità di fatturazione. |
Valori restituiti
- Corpo
- InvoiceDetail_Result
Elencare le priorità dei processi
Restituisce le priorità del processo del flusso di lavoro disponibili.
Valori restituiti
- Corpo
- JobPriorityValues
Elencare le relazioni client
Restituisce un elenco di relazioni client con paging.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del cliente
|
clientId | True | integer |
Client identifier. (Identificatore cliente.) |
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di relazioni da restituire per pagina. |
Valori restituiti
- Corpo
- Relationships_Result
Ora del log
Crea una voce della scheda attività.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Unità
|
units | double | ||
|
ora di inizio
|
starttime | string | ||
|
Tasso
|
rate | double | ||
|
description
|
description | string |
Ottenere campi personalizzati in base al contesto
Restituisce campi personalizzati per il contesto specificato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Contesto
|
context | True | string |
Contesto dei campi personalizzati. |
ottenere gruppi di client
ottenere gruppi di client
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Numero di pagina dei risultati. |
|
|
Dimensioni della pagina
|
pageSize | integer |
Numero di gruppi client da restituire per pagina. |
|
|
Codice gruppo
|
groupCode | string |
Filtrare i gruppi client in base al codice del gruppo. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
contatto
|
clientGroups.contact | string |
contatto |
|
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 |
|
nome client
|
clientGroups.clients.clientname | string |
nome client |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debitClientId
|
clientGroups.clients.debtorClientId | integer |
debitClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
creato
|
clientGroups.created | string |
creato |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
total_records
|
pagination.total_records | integer |
total_records |
|
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 |
Ottenere il client in base all'ID
Restituisce i dettagli per un client in base all'ID.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del cliente
|
clientId | True | integer |
Client identifier. (Identificatore cliente.) |
|
Campi personalizzati
|
isCustomField | boolean |
Includere campi personalizzati. |
Valori restituiti
- Corpo
- ClientDetails_Result
Ottenere il mapping dei clienti debitori
Restituisce il mapping dei clienti debitori per un cliente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del cliente
|
clientId | True | integer |
Client identifier. (Identificatore cliente.) |
Valori restituiti
- Corpo
- ClientDebtor
Definizioni
Indirizzo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
unità
|
unit | string | |
|
careOf
|
careOf | string | |
|
indirizzoLinea1
|
addressLine1 | string | |
|
indirizzoLinea2
|
addressLine2 | string | |
|
sobborgo
|
suburb | string | |
|
Stato
|
state | string | |
|
Paese
|
country | string | |
|
codice postale
|
postCode | string |
Client
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
codice
|
code | string | |
|
saluto
|
salutation | string | |
|
nome
|
name | string | |
|
firstName
|
firstName | string | |
|
secondo nome
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
divisione
|
division | Division | |
|
entityType
|
entityType | string | |
|
partner
|
partner | Staff | |
|
direttore
|
manager | Staff | |
|
contatti
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
potere
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
stato
|
status | string | |
|
group
|
group | Group | |
|
debitoreClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
debitore
|
debtorid | integer | |
|
nome debitore
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
codice
|
code | string | |
|
saluto
|
salutation | string | |
|
nome
|
name | string | |
|
firstName
|
firstName | string | |
|
secondo nome
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
divisione
|
division | Division | |
|
entityType
|
entityType | string | |
|
partner
|
partner | Staff | |
|
direttore
|
manager | Staff | |
|
contatti
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
potere
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
stato
|
status | string | |
|
group
|
group | Group | |
|
debitoreClient
|
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 | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
cliente
|
client | array of ClientDetails |
ClientSummary
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
codice
|
code | string | |
|
nome
|
name | string |
Client_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
Paginazione
|
pagination | Pagination |
Contatto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
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 | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
saluto
|
salutation | string | |
|
firstName
|
firstName | string | |
|
secondo nome
|
middleName | string | |
|
lastName
|
lastName | string | |
|
Genere
|
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 | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
nome
|
name | string | |
|
location
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
contatti
|
contacts | array of ContactEntity | |
|
Paginazione
|
pagination | Pagination |
CustomField
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DebitoreClient
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
codice
|
code | string | |
|
nome
|
name | string |
Divisione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string |
DivisionWithDetails
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
Ultima modifica il
|
lastModifiedAt | string |
Divisionext
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
Ultima modifica il
|
lastModifiedAt | string | |
|
ultima modifica di
|
lastModifiedBy | string | |
|
creato
|
created | string |
Divisions_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Divisioni
|
divisions | array of Divisionext | |
|
Paginazione
|
pagination | Pagination |
Posta elettronica
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
type
|
type | string | |
|
email
|
string | ||
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Group
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
codice
|
code | string | |
|
nome
|
name | string |
Membro del gruppo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
nome
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
Paginazione
|
pagination | Pagination |
InvoiceDetails
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
Numero
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
Dovuto a
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
pagamento
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
bilancia
|
balance | double | |
|
stato
|
status | string | |
|
debitClientId
|
debtorClientId | integer | |
|
debitClientCode
|
debtorClientCode | string | |
|
debitClientName
|
debtorClientName | string | |
|
debitoreBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string |
InvoiceLines
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
NumeroLinea
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
nome
|
name | string | |
|
wip
|
wip | double | |
|
cliente
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
direttore
|
manager | Staff | |
|
divisione
|
division | DivisionWithDetails | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string | |
|
debitoreClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
Modello di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Turnaround
|
turnaround | integer | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string |
Tipo di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string |
JobTypeStatus
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
ID categoria
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
nome
|
name | string | |
|
Priorità
|
priority | string | |
|
DueDate
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Wip
|
wip | double | |
|
cliente
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
direttore
|
manager | Staff | |
|
divisione
|
division | DivisionWithDetails | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string | |
|
debitoreClient
|
debtorClient | DebtorClient | |
|
stato
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
Assegnatari
|
assignees | array of UserDetail | |
|
team
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
Paginazione
|
pagination | Pagination |
Pagination
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
total_records
|
total_records | integer | |
|
current_page
|
current_page | integer | |
|
page_Size
|
page_Size | integer | |
|
total_pages
|
total_pages | integer | |
|
next_page
|
next_page | integer | |
|
next_pageurl
|
next_pageurl | string | |
|
prev_page
|
prev_page | integer | |
|
prev_pageurl
|
prev_pageurl | string |
Telefono
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
type
|
type | string | |
|
Numero
|
number | string | |
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
entityId
|
entityId | string | |
|
nome
|
name | string | |
|
entità
|
entity | string | |
|
startDate
|
startDate | string | |
|
Data di fine
|
endDate | string | |
|
Unità
|
units | integer |
Relationships_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
Paginazione
|
pagination | Pagination |
Personale
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
email
|
string |
TaskDetail
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string |
Teams
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
nome
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string |
UsersWithDetails
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
indirizzo
|
address | Address | |
|
creato
|
created | string | |
|
ultima modifica
|
lastModified | string |
Users_Result
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
Paginazione
|
pagination | Pagination |