KC (förhandsversion)
KC Practice Management ger säker åtkomst till klient- och affärsdata så att användarna kan hämta och hantera information effektivt via automatiserade arbetsflöden.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: – Azure Government-regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Kloud Connect-support |
| URL | https://www.kloudconnect.com.au/ |
| E-postmeddelande | support@kloudconnect.com.au |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Kloud Connect |
| Webbplats | https://www.kloudconnect.com.au/ |
| Sekretesspolicy | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Kategorier | Företagsledning; Finans |
Kloud Connect Practice Management
Översikt
Detta ger åtkomst till API:er för Kloud Connect Practice Management.
Features
- Lista klienter
- Skapa klienter
- Lista kontakter
- Skapa kontakter
- Lista fakturor
- Skapa tidrapport
- Visa en lista över aktiviteter
- Skapa uppgifter
- Lista jobb
- Skapa jobb
- Hanteringsdata för åtkomstpraxis
Authentication
OAuth 2.0 via Kloud Connect Identity Server
Support
support@kloudconnect.com.au
Åtgärder
| Hämta anpassade fält efter kontext |
Returnerar anpassade fält för den angivna kontexten. |
| Hämta klient efter ID |
Returnerar information för en klient efter ID. |
| hämta klientgrupper |
hämta klientgrupper |
| Hämta klientmappning för gäldenär |
Returnerar gäldenärsklientmappning för en klient. |
| Lista användare |
Returnerar en växlingslista över användare. |
| Lista arbeten |
Returnerar en växlingslista över arbetsflödesjobb. |
| Lista fakturor |
Returnerar en växlingslista med fakturor. |
| Lista jobbmallar |
Returnerar de tillgängliga arbetsflödesjobbmallarna. |
| Lista jobbprioriteringar |
Returnerar de tillgängliga arbetsflödesjobbprioriteringarna. |
| Lista jobbtyper |
Returnerar de tillgängliga arbetsflödesjobbtyperna. |
| Lista klienter |
Returnerar en växlingslista över klienter. |
| Lista klienttaggar |
Returnerar de tillgängliga klienttaggar. |
| Lista team |
Returnerar de tillgängliga teamen. |
| Listdivisioner |
Returnerar en sidlista med divisioner. |
| Loggtid |
Skapar en tidrapportpost. |
| Skapa en klient |
Skapar en klient. |
| Skapa jobb |
Skapar ett arbetsflödesjobb. |
| Skapa klientgrupp |
Skapar en klientgrupp. |
| Status för listjobbstyp |
Returnerar statusen för den tillgängliga arbetsflödesjobbtypen. |
| Uppdatera jobb |
Uppdaterar ett arbetsflödesjobb efter ID. |
| Uppdatera jobbstatus och prioritet |
Uppdaterar status och prioritet för arbetsflödesjobb. |
| Uppdatera klienten efter ID |
Uppdaterar en klient efter ID. |
| Uppdatera klientgrupp |
Uppdaterar en klientgrupp efter gruppkod. |
| Uppdatera kontakt |
Uppdaterar en kontakt efter ID. |
| Visa en lista över klientrelationer |
Returnerar en växlingslista över klientrelationer. |
| Visa en lista över kontakter |
Returnerar en växlingslista med kontakter. |
| Visa en lista över tidstyper som inte kan faktureras |
Returnerar tillgängliga tidrapporttyper som inte kan faktureras. |
Hämta anpassade fält efter kontext
Returnerar anpassade fält för den angivna kontexten.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sammanhang
|
context | True | string |
Kontext för anpassade fält. |
Hämta klient efter ID
Returnerar information för en klient efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kund-ID
|
clientId | True | integer |
Klientidentifierare. |
|
Anpassade fält
|
isCustomField | boolean |
Inkludera anpassade fält. |
Returer
- Kroppen
- ClientDetails_Result
hämta klientgrupper
hämta klientgrupper
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal klientgrupper som ska returneras per sida. |
|
|
Gruppkod
|
groupCode | string |
Filtrera klientgrupper efter gruppkod. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
kontakta
|
clientGroups.contact | string |
kontakta |
|
tags
|
clientGroups.tags | array of |
tags |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
enhetstyp
|
clientGroups.clients.entityType | string |
enhetstyp |
|
clientname
|
clientGroups.clients.clientname | string |
clientname |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debtorClientId
|
clientGroups.clients.debtorClientId | integer |
debtorClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
skapad
|
clientGroups.created | string |
skapad |
|
lastmodifierad
|
clientGroups.lastmodified | string |
lastmodifierad |
|
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 |
Hämta klientmappning för gäldenär
Returnerar gäldenärsklientmappning för en klient.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kund-ID
|
clientId | True | integer |
Klientidentifierare. |
Returer
- Kroppen
- ClientDebtor
Lista användare
Returnerar en växlingslista över användare.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal användare som ska returneras per sida. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera användare som ändrats på eller efter den här tidsstämpeln. |
|
|
Rollnamn
|
rolename | string |
Filtrera användare efter rollnamn. |
Returer
- Kroppen
- Users_Result
Lista arbeten
Returnerar en växlingslista över arbetsflödesjobb.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal jobb som ska returneras per sida. |
|
|
Partner-ID
|
partnerId | string |
Filtrera jobb efter partneridentifierare. |
|
|
Klientnamn
|
clientName | string |
Filtrera jobb efter klientnamn. |
|
|
Klientkod
|
clientcode | string |
Filtrera jobb efter klientkod. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera jobb som ändrats på eller efter den här tidsstämpeln. |
|
|
Debetklient
|
isDebitClient | boolean |
Filtrera jobb efter debetklientflagga. |
|
|
Anpassade fält
|
isCustomField | boolean |
Inkludera anpassade fält i jobbresultatet. |
Returer
- Kroppen
- Jobs_Result
Lista fakturor
Returnerar en växlingslista med fakturor.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal fakturor som ska returneras per sida. |
|
|
Utkastfaktura
|
isDraftInvoice | boolean |
Filtrera fakturor efter utkastfakturaflagga. |
|
|
Inkludera fakturainformation
|
includeInvoiceDetails | boolean |
Inkludera fakturainformationsposter i svaret. |
|
|
Status
|
status | string |
Filtrera fakturor efter status. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera fakturor som ändrats på eller efter den här tidsstämpeln. |
|
|
Debetklient
|
isDebitClient | boolean |
Filtrera fakturor efter debetklientflagga. |
|
|
Klientnamn
|
clientname | string |
Filtrera fakturor efter klientnamn. |
|
|
Klientkod
|
clientcode | string |
Filtrera fakturor efter klientkod. |
|
|
Jobbnamn
|
jobname | string |
Filtrera fakturor efter jobbnamn. |
|
|
Jobbkod
|
jobcode | string |
Filtrera fakturor efter jobbkod. |
|
|
Faktureringsentitets-ID
|
billingEntityId | string |
Filtrera fakturor efter faktureringsentitetsidentifierare. |
Returer
- Kroppen
- InvoiceDetail_Result
Lista jobbmallar
Lista jobbprioriteringar
Lista jobbtyper
Lista klienter
Returnerar en växlingslista över klienter.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultatsidans nummer (1-baserat). |
|
|
Sidstorlek
|
pageSize | integer |
Antal objekt per sida. |
|
|
Partner-ID
|
partnerId | string |
Filtrera efter partneridentifierare. |
|
|
Debetklient
|
isDebitClient | boolean |
Filtrera efter flagga för debetklient. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera klienter som ändrats på/efter den här tidsstämpeln (ISO 8601). |
|
|
Gruppkod
|
groupCode | string |
Filtrera efter gruppkod. |
|
|
Kund-ID
|
clientId | integer |
Filtrera efter klient-ID. |
|
|
Anpassade fält
|
isCustomField | boolean |
Inkludera anpassade fält. |
Returer
- Kroppen
- Client_Result
Lista klienttaggar
Returnerar de tillgängliga klienttaggar.
Lista team
Listdivisioner
Returnerar en sidlista med divisioner.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal divisioner som ska returneras per sida. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera divisioner som ändrats på eller efter den här tidsstämpeln. |
Returer
- Kroppen
- Divisions_Result
Loggtid
Skapar en tidrapportpost.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
kan faktureras
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Enheter
|
units | double | ||
|
starttid
|
starttime | string | ||
|
kurs
|
rate | double | ||
|
description
|
description | string |
Skapa en klient
Skapar en klient.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
enhetstyp
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
hälsningsfras
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
mellannamn
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
förtroendetyp
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName (handel)
|
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 | |
|
Utsikter
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
kön
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
webbplats
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
enhet
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
förstad
|
suburb | string | ||
|
state
|
state | string | ||
|
Land
|
country | string | ||
|
Postnummer
|
postCode | string | ||
|
industri
|
industry | string | ||
|
role
|
role | string | ||
|
lön
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Kan
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Bosatt
|
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 |
Skapa jobb
Skapar ett arbetsflödesjobb.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debtorclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
jobbnamn
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate (på engelska)
|
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 |
Skapa klientgrupp
Skapar en klientgrupp.
Parametrar
| Name | Nyckel | Obligatorisk | 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 |
Status för listjobbstyp
Uppdatera jobb
Uppdaterar ett arbetsflödesjobb efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Jobb-ID
|
jobId | True | integer |
Jobbidentifierare för arbetsflöde. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debtorclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
jobbnamn
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate (på engelska)
|
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 |
Uppdatera jobbstatus och prioritet
Uppdaterar status och prioritet för arbetsflödesjobb.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
status
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Uppdatera klienten efter ID
Uppdaterar en klient efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kund-ID
|
clientId | True | integer |
Klientidentifierare. |
|
enhetstyp
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
hälsningsfras
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
mellannamn
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
förtroendetyp
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName (handel)
|
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 | |
|
Utsikter
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
kön
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
favorit
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
webbplats
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
enhet
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
förstad
|
suburb | string | ||
|
state
|
state | string | ||
|
Land
|
country | string | ||
|
Postnummer
|
postCode | string | ||
|
industri
|
industry | string | ||
|
role
|
role | string | ||
|
lön
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Kan
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Bosatt
|
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 |
Uppdatera klientgrupp
Uppdaterar en klientgrupp efter gruppkod.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Gruppkod
|
groupCode | True | string |
Kod för klientgrupp. |
|
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 |
Uppdatera kontakt
Uppdaterar en kontakt efter ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kontakt-ID
|
contactId | True | integer |
Kontaktidentifierare. |
|
hälsningsfras
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
mellannamn
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
kön
|
gender | string | ||
|
type
|
type | string | ||
|
number
|
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 | ||
|
enhet
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
förstad
|
suburb | string | ||
|
state
|
state | string | ||
|
Land
|
country | string | ||
|
Postnummer
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Visa en lista över klientrelationer
Returnerar en växlingslista över klientrelationer.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kund-ID
|
clientId | True | integer |
Klientidentifierare. |
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal relationer som ska returneras per sida. |
Returer
- Kroppen
- Relationships_Result
Visa en lista över kontakter
Returnerar en växlingslista med kontakter.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Resultat sidnummer. |
|
|
Sidstorlek
|
pageSize | integer |
Antal kontakter som ska returneras per sida. |
|
|
Ändrat sedan
|
modifiedSince | string |
Returnera kontakter som ändrats på eller efter den här tidsstämpeln. |
|
|
Kontakt-ID
|
contactId | integer |
Filtrera kontakter efter kontaktidentifierare. |
|
|
Klient-ID-filter
|
isClientId | boolean |
Anger om kontakt-ID-filtret ska behandlas som ett klient-ID. |
|
|
Anpassade fält
|
isCustomField | boolean |
Inkludera anpassade fält i kontaktresultatet. |
Returer
- Kroppen
- Contact_Result
Visa en lista över tidstyper som inte kan faktureras
Returnerar tillgängliga tidrapporttyper som inte kan faktureras.
Definitioner
Adress
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
enhet
|
unit | string | |
|
careOf
|
careOf | string | |
|
addressLine1
|
addressLine1 | string | |
|
addressLine2
|
addressLine2 | string | |
|
förstad
|
suburb | string | |
|
state
|
state | string | |
|
Land
|
country | string | |
|
Postnummer
|
postCode | string |
Client
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
code
|
code | string | |
|
hälsningsfras
|
salutation | string | |
|
Namn
|
name | string | |
|
firstName
|
firstName | string | |
|
mellannamn
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
avdelning
|
division | Division | |
|
enhetstyp
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
föreståndare
|
manager | Staff | |
|
Kontakter
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Kan
|
acn | string | |
|
Abn
|
abn | string | |
|
tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string | |
|
Pia
|
wip | string | |
|
location
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
debtorid
|
debtorid | integer | |
|
debtorname
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
klientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
code
|
code | string | |
|
hälsningsfras
|
salutation | string | |
|
Namn
|
name | string | |
|
firstName
|
firstName | string | |
|
mellannamn
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
avdelning
|
division | Division | |
|
enhetstyp
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
föreståndare
|
manager | Staff | |
|
Kontakter
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Kan
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string | |
|
wip
|
wip | string | |
|
location
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField | |
|
din
|
din | string | |
|
tfn
|
tfn | string | |
|
bankName
|
bankName | string | |
|
bankAccountName
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
bankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
client
|
client | array of ClientDetails |
ClientSummary
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
Namn
|
name | string |
Client_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
sidnumrering
|
pagination | Pagination |
Kontakt
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
contactType
|
contactType | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone |
ContactEntity
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
hälsningsfras
|
salutation | string | |
|
firstName
|
firstName | string | |
|
mellannamn
|
middleName | string | |
|
lastName
|
lastName | string | |
|
kön
|
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 | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
Namn
|
name | string | |
|
location
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kontakter
|
contacts | array of ContactEntity | |
|
sidnumrering
|
pagination | Pagination |
CustomField
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DebtorClient
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
Namn
|
name | string |
Division
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Namn
|
name | string |
DivisionWithDetails
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Namn
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
senastÄndradVid
|
lastModifiedAt | string |
Divisionext
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Namn
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
senastÄndradVid
|
lastModifiedAt | string | |
|
Senast ändrad av
|
lastModifiedBy | string | |
|
skapad
|
created | string |
Divisions_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
uppdelningar
|
divisions | array of Divisionext | |
|
sidnumrering
|
pagination | Pagination |
E-postmeddelande
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
type
|
type | string | |
|
email
|
string | ||
|
favorit
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Grupp
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
Namn
|
name | string |
Gruppmedlem
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
Namn
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
sidnumrering
|
pagination | Pagination |
Fakturainformation
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
number
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
vederbörlig
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
betalning
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
balans
|
balance | double | |
|
status
|
status | string | |
|
debtorClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
debtorClientName
|
debtorClientName | string | |
|
debtorBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string |
Fakturalinjer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
lineNumber
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
lineTotal
|
lineTotal | double |
JobInvoice
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
Namn
|
name | string | |
|
Pia
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
föreståndare
|
manager | Staff | |
|
avdelning
|
division | DivisionWithDetails | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string | |
|
debtorClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
JobTemplate (på engelska)
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Vändningen
|
turnaround | integer | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string |
Jobbtyp
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string |
JobTypeStatus
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
Kategori-ID
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
Namn
|
name | string | |
|
priority
|
priority | string | |
|
dueDate (på engelska)
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Pia
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
föreståndare
|
manager | Staff | |
|
avdelning
|
division | DivisionWithDetails | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string | |
|
debtorClient
|
debtorClient | DebtorClient | |
|
status
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
Förvärvare
|
assignees | array of UserDetail | |
|
arbetslag
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
sidnumrering
|
pagination | Pagination |
Pagination
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
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 |
Telefon
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
type
|
type | string | |
|
number
|
number | string | |
|
favorit
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
entitets-ID
|
entityId | string | |
|
Namn
|
name | string | |
|
enhet
|
entity | string | |
|
startDate
|
startDate | string | |
|
slutdatum
|
endDate | string | |
|
Enheter
|
units | integer |
Relationships_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
sidnumrering
|
pagination | Pagination |
Personal
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
Namn
|
name | string | |
|
email
|
string |
TaskDetail
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
Namn
|
name | string |
Teams
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
Namn
|
name | string | |
|
gruppMedlemmar
|
groupMembers | array of GroupMember |
UserDetail
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
Namn
|
name | string |
UsersWithDetails
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | string | |
|
Namn
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
address
|
address | Address | |
|
skapad
|
created | string | |
|
senastModifierad
|
lastModified | string |
Users_Result
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
sidnumrering
|
pagination | Pagination |