KC (preview)
KC Practice Management maakt veilige toegang tot client- en zakelijke gegevens mogelijk, zodat gebruikers gegevens efficiënt kunnen ophalen en beheren via geautomatiseerde werkstromen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Naam | Ondersteuning voor Kloud Connect |
| URL | https://www.kloudconnect.com.au/ |
| E-mailen | support@kloudconnect.com.au |
| Connectormetagegevens | |
|---|---|
| Uitgever | Kloud Connect |
| Website | https://www.kloudconnect.com.au/ |
| Privacybeleid | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Categorieën | Bedrijfsbeheer; Financieren |
Kloud Connect Practice Management
Overview
Dit biedt toegang tot Kloud Connect Practice Management API's.
Features
- Clients vermelden
- Clients maken
- Contactpersonen weergeven
- Contacten maken
- Facturen weergeven
- Rooster maken
- Taken weergeven
- Taken maken
- Lijst Vacatures
- Banen creëren
- Toegang tot praktijkbeheergegevens
Authentication
OAuth 2.0 via Kloud Connect Identity Server
Support
support@kloudconnect.com.au
Acties
| Aangepaste velden ophalen op context |
Retourneert aangepaste velden voor de opgegeven context. |
| Client bijwerken op id |
Hiermee wordt een client bijgewerkt op id. |
| Client maken |
Hiermee wordt een client aangemaakt. |
| Client ophalen op id |
Retourneert details voor een client op id. |
| Clientgroep bijwerken |
Hiermee werkt u een clientgroep bij op groepscode. |
| Clientgroep maken |
Hiermee maakt u een clientgroep. |
| Clientgroepen ophalen |
Clientgroepen ophalen |
| Clientrelaties weergeven |
Hiermee wordt een gepaginade lijst met clientrelaties geretourneerd. |
| Clients vermelden |
Hiermee wordt een gepaginade lijst met clients geretourneerd. |
| Clienttags vermelden |
Retourneert de beschikbare clienttags. |
| Contactpersonen weergeven |
Hiermee wordt een gepaginade lijst met contactpersonen geretourneerd. |
| Contactpersoon bijwerken |
Hiermee wordt een contactpersoon bijgewerkt op id. |
| Facturen weergeven |
Retourneert een gepaginade lijst met facturen. |
| Gebruikers weergeven |
Hiermee wordt een gepaginade lijst met gebruikers geretourneerd. |
| Klanttoewijzing van debiteur ophalen |
Retourneert de klanttoewijzing van debiteuren voor een klant. |
| Lijstverdelingen |
Hiermee wordt een gepaginade lijst met divisies geretourneerd. |
| Logboektijd |
Hiermee maakt u een roostertijditem. |
| Niet-factureerbare tijdtypen weergeven |
Retourneert de beschikbare niet-factureerbare roostertypen. |
| Opdrachten weergeven |
Hiermee wordt een gepaginade lijst met werkstroomtaken geretourneerd. |
| Statussen van taaktype weergeven |
Retourneert de statussen van het beschikbare werkstroomtaaktype. |
| Taak bijwerken |
Hiermee werkt u een werkstroomtaak op id bij. |
| Taak maken |
Hiermee maakt u een werkstroomtaak. |
| Taaksjablonen weergeven |
Retourneert de beschikbare werkstroomtaaksjablonen. |
| Taakstatus en prioriteit bijwerken |
Hiermee wordt de status en prioriteit voor werkstroomtaken bijgewerkt. |
| Taaktypen weergeven |
Retourneert de beschikbare werkstroomtaaktypen. |
| Takenprioriteiten vermelden |
Retourneert de beschikbare prioriteiten voor werkstroomtaken. |
| Teams vermelden |
Retourneert de beschikbare teams. |
Aangepaste velden ophalen op context
Retourneert aangepaste velden voor de opgegeven context.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Context
|
context | True | string |
Context van aangepaste velden. |
Client bijwerken op id
Hiermee wordt een client bijgewerkt op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client-identificatiecode. |
|
entiteitType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
groet
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
tweede naam
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
TrustType
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
handelsnaam
|
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 | |
|
Vooruitzicht
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
datumvangeboorte
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
geslacht
|
gender | string | ||
|
type
|
type | string | ||
|
e-mail
|
string | |||
|
favoriet
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
favoriet
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
webpagina
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
eenheid
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
adresLijn1
|
addressLine1 | string | ||
|
adresLijn2
|
addressLine2 | string | ||
|
voorstad
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
postCode
|
postCode | string | ||
|
industrie
|
industry | string | ||
|
role
|
role | string | ||
|
salaris
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Kunt
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Ingezetene
|
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 |
Client maken
Hiermee wordt een client aangemaakt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
entiteitType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
groet
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
tweede naam
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
TrustType
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
handelsnaam
|
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 | |
|
prospect
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
datumvangeboorte
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
geslacht
|
gender | string | ||
|
type
|
type | string | ||
|
e-mail
|
string | |||
|
favoriet
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
favoriet
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
webpagina
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
eenheid
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
adresLijn1
|
addressLine1 | string | ||
|
adresLijn2
|
addressLine2 | string | ||
|
voorstad
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
postCode
|
postCode | string | ||
|
industrie
|
industry | string | ||
|
role
|
role | string | ||
|
salaris
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Kunt
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Ingezetene
|
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 |
Client ophalen op id
Retourneert details voor een client op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client-identificatiecode. |
|
Aangepaste velden
|
isCustomField | boolean |
Aangepaste velden opnemen. |
Retouren
- Body
- ClientDetails_Result
Clientgroep bijwerken
Hiermee werkt u een clientgroep bij op groepscode.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Groepscode
|
groupCode | True | string |
Code van clientgroep. |
|
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 |
Clientgroep maken
Hiermee maakt u een clientgroep.
Parameters
| Name | Sleutel | Vereist | Type | 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 |
Clientgroepen ophalen
Clientgroepen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal clientgroepen dat per pagina moet worden geretourneerd. |
|
|
Groepscode
|
groupCode | string |
Filter clientgroepen op groepscode. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
contactpersoon
|
clientGroups.contact | string |
contactpersoon |
|
tags
|
clientGroups.tags | array of |
tags |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
entiteitType
|
clientGroups.clients.entityType | string |
entiteitType |
|
clientnaam
|
clientGroups.clients.clientname | string |
clientnaam |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debitClientId
|
clientGroups.clients.debtorClientId | integer |
debitClientId |
|
Createdby
|
clientGroups.createdBY | string |
Createdby |
|
created
|
clientGroups.created | string |
created |
|
laatst gewijzigd
|
clientGroups.lastmodified | string |
laatst gewijzigd |
|
totaal_records
|
pagination.total_records | integer |
totaal_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 |
Clientrelaties weergeven
Hiermee wordt een gepaginade lijst met clientrelaties geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client-identificatiecode. |
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal relaties dat per pagina moet worden geretourneerd. |
Retouren
- Body
- Relationships_Result
Clients vermelden
Hiermee wordt een gepaginade lijst met clients geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten (op basis van 1). |
|
|
Paginaformaat
|
pageSize | integer |
Aantal items per pagina. |
|
|
Partner-ID
|
partnerId | string |
Filter op partner-id. |
|
|
Debit-client
|
isDebitClient | boolean |
Filter op debit-clientvlag. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Clients retourneren die zijn gewijzigd op/na deze tijdstempel (ISO 8601). |
|
|
Groepscode
|
groupCode | string |
Filteren op groepscode. |
|
|
Client-ID
|
clientId | integer |
Filteren op client-id. |
|
|
Aangepaste velden
|
isCustomField | boolean |
Aangepaste velden opnemen. |
Retouren
- Body
- Client_Result
Clienttags vermelden
Retourneert de beschikbare clienttags.
Contactpersonen weergeven
Hiermee wordt een gepaginade lijst met contactpersonen geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal contactpersonen dat per pagina moet worden geretourneerd. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Contactpersonen retourneren die zijn gewijzigd op of na deze tijdstempel. |
|
|
Contactpersoon-id
|
contactId | integer |
Contactpersonen filteren op contactpersoon-id. |
|
|
Client-id-filter
|
isClientId | boolean |
Hiermee wordt aangegeven of het filter voor de contactpersoon-id moet worden behandeld als een client-id. |
|
|
Aangepaste velden
|
isCustomField | boolean |
Voeg aangepaste velden toe aan de resultaten van de contactpersoon. |
Retouren
- Body
- Contact_Result
Contactpersoon bijwerken
Hiermee wordt een contactpersoon bijgewerkt op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contactpersoon-id
|
contactId | True | integer |
Contactpersoon-id. |
|
groet
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
tweede naam
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
geslacht
|
gender | string | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
favoriet
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
e-mail
|
string | |||
|
favoriet
|
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 | ||
|
eenheid
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
adresLijn1
|
addressLine1 | string | ||
|
adresLijn2
|
addressLine2 | string | ||
|
voorstad
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
postCode
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Facturen weergeven
Retourneert een gepaginade lijst met facturen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal facturen dat per pagina moet worden geretourneerd. |
|
|
Conceptfactuur
|
isDraftInvoice | boolean |
Filter facturen op conceptfactuurvlag. |
|
|
Factuurgegevens opnemen
|
includeInvoiceDetails | boolean |
Neem factuurdetailrecords op in het antwoord. |
|
|
Status
|
status | string |
Facturen filteren op status. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Facturen retourneren die zijn gewijzigd op of na deze tijdstempel. |
|
|
Debit-client
|
isDebitClient | boolean |
Filter facturen op debit-clientvlag. |
|
|
Clientnaam
|
clientname | string |
Facturen filteren op clientnaam. |
|
|
Clientcode
|
clientcode | string |
Facturen filteren op clientcode. |
|
|
Taaknaam
|
jobname | string |
Facturen filteren op taaknaam. |
|
|
Taakcode
|
jobcode | string |
Facturen filteren op taakcode. |
|
|
Factureringsentiteits-id
|
billingEntityId | string |
Facturen filteren op factureringsentiteits-id. |
Retouren
- Body
- InvoiceDetail_Result
Gebruikers weergeven
Hiermee wordt een gepaginade lijst met gebruikers geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal gebruikers dat per pagina moet worden geretourneerd. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Retourneer gebruikers die zijn gewijzigd op of na deze tijdstempel. |
|
|
Rolnaam
|
rolename | string |
Filter gebruikers op rolnaam. |
Retouren
- Body
- Users_Result
Klanttoewijzing van debiteur ophalen
Retourneert de klanttoewijzing van debiteuren voor een klant.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Client-ID
|
clientId | True | integer |
Client-identificatiecode. |
Retouren
- Body
- ClientDebtor
Lijstverdelingen
Hiermee wordt een gepaginade lijst met divisies geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal delen dat per pagina moet worden geretourneerd. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Retourafdelingen die zijn gewijzigd op of na deze tijdstempel. |
Retouren
- Body
- Divisions_Result
Logboektijd
Hiermee maakt u een roostertijditem.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Eenheden
|
units | double | ||
|
starttijd
|
starttime | string | ||
|
Tarief
|
rate | double | ||
|
beschrijving
|
description | string |
Niet-factureerbare tijdtypen weergeven
Retourneert de beschikbare niet-factureerbare roostertypen.
Opdrachten weergeven
Hiermee wordt een gepaginade lijst met werkstroomtaken geretourneerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer van de resultaten. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal taken dat per pagina moet worden geretourneerd. |
|
|
Partner-ID
|
partnerId | string |
Filter taken op partner-id. |
|
|
Clientnaam
|
clientName | string |
Filter taken op clientnaam. |
|
|
Clientcode
|
clientcode | string |
Filter taken op clientcode. |
|
|
Gewijzigd sinds
|
modifiedSince | string |
Retourneert taken die zijn gewijzigd op of na deze tijdstempel. |
|
|
Debit-client
|
isDebitClient | boolean |
Filter taken op debit-clientvlag. |
|
|
Aangepaste velden
|
isCustomField | boolean |
Voeg aangepaste velden toe aan de taakresultaten. |
Retouren
- Body
- Jobs_Result
Statussen van taaktype weergeven
Taak bijwerken
Hiermee werkt u een werkstroomtaak op id bij.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Job-ID
|
jobId | True | integer |
Werkstroomtaak-id. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debiteurclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
taaknaam
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
vervaldatum
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Prioriteit
|
priority | string | ||
|
beschrijving
|
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 |
Taak maken
Hiermee maakt u een werkstroomtaak.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debiteurclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
taaknaam
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
vervaldatum
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
Prioriteit
|
priority | string | ||
|
beschrijving
|
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 |
Taaksjablonen weergeven
Taakstatus en prioriteit bijwerken
Hiermee wordt de status en prioriteit voor werkstroomtaken bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
Prioriteit
|
priority | string | ||
|
status
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Taaktypen weergeven
Takenprioriteiten vermelden
Teams vermelden
Definities
Adres
| Name | Pad | Type | Description |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
eenheid
|
unit | string | |
|
careOf
|
careOf | string | |
|
adresLijn1
|
addressLine1 | string | |
|
adresLijn2
|
addressLine2 | string | |
|
voorstad
|
suburb | string | |
|
state
|
state | string | |
|
country
|
country | string | |
|
postCode
|
postCode | string |
Client
| Name | Pad | Type | Description |
|---|---|---|---|
|
code
|
code | string | |
|
groet
|
salutation | string | |
|
naam
|
name | string | |
|
firstName
|
firstName | string | |
|
tweede naam
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
afdeling
|
division | Division | |
|
entiteitType
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
leidinggevende
|
manager | Staff | |
|
Contactpersonen
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Kunt
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string | |
|
wip
|
wip | string | |
|
plaats
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
debiteurClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Name | Pad | Type | Description |
|---|---|---|---|
|
debiteur-id
|
debtorid | integer | |
|
debiteurnaam
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
client-id
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Name | Pad | Type | Description |
|---|---|---|---|
|
code
|
code | string | |
|
groet
|
salutation | string | |
|
naam
|
name | string | |
|
firstName
|
firstName | string | |
|
tweede naam
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
afdeling
|
division | Division | |
|
entiteitType
|
entityType | string | |
|
Partner
|
partner | Staff | |
|
leidinggevende
|
manager | Staff | |
|
Contactpersonen
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Kunt
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string | |
|
wip
|
wip | string | |
|
plaats
|
location | string | |
|
status
|
status | string | |
|
group
|
group | Group | |
|
debiteurClient
|
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 | Pad | Type | Description |
|---|---|---|---|
|
client
|
client | array of ClientDetails |
ClientSummary
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
naam
|
name | string |
Client_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
paginering
|
pagination | Pagination |
Contact
| Name | Pad | Type | 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 | Pad | Type | Description |
|---|---|---|---|
|
groet
|
salutation | string | |
|
firstName
|
firstName | string | |
|
tweede naam
|
middleName | string | |
|
lastName
|
lastName | string | |
|
geslacht
|
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 | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
naam
|
name | string | |
|
plaats
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
Contactpersonen
|
contacts | array of ContactEntity | |
|
paginering
|
pagination | Pagination |
CustomField
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DebiteurClient
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
naam
|
name | string |
Divisie
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
naam
|
name | string |
DivisionWithDetails
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
naam
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
laatstGewijzigdOp
|
lastModifiedAt | string |
Divisionext
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
naam
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
laatstGewijzigdOp
|
lastModifiedAt | string | |
|
laatstGewijzigdDoor
|
lastModifiedBy | string | |
|
created
|
created | string |
Divisions_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
Divisies
|
divisions | array of Divisionext | |
|
paginering
|
pagination | Pagination |
E-mailen
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | string | |
|
e-mail
|
string | ||
|
favoriet
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Groep
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
naam
|
name | string |
Groepslid
| Name | Pad | Type | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
naam
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
paginering
|
pagination | Pagination |
InvoiceDetails
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
number
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
verschuldigd
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
betaling
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
evenwicht
|
balance | double | |
|
status
|
status | string | |
|
debitClientId
|
debtorClientId | integer | |
|
debitclientCode
|
debtorClientCode | string | |
|
debitclientName
|
debtorClientName | string | |
|
debiteurBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string |
InvoiceLines
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
lineNumber
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
lineTotal
|
lineTotal | double |
JobInvoice
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
naam
|
name | string | |
|
wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
leidinggevende
|
manager | Staff | |
|
afdeling
|
division | DivisionWithDetails | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string | |
|
debiteurClient
|
debtorClient | string | |
|
factuur-id
|
invoiceid | integer |
JobPriorityValues
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
Sjabloon
| Name | Pad | Type | Description |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
beschrijving
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Ommekeer
|
turnaround | integer | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string |
Functietype
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
beschrijving
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string |
JobTypeStatus
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
categorieId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
naam
|
name | string | |
|
Prioriteit
|
priority | string | |
|
vervaldatum
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Partner
|
partner | Staff | |
|
leidinggevende
|
manager | Staff | |
|
afdeling
|
division | DivisionWithDetails | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string | |
|
debiteurClient
|
debtorClient | DebtorClient | |
|
status
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
toegewezen personen
|
assignees | array of UserDetail | |
|
ploeg
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
paginering
|
pagination | Pagination |
Pagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totaal_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 |
Telefoon
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | string | |
|
number
|
number | string | |
|
favoriet
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Name | Pad | Type | Description |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
entityId
|
entityId | string | |
|
naam
|
name | string | |
|
entiteit
|
entity | string | |
|
startDate
|
startDate | string | |
|
einddatum
|
endDate | string | |
|
Eenheden
|
units | integer |
Relationships_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
paginering
|
pagination | Pagination |
Personeel
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
naam
|
name | string | |
|
e-mail
|
string |
TaskDetail
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
naam
|
name | string |
Teams
| Name | Pad | Type | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
naam
|
name | string | |
|
groepsleden
|
groupMembers | array of GroupMember |
UserDetail
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
naam
|
name | string |
UsersWithDetails
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
naam
|
name | string | |
|
roleName
|
roleName | string | |
|
e-mail
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
adres
|
address | Address | |
|
created
|
created | string | |
|
laatstGewijzigd
|
lastModified | string |
Users_Result
| Name | Pad | Type | Description |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
paginering
|
pagination | Pagination |