KC (Vorschau)
KC Practice Management ermöglicht sicheren Zugriff auf Client- und Geschäftsdaten, sodass Benutzer Informationen effizient über automatisierte Workflows abrufen und verwalten können.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Kloud Connect-Support |
| URL | https://www.kloudconnect.com.au/ |
| E‑Mail | support@kloudconnect.com.au |
| Connectormetadaten | |
|---|---|
| Herausgeber | Kloud Connect |
| Website | https://www.kloudconnect.com.au/ |
| Datenschutzrichtlinie | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Kategorien | Unternehmensführung; Finanzieren |
Kloud Connect Practice Management
Übersicht
Dadurch erhalten Sie Zugriff auf Kloud Connect Practice Management-APIs.
Features
- Clients auflisten
- Erstellen von Clients
- Kontakte auflisten
- Kontakte erstellen
- Rechnungen auflisten
- Arbeitszeittabelle erstellen
- Aufgaben auflisten
- Aufgaben erstellen
- Auflisten von Aufträgen
- Erstellen von Aufträgen
- Zugriffsübungsverwaltungsdaten
Authentication
OAuth 2.0 über Kloud Connect Identity Server
Support
support@kloudconnect.com.au
Aktionen
| Abrufen der Schuldner-Kundenzuordnung |
Gibt die Schuldner-Kundenzuordnung für einen Kunden zurück. |
| Abrufen von benutzerdefinierten Feldern nach Kontext |
Gibt benutzerdefinierte Felder für den angegebenen Kontext zurück. |
| Abrufen von Clientgruppen |
Abrufen von Clientgruppen |
| Aktualisieren der Clientgruppe |
Aktualisiert eine Clientgruppe nach Gruppencode. |
| Aktualisieren des Auftragsstatus und der Priorität |
Aktualisiert den Status und die Priorität für Workflowaufträge. |
| Auflisten nicht abrechnenbarer Zeittypen |
Gibt die verfügbaren, nicht in Rechnung stehenden Arbeitszeittabellentypen zurück. |
| Auflisten von Abteilungen |
Gibt eine ausgelagerte Liste von Abteilungen zurück. |
| Auflisten von Teams |
Gibt die verfügbaren Teams zurück. |
| Auftrag aktualisieren |
Aktualisiert einen Workflowauftrag nach ID. |
| Auftragstypen auflisten |
Gibt die verfügbaren Workflowauftragstypen zurück. |
| Aufträge auflisten |
Gibt eine ausgelagerte Liste von Workflowaufträgen zurück. |
| Benutzer auflisten |
Gibt eine ausgelagerte Liste von Benutzern zurück. |
| Client nach ID abrufen |
Gibt Details für einen Client nach ID zurück. |
| Client nach ID aktualisieren |
Aktualisiert einen Client nach ID. |
| Clientbeziehungen auflisten |
Gibt eine ausgelagerte Liste der Clientbeziehungen zurück. |
| Clients auflisten |
Gibt eine ausgelagerte Liste von Clients zurück. |
| Clienttags auflisten |
Gibt die verfügbaren Clienttags zurück. |
| Erstellen des Clients |
Erstellt einen Client. |
| Erstellen einer Clientgruppe |
Erstellt eine Clientgruppe. |
| Erstellen eines Auftrags |
Erstellt einen Workflowauftrag. |
| Kontakt aktualisieren |
Aktualisiert einen Kontakt anhand der ID. |
| Kontakte auflisten |
Gibt eine ausgelagerte Liste von Kontakten zurück. |
| Listenauftragsvorlagen |
Gibt die verfügbaren Workflowauftragsvorlagen zurück. |
| Protokollzeit |
Erstellt einen Arbeitszeittabellen-Zeiteintrag. |
| Rechnungen auflisten |
Gibt eine ausgelagerte Liste von Rechnungen zurück. |
| Status des Auftragstyps auflisten |
Gibt die status des verfügbaren Workflowauftrags zurück. |
| Stellenprioritäten auflisten |
Gibt die verfügbaren Workflowauftragsprioritäten zurück. |
Abrufen der Schuldner-Kundenzuordnung
Gibt die Schuldner-Kundenzuordnung für einen Kunden zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client identifier. (Clientbezeichner.) |
Gibt zurück
- Körper
- ClientDebtor
Abrufen von benutzerdefinierten Feldern nach Kontext
Gibt benutzerdefinierte Felder für den angegebenen Kontext zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kontext
|
context | True | string |
Kontext benutzerdefinierter Felder. |
Abrufen von Clientgruppen
Abrufen von Clientgruppen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Clientgruppen, die pro Seite zurückgegeben werden sollen. |
|
|
Gruppencode
|
groupCode | string |
Filtern von Clientgruppen nach Gruppencode. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
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 |
|
Clientname
|
clientGroups.clients.clientname | string |
Clientname |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
schuldnerClientId
|
clientGroups.clients.debtorClientId | integer |
schuldnerClientId |
|
createdBY
|
clientGroups.createdBY | string |
Createdby |
|
erstellt
|
clientGroups.created | string |
erstellt |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
Gesamtanzahl_der_Einträge
|
pagination.total_records | integer |
Gesamtanzahl_der_Einträge |
|
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 |
Aktualisieren der Clientgruppe
Aktualisiert eine Clientgruppe nach Gruppencode.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppencode
|
groupCode | True | string |
Clientgruppencode. |
|
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 |
Aktualisieren des Auftragsstatus und der Priorität
Aktualisiert den Status und die Priorität für Workflowaufträge.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
status
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Auflisten nicht abrechnenbarer Zeittypen
Gibt die verfügbaren, nicht in Rechnung stehenden Arbeitszeittabellentypen zurück.
Auflisten von Abteilungen
Gibt eine ausgelagerte Liste von Abteilungen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Divisionen, die pro Seite zurückgegeben werden sollen. |
|
|
Geändert seit
|
modifiedSince | string |
Gibt Divisionen zurück, die am oder nach diesem Zeitstempel geändert wurden. |
Gibt zurück
- Körper
- Divisions_Result
Auflisten von Teams
Auftrag aktualisieren
Aktualisiert einen Workflowauftrag nach ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
jobId | True | integer |
Workflowauftragsbezeichner. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
schuldnerclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
Auftragsname
|
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 | ||
|
priority
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
Auftragstypen auflisten
Aufträge auflisten
Gibt eine ausgelagerte Liste von Workflowaufträgen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Aufträge, die pro Seite zurückgegeben werden sollen. |
|
|
Partner-ID
|
partnerId | string |
Filtert Aufträge nach Partnerbezeichner. |
|
|
Client-Name
|
clientName | string |
Filtern von Aufträgen nach Clientname. |
|
|
Clientcode
|
clientcode | string |
Filtert Aufträge nach Clientcode. |
|
|
Geändert seit
|
modifiedSince | string |
Gibt Aufträge zurück, die an oder nach diesem Zeitstempel geändert wurden. |
|
|
Debit-Client
|
isDebitClient | boolean |
Filtert Aufträge nach Debit-Client-Flag. |
|
|
Benutzerdefinierte Felder
|
isCustomField | boolean |
Fügen Sie benutzerdefinierte Felder in die Auftragsergebnisse ein. |
Gibt zurück
- Körper
- Jobs_Result
Benutzer auflisten
Gibt eine ausgelagerte Liste von Benutzern zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Benutzer, die pro Seite zurückgegeben werden sollen. |
|
|
Geändert seit
|
modifiedSince | string |
Geben Sie Benutzer zurück, die am oder nach diesem Zeitstempel geändert wurden. |
|
|
Rollenname
|
rolename | string |
Filtern sie Benutzer nach Rollennamen. |
Gibt zurück
- Körper
- Users_Result
Client nach ID abrufen
Gibt Details für einen Client nach ID zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client identifier. (Clientbezeichner.) |
|
Benutzerdefinierte Felder
|
isCustomField | boolean |
Benutzerdefinierte Felder einschließen. |
Gibt zurück
- Körper
- ClientDetails_Result
Client nach ID aktualisieren
Aktualisiert einen Client nach ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client identifier. (Clientbezeichner.) |
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
Anrede
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
MiddleName
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
Vertrauensart
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
Handelsname
|
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 | |
|
Aussicht
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Geschlecht
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
Favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
Zahl
|
number | string | ||
|
Favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
Website
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
Einheit
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
AdresseZeile1
|
addressLine1 | string | ||
|
AdresseZeile2
|
addressLine2 | string | ||
|
Vorort
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Postleitzahl
|
postCode | string | ||
|
Industrie
|
industry | string | ||
|
Rolle
|
role | string | ||
|
Gehalt
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Dose
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Wohnsitz
|
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 |
Clientbeziehungen auflisten
Gibt eine ausgelagerte Liste der Clientbeziehungen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client identifier. (Clientbezeichner.) |
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Beziehungen, die pro Seite zurückgegeben werden sollen. |
Gibt zurück
- Körper
- Relationships_Result
Clients auflisten
Gibt eine ausgelagerte Liste von Clients zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl (1-basiert). |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Elemente pro Seite. |
|
|
Partner-ID
|
partnerId | string |
Filtern nach Partnerbezeichner. |
|
|
Debit-Client
|
isDebitClient | boolean |
Filtern nach Debit-Client-Flag. |
|
|
Geändert seit
|
modifiedSince | string |
Gibt Clients zurück, die am/nach diesem Zeitstempel geändert wurden (ISO 8601). |
|
|
Gruppencode
|
groupCode | string |
Filtern nach Gruppencode. |
|
|
Client-ID
|
clientId | integer |
Filtern nach Client-ID. |
|
|
Benutzerdefinierte Felder
|
isCustomField | boolean |
Benutzerdefinierte Felder einschließen. |
Gibt zurück
- Körper
- Client_Result
Clienttags auflisten
Gibt die verfügbaren Clienttags zurück.
Erstellen des Clients
Erstellt einen Client.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
Anrede
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
MiddleName
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
Vertrauensart
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
Handelsname
|
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 | |
|
Aussicht
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
Geschlecht
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
Favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
Zahl
|
number | string | ||
|
Favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
Website
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
Einheit
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
AdresseZeile1
|
addressLine1 | string | ||
|
AdresseZeile2
|
addressLine2 | string | ||
|
Vorort
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Postleitzahl
|
postCode | string | ||
|
Industrie
|
industry | string | ||
|
Rolle
|
role | string | ||
|
Gehalt
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Dose
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Wohnsitz
|
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 |
Erstellen einer Clientgruppe
Erstellt eine Clientgruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
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 |
Erstellen eines Auftrags
Erstellt einen Workflowauftrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
schuldnerclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
Auftragsname
|
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 | ||
|
priority
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
Kontakt aktualisieren
Aktualisiert einen Kontakt anhand der ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kontakt-ID
|
contactId | True | integer |
Kontakt-ID. |
|
Anrede
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
MiddleName
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
Geschlecht
|
gender | string | ||
|
type
|
type | string | ||
|
Zahl
|
number | string | ||
|
Favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
Favorit
|
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 | ||
|
Einheit
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
AdresseZeile1
|
addressLine1 | string | ||
|
AdresseZeile2
|
addressLine2 | string | ||
|
Vorort
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Postleitzahl
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Kontakte auflisten
Gibt eine ausgelagerte Liste von Kontakten zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Kontakte, die pro Seite zurückgegeben werden sollen. |
|
|
Geändert seit
|
modifiedSince | string |
Gibt Kontakte zurück, die am oder nach diesem Zeitstempel geändert wurden. |
|
|
Kontakt-ID
|
contactId | integer |
Filtern von Kontakten nach Kontaktbezeichner. |
|
|
Client-ID-Filter
|
isClientId | boolean |
Gibt an, ob der Kontakt-ID-Filter als Client-ID behandelt werden soll. |
|
|
Benutzerdefinierte Felder
|
isCustomField | boolean |
Fügen Sie benutzerdefinierte Felder in die Kontaktergebnisse ein. |
Gibt zurück
- Körper
- Contact_Result
Listenauftragsvorlagen
Protokollzeit
Erstellt einen Arbeitszeittabellen-Zeiteintrag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ist abgerechnet
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
Taskid
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Einheiten
|
units | double | ||
|
Startzeit
|
starttime | string | ||
|
rate
|
rate | double | ||
|
description
|
description | string |
Rechnungen auflisten
Gibt eine ausgelagerte Liste von Rechnungen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Ergebnisseitenzahl. |
|
|
Seitengröße
|
pageSize | integer |
Anzahl der Rechnungen, die pro Seite zurückgegeben werden sollen. |
|
|
Rechnungsentwurf
|
isDraftInvoice | boolean |
Filtern Sie Rechnungen nach Rechnungsentwurfskennzeichnung. |
|
|
Rechnungsdetails einschließen
|
includeInvoiceDetails | boolean |
Fügen Sie die Rechnungsdetailseite in die Antwort ein. |
|
|
Status
|
status | string |
Filtern sie Rechnungen nach Status. |
|
|
Geändert seit
|
modifiedSince | string |
Rechnungen zurückzugeben, die am oder nach diesem Zeitstempel geändert wurden. |
|
|
Debit-Client
|
isDebitClient | boolean |
Filtern Sie Rechnungen nach Debit-Clientkennzeichnung. |
|
|
Client-Name
|
clientname | string |
Filtern sie Rechnungen nach Dem Kundennamen. |
|
|
Clientcode
|
clientcode | string |
Filtern Sie Rechnungen nach Kundencode. |
|
|
Auftragsname
|
jobname | string |
Filtern Sie Rechnungen nach Auftragsname. |
|
|
Auftragscode
|
jobcode | string |
Filtern Sie Rechnungen nach Auftragscode. |
|
|
Abrechnungsentitäts-ID
|
billingEntityId | string |
Filtern von Rechnungen nach Rechnungsentitäts-ID. |
Gibt zurück
- Körper
- InvoiceDetail_Result
Status des Auftragstyps auflisten
Stellenprioritäten auflisten
Definitionen
Adresse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
Einheit
|
unit | string | |
|
careOf
|
careOf | string | |
|
AdresseZeile1
|
addressLine1 | string | |
|
AdresseZeile2
|
addressLine2 | string | |
|
Vorort
|
suburb | string | |
|
state
|
state | string | |
|
country
|
country | string | |
|
Postleitzahl
|
postCode | string |
Client
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Programmcode
|
code | string | |
|
Anrede
|
salutation | string | |
|
Name
|
name | string | |
|
firstName
|
firstName | string | |
|
MiddleName
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
division
|
division | Division | |
|
entityType
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
Leiter
|
manager | Staff | |
|
contacts
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Dose
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
schuldnerClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
Billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
schuldnerid
|
debtorid | integer | |
|
Schuldnername
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Programmcode
|
code | string | |
|
Anrede
|
salutation | string | |
|
Name
|
name | string | |
|
firstName
|
firstName | string | |
|
MiddleName
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
division
|
division | Division | |
|
entityType
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
Leiter
|
manager | Staff | |
|
contacts
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Dose
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
schuldnerClient
|
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 | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
client
|
client | array of ClientDetails |
ClientSummary
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Programmcode
|
code | string | |
|
Name
|
name | string |
Client_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
Paginierung
|
pagination | Pagination |
Kontakt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
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
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anrede
|
salutation | string | |
|
firstName
|
firstName | string | |
|
MiddleName
|
middleName | string | |
|
lastName
|
lastName | string | |
|
Geschlecht
|
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 | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
Name
|
name | string | |
|
location
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
contacts
|
contacts | array of ContactEntity | |
|
Paginierung
|
pagination | Pagination |
CustomField
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
SchuldnerClient
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Programmcode
|
code | string | |
|
Name
|
name | string |
Abteilung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Name
|
name | string |
DivisionWithDetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Name
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string |
Divisionext
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Name
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string | |
|
lastModifiedBy
|
lastModifiedBy | string | |
|
erstellt
|
created | string |
Divisions_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Geschäftsbereiche
|
divisions | array of Divisionext | |
|
Paginierung
|
pagination | Pagination |
E‑Mail
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string | |
|
email
|
string | ||
|
Favorit
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Group
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Programmcode
|
code | string | |
|
Name
|
name | string |
Gruppenmitglied
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
Name
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
Paginierung
|
pagination | Pagination |
InvoiceDetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Zahl
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
es ist an der Zeit
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
Zahlung
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
Gleichgewicht
|
balance | double | |
|
status
|
status | string | |
|
schuldnerClientId
|
debtorClientId | integer | |
|
schuldnerClientCode
|
debtorClientCode | string | |
|
schuldnerClientName
|
debtorClientName | string | |
|
schuldnerBrefcode
|
debtorBrefcode | string | |
|
Billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string |
InvoiceLines
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Zeilennummer
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Jobcode
|
jobcode | string | |
|
Name
|
name | string | |
|
Wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
FinancialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
Leiter
|
manager | Staff | |
|
division
|
division | DivisionWithDetails | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string | |
|
schuldnerClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
JobTemplate
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Turnaround
|
turnaround | integer | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string |
Jobtyp
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string |
JobTypeStatus
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
CategoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Auftragsdetail
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
Name
|
name | string | |
|
priority
|
priority | string | |
|
dueDate
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
FinancialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
Leiter
|
manager | Staff | |
|
division
|
division | DivisionWithDetails | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string | |
|
schuldnerClient
|
debtorClient | DebtorClient | |
|
status
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
Erfüllungsgehilfen
|
assignees | array of UserDetail | |
|
team
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
Paginierung
|
pagination | Pagination |
Paginierung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtanzahl_der_Einträge
|
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 |
Phone
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string | |
|
Zahl
|
number | string | |
|
Favorit
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Beziehung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
entityId
|
entityId | string | |
|
Name
|
name | string | |
|
entity
|
entity | string | |
|
startDate
|
startDate | string | |
|
Enddatum
|
endDate | string | |
|
Einheiten
|
units | integer |
Relationships_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
Paginierung
|
pagination | Pagination |
Personal
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Name
|
name | string | |
|
email
|
string |
TaskDetail
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Name
|
name | string |
Teams
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
Name
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Name
|
name | string |
UsersWithDetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Name
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
address
|
address | Address | |
|
erstellt
|
created | string | |
|
zuletzt geändert
|
lastModified | string |
Users_Result
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
Paginierung
|
pagination | Pagination |