KC (Preview)
KC Practice Management umožňuje zabezpečený přístup k klientským a obchodním datům, což uživatelům umožňuje efektivně načítat a spravovat informace prostřednictvím automatizovaných pracovních postupů.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logické aplikace | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Azure oblasti Čína - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Automatizace napájení | Premium | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Name | Podpora Kloud Connect |
| URL | https://www.kloudconnect.com.au/ |
| support@kloudconnect.com.au |
| Metadata konektoru | |
|---|---|
| Vydavatel | Kloud Connect |
| Internetová stránka | https://www.kloudconnect.com.au/ |
| Zásady ochrany osobních údajů | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Kategorie | Řízení podniku; Finance |
Kloud Connect Practice Management
Přehled
To poskytuje přístup k rozhraním API služby Kloud Connect Practice Management.
Features
- Výpis klientů
- Vytváření klientů
- Seznam kontaktů
- Vytvoření kontaktů
- Výpis faktur
- Vytvoření časového rozvrhu
- Výpis úkolů
- Vytváření úkolů
- Seznam pracovních míst
- Vytváření úloh
- Access practice management data
Autentizace
OAuth 2.0 přes Kloud Connect Identity Server
Podpora
support@kloudconnect.com.au
Akce
| Aktualizace klienta podle ID |
Aktualizuje klienta podle ID. |
| Aktualizace skupiny klientů |
Aktualizuje skupinu klientů podle kódu skupiny. |
| Aktualizace stavu a priority úlohy |
Aktualizuje stav a prioritu pro úlohy pracovního postupu. |
| Aktualizovat kontakt |
Aktualizuje kontakt podle ID. |
| Seznam divizí |
Vrátí stránkovaný seznam divizí. |
| Seznam uživatelů |
Vrátí stránkovaný seznam uživatelů. |
| Vytvoření klienta |
Vytvoří klienta. |
| Vytvoření skupiny klientů |
Vytvoří skupinu klientů. |
| Vytvoření úlohy |
Vytvoří úlohu pracovního postupu. |
| Výpis faktur |
Vrátí stránkovaný seznam faktur. |
| Výpis klientů |
Vrátí stránkovaný seznam klientů. |
| Výpis kontaktů |
Vrátí stránkovaný seznam kontaktů. |
| Výpis nefakturovatelných časových typů |
Vrátí dostupné nefakturovatelné typy časového rozvrhu. |
| Výpis priorit úloh |
Vrátí dostupné priority úloh pracovního postupu. |
| Výpis relací klientů |
Vrátí stránkovaný seznam vztahů klientů. |
| Výpis stavů typů úloh |
Vrátí dostupné stavy typu úlohy pracovního postupu. |
| Výpis typů úloh |
Vrátí dostupné typy úloh pracovního postupu. |
| Výpis týmů |
Vrátí dostupné týmy. |
| Výpis značek klienta |
Vrátí dostupné značky klienta. |
| Výpis úloh |
Vrátí stránkovaný seznam úloh pracovního postupu. |
| Výpis šablon úloh |
Vrátí dostupné šablony úloh pracovního postupu. |
| Získání klienta podle ID |
Vrátí podrobnosti o klientovi podle ID. |
| Získání mapování klientů dlužníka |
Vrátí mapování klienta dlužníka pro klienta. |
| získání skupin klientů |
získání skupin klientů |
| Získání vlastních polí podle kontextu |
Vrátí vlastní pole pro zadaný kontext. |
| Úloha aktualizace |
Aktualizuje úlohu pracovního postupu podle ID. |
| Čas protokolu |
Vytvoří položku časového rozvrhu. |
Aktualizace klienta podle ID
Aktualizuje klienta podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID klienta
|
clientId | True | integer |
Identifikátor klienta. |
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
oslovení
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
prostřední jméno
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
typ důvěry
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
obchodní jméno
|
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 | |
|
Vyhlídky
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
datum narození
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
pohlaví
|
gender | string | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
oblíbený
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
Číslo
|
number | string | ||
|
oblíbený
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formaceDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
jednotka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
adresaŘádek2
|
addressLine2 | string | ||
|
předměstí
|
suburb | string | ||
|
stav
|
state | string | ||
|
Země
|
country | string | ||
|
PSČ
|
postCode | string | ||
|
průmysl
|
industry | string | ||
|
role
|
role | string | ||
|
plat
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Rezidentní
|
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 |
Aktualizace skupiny klientů
Aktualizuje skupinu klientů podle kódu skupiny.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Kód skupiny
|
groupCode | True | string |
Kód skupiny klientů. |
|
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 |
Aktualizace stavu a priority úlohy
Aktualizuje stav a prioritu pro úlohy pracovního postupu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
Priorita
|
priority | string | ||
|
stav
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Aktualizovat kontakt
Aktualizuje kontakt podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kontaktu
|
contactId | True | integer |
Identifikátor kontaktu. |
|
oslovení
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
prostřední jméno
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
pohlaví
|
gender | string | ||
|
typ
|
type | string | ||
|
Číslo
|
number | string | ||
|
oblíbený
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
oblíbený
|
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 | ||
|
jednotka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
adresaŘádek2
|
addressLine2 | string | ||
|
předměstí
|
suburb | string | ||
|
stav
|
state | string | ||
|
Země
|
country | string | ||
|
PSČ
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Seznam divizí
Vrátí stránkovaný seznam divizí.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet dělení, které se mají vrátit na stránku |
|
|
Změněno od
|
modifiedSince | string |
Vrátí dělení změněná po tomto časovém razítku nebo po tomto časovém razítku. |
Návraty
- Tělo
- Divisions_Result
Seznam uživatelů
Vrátí stránkovaný seznam uživatelů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet uživatelů, kteří se mají vrátit na stránku |
|
|
Změněno od
|
modifiedSince | string |
Vrátí uživatele změněné podle tohoto časového razítka nebo po tomto časovém razítku. |
|
|
Název role
|
rolename | string |
Filtrovat uživatele podle názvu role |
Návraty
- Tělo
- Users_Result
Vytvoření klienta
Vytvoří klienta.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
oslovení
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
prostřední jméno
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
typ důvěry
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
obchodní jméno
|
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 | |
|
Vyhlídky
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
datum narození
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
pohlaví
|
gender | string | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
oblíbený
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
Číslo
|
number | string | ||
|
oblíbený
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formaceDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
jednotka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
adresaŘádek2
|
addressLine2 | string | ||
|
předměstí
|
suburb | string | ||
|
stav
|
state | string | ||
|
Země
|
country | string | ||
|
PSČ
|
postCode | string | ||
|
průmysl
|
industry | string | ||
|
role
|
role | string | ||
|
plat
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Rezidentní
|
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 |
Vytvoření skupiny klientů
Vytvoří skupinu klientů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
groupName
|
groupName | string | ||
|
partnerId
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
Vytvoření úlohy
Vytvoří úlohu pracovního postupu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
dlužníkclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
název úlohy
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
splatné datum
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Priorita
|
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 |
Výpis faktur
Vrátí stránkovaný seznam faktur.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet faktur, které se mají vrátit na stránku |
|
|
Koncept faktury
|
isDraftInvoice | boolean |
Vyfiltrujte faktury podle příznaku konceptu faktury. |
|
|
Zahrnout podrobnosti o faktuře
|
includeInvoiceDetails | boolean |
Do odpovědi zahrňte záznamy podrobností o faktuře. |
|
|
Status
|
status | string |
Umožňuje filtrovat faktury podle stavu. |
|
|
Změněno od
|
modifiedSince | string |
Vrátí faktury změněné po tomto časovém razítku nebo po tomto časovém razítku. |
|
|
Klient inkasa
|
isDebitClient | boolean |
Vyfiltrujte faktury podle příznaku klienta inkasa. |
|
|
Název klienta
|
clientname | string |
Vyfiltrujte faktury podle názvu klienta. |
|
|
Kód klienta
|
clientcode | string |
Vyfiltrujte faktury podle kódu klienta. |
|
|
Název úlohy
|
jobname | string |
Vyfiltrujte faktury podle názvu úlohy. |
|
|
Kód úlohy
|
jobcode | string |
Vyfiltrujte faktury podle kódu úlohy. |
|
|
ID fakturační entity
|
billingEntityId | string |
Vyfiltrujte faktury podle identifikátoru fakturační entity. |
Návraty
- Tělo
- InvoiceDetail_Result
Výpis klientů
Vrátí stránkovaný seznam klientů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků (založené na 1). |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek na stránku. |
|
|
ID partnera
|
partnerId | string |
Filtrovat podle identifikátoru partnera. |
|
|
Klient inkasa
|
isDebitClient | boolean |
Filtrovat podle příznaku debetního klienta |
|
|
Změněno od
|
modifiedSince | string |
Vrátit klienty změněné na/po tomto časovém razítku (ISO 8601). |
|
|
Kód skupiny
|
groupCode | string |
Filtrovat podle kódu skupiny |
|
|
ID klienta
|
clientId | integer |
Vyfiltrujte podle ID klienta. |
|
|
Vlastní pole
|
isCustomField | boolean |
Zahrnout vlastní pole |
Návraty
- Tělo
- Client_Result
Výpis kontaktů
Vrátí stránkovaný seznam kontaktů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet kontaktů, které se mají vrátit na stránku |
|
|
Změněno od
|
modifiedSince | string |
Vrátí kontakty změněné po tomto časovém razítku nebo po tomto časovém razítku. |
|
|
ID kontaktu
|
contactId | integer |
Filtrujte kontakty podle identifikátoru kontaktu. |
|
|
Filtr ID klienta
|
isClientId | boolean |
Určuje, jestli se má filtr ID kontaktu považovat za ID klienta. |
|
|
Vlastní pole
|
isCustomField | boolean |
Do výsledků kontaktu zahrňte vlastní pole. |
Návraty
- Tělo
- Contact_Result
Výpis nefakturovatelných časových typů
Vrátí dostupné nefakturovatelné typy časového rozvrhu.
Výpis priorit úloh
Výpis relací klientů
Vrátí stránkovaný seznam vztahů klientů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID klienta
|
clientId | True | integer |
Identifikátor klienta. |
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet relací, které se mají vrátit na stránku |
Návraty
- Tělo
- Relationships_Result
Výpis stavů typů úloh
Výpis typů úloh
Výpis týmů
Výpis značek klienta
Vrátí dostupné značky klienta.
Výpis úloh
Vrátí stránkovaný seznam úloh pracovního postupu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet úloh, které se mají vrátit na stránku |
|
|
ID partnera
|
partnerId | string |
Filtrování úloh podle identifikátoru partnera |
|
|
Název klienta
|
clientName | string |
Filtrování úloh podle názvu klienta |
|
|
Kód klienta
|
clientcode | string |
Filtrování úloh podle kódu klienta |
|
|
Změněno od
|
modifiedSince | string |
Vrátí úlohy změněné podle tohoto časového razítka nebo po tomto časovém razítku. |
|
|
Klient inkasa
|
isDebitClient | boolean |
Filtrování úloh podle příznaku klienta inkasa |
|
|
Vlastní pole
|
isCustomField | boolean |
Do výsledků úlohy zahrňte vlastní pole. |
Návraty
- Tělo
- Jobs_Result
Výpis šablon úloh
Získání klienta podle ID
Vrátí podrobnosti o klientovi podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID klienta
|
clientId | True | integer |
Identifikátor klienta. |
|
Vlastní pole
|
isCustomField | boolean |
Zahrnout vlastní pole |
Návraty
- Tělo
- ClientDetails_Result
Získání mapování klientů dlužníka
Vrátí mapování klienta dlužníka pro klienta.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID klienta
|
clientId | True | integer |
Identifikátor klienta. |
Návraty
- Tělo
- ClientDebtor
získání skupin klientů
získání skupin klientů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledků |
|
|
Velikost stránky
|
pageSize | integer |
Počet skupin klientů, které se mají vrátit na stránku |
|
|
Kód skupiny
|
groupCode | string |
Filtrování skupin klientů podle kódu skupiny |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
kontakt
|
clientGroups.contact | string |
kontakt |
|
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 |
|
název_klienta
|
clientGroups.clients.clientname | string |
název_klienta |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
dlužníkClientId
|
clientGroups.clients.debtorClientId | integer |
dlužníkClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
vytvořeno
|
clientGroups.created | string |
vytvořeno |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
celkový počet záznamů
|
pagination.total_records | integer |
celkový počet záznamů |
|
current_page
|
pagination.current_page | integer |
current_page |
|
page_Size
|
pagination.page_Size | integer |
page_Size |
|
celkem stránek
|
pagination.total_pages | integer |
celkem stránek |
|
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 |
Získání vlastních polí podle kontextu
Vrátí vlastní pole pro zadaný kontext.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Kontext:
|
context | True | string |
Kontext vlastních polí |
Úloha aktualizace
Aktualizuje úlohu pracovního postupu podle ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID úlohy
|
jobId | True | integer |
Identifikátor úlohy pracovního postupu |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
dlužníkclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
název úlohy
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
splatné datum
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Priorita
|
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 |
Čas protokolu
Vytvoří položku časového rozvrhu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
ID úkolu
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
jednotky
|
units | double | ||
|
čas zahájení
|
starttime | string | ||
|
sazba
|
rate | double | ||
|
description
|
description | string |
Definice
Adresa
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
jednotka
|
unit | string | |
|
careOf
|
careOf | string | |
|
addressLine1
|
addressLine1 | string | |
|
adresaŘádek2
|
addressLine2 | string | |
|
předměstí
|
suburb | string | |
|
stav
|
state | string | |
|
Země
|
country | string | |
|
PSČ
|
postCode | string |
Client
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
kód
|
code | string | |
|
oslovení
|
salutation | string | |
|
název
|
name | string | |
|
firstName
|
firstName | string | |
|
prostřední jméno
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
oddělení
|
division | Division | |
|
entityType
|
entityType | string | |
|
partner
|
partner | Staff | |
|
manažer
|
manager | Staff | |
|
Kontakty
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string | |
|
Nv
|
wip | string | |
|
poloha
|
location | string | |
|
stav
|
status | string | |
|
seskupit
|
group | Group | |
|
dlužníkClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
dlužníkid
|
debtorid | integer | |
|
dlužníkname
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
kód
|
code | string | |
|
oslovení
|
salutation | string | |
|
název
|
name | string | |
|
firstName
|
firstName | string | |
|
prostřední jméno
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
oddělení
|
division | Division | |
|
entityType
|
entityType | string | |
|
partner
|
partner | Staff | |
|
manažer
|
manager | Staff | |
|
Kontakty
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string | |
|
wip
|
wip | string | |
|
poloha
|
location | string | |
|
stav
|
status | string | |
|
seskupit
|
group | Group | |
|
dlužníkClient
|
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
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
klient
|
client | array of ClientDetails |
ClientSummary
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
kód
|
code | string | |
|
název
|
name | string |
Client_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
stránkování
|
pagination | Pagination |
Kontakt
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
Contacttype
|
contactType | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone |
ContactEntity
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
oslovení
|
salutation | string | |
|
firstName
|
firstName | string | |
|
prostřední jméno
|
middleName | string | |
|
lastName
|
lastName | string | |
|
pohlaví
|
gender | string | |
|
phone
|
phone | array of Phone | |
|
e-mail
|
array of Email | ||
|
companyName
|
companyName | string | |
|
placeOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
Din
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
název
|
name | string | |
|
poloha
|
location | string | |
|
kontext
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kontakty
|
contacts | array of ContactEntity | |
|
stránkování
|
pagination | Pagination |
CustomField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DlužníkClient
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
kód
|
code | string | |
|
název
|
name | string |
Oddělení
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
název
|
name | string |
DivisionWithDetails
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
název
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
naposledyUpravenoDne
|
lastModifiedAt | string |
Divizeext
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
název
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
naposledyUpravenoDne
|
lastModifiedAt | string | |
|
Naposledy změnil/a
|
lastModifiedBy | string | |
|
vytvořeno
|
created | string |
Divisions_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
divize
|
divisions | array of Divisionext | |
|
stránkování
|
pagination | Pagination |
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
typ
|
type | string | |
|
e-mail
|
string | ||
|
oblíbený
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Skupina
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
kód
|
code | string | |
|
název
|
name | string |
Členové skupiny
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
id člena
|
memberId | string | |
|
název
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
stránkování
|
pagination | Pagination |
InvoiceDetails
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Číslo
|
number | string | |
|
RefNo
|
refNo | string | |
|
typ
|
type | string | |
|
date
|
date | string | |
|
náležitý
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
platba
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
zůstatek
|
balance | double | |
|
stav
|
status | string | |
|
dlužníkClientId
|
debtorClientId | integer | |
|
dlužníkClientCode
|
debtorClientCode | string | |
|
dlužníkClientName
|
debtorClientName | string | |
|
dlužníkBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string |
InvoiceLines
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
číslo řádku
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
název
|
name | string | |
|
Nv
|
wip | double | |
|
klient
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
manažer
|
manager | Staff | |
|
oddělení
|
division | DivisionWithDetails | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string | |
|
dlužníkClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
Šablona úlohy
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Obrat
|
turnaround | integer | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string |
Typ práce
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string |
JobTypeStatus
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
ID_kategorie
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Popis úlohy
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
název
|
name | string | |
|
Priorita
|
priority | string | |
|
splatné datum
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Nv
|
wip | double | |
|
klient
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
manažer
|
manager | Staff | |
|
oddělení
|
division | DivisionWithDetails | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string | |
|
dlužníkClient
|
debtorClient | DebtorClient | |
|
stav
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
přiřazování
|
assignees | array of UserDetail | |
|
tým
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
stránkování
|
pagination | Pagination |
Pagination
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
celkový počet záznamů
|
total_records | integer | |
|
current_page
|
current_page | integer | |
|
page_Size
|
page_Size | integer | |
|
celkem stránek
|
total_pages | integer | |
|
next_page
|
next_page | integer | |
|
next_pageurl
|
next_pageurl | string | |
|
prev_page
|
prev_page | integer | |
|
prev_pageurl
|
prev_pageurl | string |
telefon
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
typ
|
type | string | |
|
Číslo
|
number | string | |
|
oblíbený
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
typ
|
type | string | |
|
entityId
|
entityId | string | |
|
název
|
name | string | |
|
entita
|
entity | string | |
|
startDate
|
startDate | string | |
|
datum ukončení
|
endDate | string | |
|
jednotky
|
units | integer |
Relationships_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
stránkování
|
pagination | Pagination |
Personál
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
název
|
name | string | |
|
e-mail
|
string |
TaskDetail
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
název
|
name | string |
Teams
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
název
|
name | string | |
|
Členové skupiny
|
groupMembers | array of GroupMember |
UserDetail
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
název
|
name | string |
UsersWithDetails
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
název
|
name | string | |
|
roleName
|
roleName | string | |
|
e-mail
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
adresa
|
address | Address | |
|
vytvořeno
|
created | string | |
|
poslední změna
|
lastModified | string |
Users_Result
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
stránkování
|
pagination | Pagination |