KC (wersja zapoznawcza)
Zarządzanie praktykami KC umożliwia bezpieczny dostęp do danych klientów i firm, co umożliwia użytkownikom wydajne pobieranie informacji i zarządzanie nimi za pośrednictwem zautomatyzowanych przepływów pracy.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Name | Obsługa programu Kloud Connect |
| adres URL | https://www.kloudconnect.com.au/ |
| support@kloudconnect.com.au |
| Metadane łącznika | |
|---|---|
| Publisher | Kloud Connect |
| Witryna internetowa | https://www.kloudconnect.com.au/ |
| Zasady ochrony prywatności | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Kategorie | Zarządzanie biznesem; Finanse |
Zarządzanie praktykami w usłudze Kloud Connect
Overview
Zapewnia to dostęp do interfejsów API zarządzania praktykami w programie Kloud Connect.
Features
- Wyświetlanie listy klientów
- Tworzenie klientów
- Lista kontaktów
- Tworzenie kontaktów
- Wyświetlanie listy faktur
- Tworzenie grafiku
- Lista zadań
- Tworzenie zadań
- Wyświetlanie listy zadań
- Tworzenie zadań
- Dane zarządzania praktykami dostępu
Authentication
Protokół OAuth 2.0 za pośrednictwem serwera kloud Connect Identity Server
Support
support@kloudconnect.com.au
Akcje
| Aktualizowanie grupy klientów |
Aktualizuje grupę klientów według kodu grupy. |
| Aktualizowanie klienta według identyfikatora |
Aktualizuje klienta według identyfikatora. |
| Aktualizowanie kontaktu |
Aktualizuje kontakt według identyfikatora. |
| Aktualizowanie stanu i priorytetu zadania |
Aktualizuje stan i priorytet zadań przepływu pracy. |
| Aktualizowanie zadania |
Aktualizuje zadanie przepływu pracy według identyfikatora. |
| Czas rejestrowania |
Tworzy wpis czasu grafiku. |
| Lista zadań |
Zwraca stronicową listę zadań przepływu pracy. |
| Lista zespołów |
Zwraca dostępne zespoły. |
| pobieranie grup klientów |
pobieranie grup klientów |
| Pobieranie klienta według identyfikatora |
Zwraca szczegóły klienta według identyfikatora. |
| Pobieranie pól niestandardowych według kontekstu |
Zwraca pola niestandardowe dla określonego kontekstu. |
| Podziały listy |
Zwraca stronicową listę podziałów. |
| Tworzenie grupy klientów |
Tworzy grupę klientów. |
| Tworzenie klienta |
Tworzy klienta. |
| Tworzenie zadania |
Tworzy zadanie przepływu pracy. |
| Uzyskiwanie mapowania klienta dłużnika |
Zwraca mapowanie klienta dłużnika dla klienta. |
| Wyświetlanie listy faktur |
Zwraca listę stronicowanych faktur. |
| Wyświetlanie listy klientów |
Zwraca listę stronicowanych klientów. |
| Wyświetlanie listy kontaktów |
Zwraca stronicową listę kontaktów. |
| Wyświetlanie listy priorytetów zadań |
Zwraca dostępne priorytety zadań przepływu pracy. |
| Wyświetlanie listy relacji klientów |
Zwraca listę stronicowanych relacji klientów. |
| Wyświetlanie listy stanów typu zadania |
Zwraca dostępne stany typu zadania przepływu pracy. |
| Wyświetlanie listy szablonów zadań |
Zwraca dostępne szablony zadań przepływu pracy. |
| Wyświetlanie listy tagów klienta |
Zwraca dostępne tagi klienta. |
| Wyświetlanie listy typów czasu, które nie są rozliczane |
Zwraca dostępne typy grafików, które nie są rozliczane. |
| Wyświetlanie listy typów zadań |
Zwraca dostępne typy zadań przepływu pracy. |
| Wyświetlanie użytkowników |
Zwraca stronicową listę użytkowników. |
Aktualizowanie grupy klientów
Aktualizuje grupę klientów według kodu grupy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kod grupy
|
groupCode | True | string |
Kod grupy klienta. |
|
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 |
Aktualizowanie klienta według identyfikatora
Aktualizuje klienta według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator klienta
|
clientId | True | integer |
Identyfikator klienta. |
|
entityType (typ jednostki)
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
Zwrot grzecznościowy
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
drugie imię
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
typ zaufania
|
trustType | string | ||
|
nazwa_firmy
|
companyName | string | ||
|
nazwa_handlowa
|
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 | |
|
Perspektywa
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
płeć
|
gender | string | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
liczba
|
number | string | ||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
witryna internetowa
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formowanieDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
jednostka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
Wiersz adresu1
|
addressLine1 | string | ||
|
Wiersz adresu2
|
addressLine2 | string | ||
|
przedmieście
|
suburb | string | ||
|
stan
|
state | string | ||
|
kraj
|
country | string | ||
|
Kodów pocztowych
|
postCode | string | ||
|
branża
|
industry | string | ||
|
rola
|
role | string | ||
|
wynagrodzenie
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Miejsce zamieszkania
|
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 |
Aktualizowanie kontaktu
Aktualizuje kontakt według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontaktu
|
contactId | True | integer |
Identyfikator kontaktu. |
|
Zwrot grzecznościowy
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
drugie imię
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
płeć
|
gender | string | ||
|
typ
|
type | string | ||
|
liczba
|
number | string | ||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
nazwa_firmy
|
companyName | string | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
preferredName
|
preferredName | string | ||
|
Din
|
din | string | ||
|
dateOfBirth
|
dateOfBirth | date-time | ||
|
isImportent
|
isImportent | boolean | ||
|
addressType
|
addressType | string | ||
|
jednostka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
Wiersz adresu1
|
addressLine1 | string | ||
|
Wiersz adresu2
|
addressLine2 | string | ||
|
przedmieście
|
suburb | string | ||
|
stan
|
state | string | ||
|
kraj
|
country | string | ||
|
Kodów pocztowych
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Aktualizowanie stanu i priorytetu zadania
Aktualizuje stan i priorytet zadań przepływu pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
stan
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Aktualizowanie zadania
Aktualizuje zadanie przepływu pracy według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
jobId | True | integer |
Identyfikator zadania przepływu pracy. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
dłużnych identyfikatorów klienta
|
debtorclientId | integer | ||
|
identyfikator jobTypeId
|
jobTypeId | integer | ||
|
Jobcategory
|
jobCategory | string | ||
|
Jobname
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
data ukończenia
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
opis
|
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 |
Czas rejestrowania
Tworzy wpis czasu grafiku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Jednostek
|
units | double | ||
|
czas rozpoczęcia
|
starttime | string | ||
|
Stawka
|
rate | double | ||
|
opis
|
description | string |
Lista zadań
Zwraca stronicową listę zadań przepływu pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba zadań do zwrócenia na stronę. |
|
|
identyfikator partnera
|
partnerId | string |
Filtruj zadania według identyfikatora partnera. |
|
|
Nazwa klienta
|
clientName | string |
Filtruj zadania według nazwy klienta. |
|
|
Kod klienta
|
clientcode | string |
Filtruj zadania według kodu klienta. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Zwracanie zadań zmodyfikowanych w znaczniku czasu lub po tym znaczniku czasu. |
|
|
Klient debetowy
|
isDebitClient | boolean |
Filtruj zadania według flagi klienta debetowego. |
|
|
Pola niestandardowe
|
isCustomField | boolean |
Uwzględnij pola niestandardowe w wynikach zadania. |
Zwraca
- Body
- Jobs_Result
Lista zespołów
pobieranie grup klientów
pobieranie grup klientów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba grup klientów do zwrócenia na stronę. |
|
|
Kod grupy
|
groupCode | string |
Filtruj grupy klientów według kodu grupy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
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 (typ jednostki)
|
clientGroups.clients.entityType | string |
entityType (typ jednostki) |
|
nazwa_klienta
|
clientGroups.clients.clientname | string |
nazwa_klienta |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
identyfikator dłużnikaClientId
|
clientGroups.clients.debtorClientId | integer |
identyfikator dłużnikaClientId |
|
Createdby
|
clientGroups.createdBY | string |
createdBY |
|
utworzone
|
clientGroups.created | string |
utworzone |
|
ostatnia modyfikacja
|
clientGroups.lastmodified | string |
ostatnia modyfikacja |
|
łączna_liczba_rekordów
|
pagination.total_records | integer |
łączna_liczba_rekordów |
|
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 |
Pobieranie klienta według identyfikatora
Zwraca szczegóły klienta według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator klienta
|
clientId | True | integer |
Identyfikator klienta. |
|
Pola niestandardowe
|
isCustomField | boolean |
Uwzględnij pola niestandardowe. |
Zwraca
- Body
- ClientDetails_Result
Pobieranie pól niestandardowych według kontekstu
Zwraca pola niestandardowe dla określonego kontekstu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kontekst
|
context | True | string |
Kontekst pól niestandardowych. |
Podziały listy
Zwraca stronicową listę podziałów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba podziałów, które mają być zwracane na stronę. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Podziały zwracane zmodyfikowane na znaczniku czasu lub po tym znaczniku czasu. |
Zwraca
- Body
- Divisions_Result
Tworzenie grupy klientów
Tworzy grupę klientów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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 |
Tworzenie klienta
Tworzy klienta.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
entityType (typ jednostki)
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
Zwrot grzecznościowy
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
drugie imię
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
typ zaufania
|
trustType | string | ||
|
nazwa_firmy
|
companyName | string | ||
|
nazwa_handlowa
|
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 | |
|
Perspektywa
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
płeć
|
gender | string | ||
|
typ
|
type | string | ||
|
e-mail
|
string | |||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
typ
|
type | string | ||
|
liczba
|
number | string | ||
|
faworyt
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
witryna internetowa
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formowanieDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
jednostka
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
Wiersz adresu1
|
addressLine1 | string | ||
|
Wiersz adresu2
|
addressLine2 | string | ||
|
przedmieście
|
suburb | string | ||
|
stan
|
state | string | ||
|
kraj
|
country | string | ||
|
Kodów pocztowych
|
postCode | string | ||
|
branża
|
industry | string | ||
|
rola
|
role | string | ||
|
wynagrodzenie
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Miejsce zamieszkania
|
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 |
Tworzenie zadania
Tworzy zadanie przepływu pracy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
dłużnych identyfikatorów klienta
|
debtorclientId | integer | ||
|
identyfikator jobTypeId
|
jobTypeId | integer | ||
|
Jobcategory
|
jobCategory | string | ||
|
Jobname
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
data ukończenia
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
opis
|
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 |
Uzyskiwanie mapowania klienta dłużnika
Zwraca mapowanie klienta dłużnika dla klienta.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator klienta
|
clientId | True | integer |
Identyfikator klienta. |
Zwraca
- Body
- ClientDebtor
Wyświetlanie listy faktur
Zwraca listę stronicowanych faktur.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba faktur do zwrócenia na stronę. |
|
|
Wersja robocza faktury
|
isDraftInvoice | boolean |
Filtruj faktury według flagi faktury roboczej. |
|
|
Uwzględnij szczegóły faktury
|
includeInvoiceDetails | boolean |
Uwzględnij rekordy szczegółów faktury w odpowiedzi. |
|
|
Status
|
status | string |
Filtruj faktury według stanu. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Zwracanie faktur zmodyfikowanych w znaczniku czasu lub po tym znaczniku czasu. |
|
|
Klient debetowy
|
isDebitClient | boolean |
Filtruj faktury według flagi klienta debetowego. |
|
|
Nazwa klienta
|
clientname | string |
Filtruj faktury według nazwy klienta. |
|
|
Kod klienta
|
clientcode | string |
Filtruj faktury według kodu klienta. |
|
|
Nazwa zadania
|
jobname | string |
Filtruj faktury według nazwy zadania. |
|
|
Kod zadania
|
jobcode | string |
Filtruj faktury według kodu zadania. |
|
|
Identyfikator jednostki rozliczeniowej
|
billingEntityId | string |
Filtruj faktury według identyfikatora jednostki rozliczeniowej. |
Zwraca
- Body
- InvoiceDetail_Result
Wyświetlanie listy klientów
Zwraca listę stronicowanych klientów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników (oparty na 1). |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów na stronie. |
|
|
identyfikator partnera
|
partnerId | string |
Filtruj według identyfikatora partnera. |
|
|
Klient debetowy
|
isDebitClient | boolean |
Filtruj według flagi klienta debetowego. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Zwracanie klientów zmodyfikowanych na/po tym znaczniku czasu (ISO 8601). |
|
|
Kod grupy
|
groupCode | string |
Filtruj według kodu grupy. |
|
|
identyfikator klienta
|
clientId | integer |
Filtruj według identyfikatora klienta. |
|
|
Pola niestandardowe
|
isCustomField | boolean |
Uwzględnij pola niestandardowe. |
Zwraca
- Body
- Client_Result
Wyświetlanie listy kontaktów
Zwraca stronicową listę kontaktów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba kontaktów do zwrócenia na stronę. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Zwróć kontakty zmodyfikowane na znaczniku czasu lub po tym znaczniku czasu. |
|
|
Identyfikator kontaktu
|
contactId | integer |
Filtruj kontakty według identyfikatora kontaktu. |
|
|
Filtr identyfikatora klienta
|
isClientId | boolean |
Wskazuje, czy filtr identyfikatora kontaktu powinien być traktowany jako identyfikator klienta. |
|
|
Pola niestandardowe
|
isCustomField | boolean |
Uwzględnij pola niestandardowe w wynikach kontaktu. |
Zwraca
- Body
- Contact_Result
Wyświetlanie listy priorytetów zadań
Wyświetlanie listy relacji klientów
Zwraca listę stronicowanych relacji klientów.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator klienta
|
clientId | True | integer |
Identyfikator klienta. |
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba relacji do zwrócenia na stronę. |
Zwraca
- Body
- Relationships_Result
Wyświetlanie listy stanów typu zadania
Wyświetlanie listy szablonów zadań
Wyświetlanie listy tagów klienta
Zwraca dostępne tagi klienta.
Wyświetlanie listy typów czasu, które nie są rozliczane
Zwraca dostępne typy grafików, które nie są rozliczane.
Wyświetlanie listy typów zadań
Wyświetlanie użytkowników
Zwraca stronicową listę użytkowników.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyników. |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba użytkowników do zwrócenia na stronę. |
|
|
Zmodyfikowano od
|
modifiedSince | string |
Zwróć użytkowników zmodyfikowanych na znaczniku czasu lub po tym znaczniku czasu. |
|
|
Nazwa roli
|
rolename | string |
Filtruj użytkowników według nazwy roli. |
Zwraca
- Body
- Users_Result
Definicje
Address
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
jednostka
|
unit | string | |
|
careOf
|
careOf | string | |
|
Wiersz adresu1
|
addressLine1 | string | |
|
Wiersz adresu2
|
addressLine2 | string | |
|
przedmieście
|
suburb | string | |
|
stan
|
state | string | |
|
kraj
|
country | string | |
|
Kodów pocztowych
|
postCode | string |
Client
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string | |
|
Zwrot grzecznościowy
|
salutation | string | |
|
nazwa
|
name | string | |
|
firstName
|
firstName | string | |
|
drugie imię
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
dzielenie
|
division | Division | |
|
entityType (typ jednostki)
|
entityType | string | |
|
partner
|
partner | Staff | |
|
menedżer
|
manager | Staff | |
|
Kontakty
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string | |
|
Pwt
|
wip | string | |
|
lokalizacja
|
location | string | |
|
stan
|
status | string | |
|
grupa
|
group | Group | |
|
dłużnikClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
pola niestandardowe
|
customFields | array of CustomField |
ClientDebtor
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dłużny
|
debtorid | integer | |
|
nazwa dłużnika
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string | |
|
Zwrot grzecznościowy
|
salutation | string | |
|
nazwa
|
name | string | |
|
firstName
|
firstName | string | |
|
drugie imię
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
e-mail
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
dzielenie
|
division | Division | |
|
entityType (typ jednostki)
|
entityType | string | |
|
partner
|
partner | Staff | |
|
menedżer
|
manager | Staff | |
|
Kontakty
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string | |
|
Pwt
|
wip | string | |
|
lokalizacja
|
location | string | |
|
stan
|
status | string | |
|
grupa
|
group | Group | |
|
dłużnikClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
pola niestandardowe
|
customFields | array of CustomField | |
|
Din
|
din | string | |
|
Tfn
|
tfn | string | |
|
bankName
|
bankName | string | |
|
bankAccountName
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
bankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
klient
|
client | array of ClientDetails |
ClientSummary
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
kod
|
code | string | |
|
nazwa
|
name | string |
Client_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
dzielenie na strony
|
pagination | Pagination |
Kontakt biznesowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
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
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zwrot grzecznościowy
|
salutation | string | |
|
firstName
|
firstName | string | |
|
drugie imię
|
middleName | string | |
|
lastName
|
lastName | string | |
|
płeć
|
gender | string | |
|
phone
|
phone | array of Phone | |
|
e-mail
|
array of Email | ||
|
nazwa_firmy
|
companyName | string | |
|
placeOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
Din
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
nazwa
|
name | string | |
|
lokalizacja
|
location | string | |
|
kontekst
|
context | string | |
|
pola niestandardowe
|
customFields | array of CustomField |
Contact_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kontakty
|
contacts | array of ContactEntity | |
|
dzielenie na strony
|
pagination | Pagination |
Pole niestandardowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DłużnikClient
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
kod
|
code | string | |
|
nazwa
|
name | string |
Dzielenie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
nazwa
|
name | string |
DivisionWithDetails
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
nazwa
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
ostatnioModyfikowano
|
lastModifiedAt | string |
Podział
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
nazwa
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
ostatnioModyfikowano
|
lastModifiedAt | string | |
|
Ostatnio zmodyfikowane przez
|
lastModifiedBy | string | |
|
utworzone
|
created | string |
Divisions_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Podziałów
|
divisions | array of Divisionext | |
|
dzielenie na strony
|
pagination | Pagination |
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string | |
|
e-mail
|
string | ||
|
faworyt
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Group
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
kod
|
code | string | |
|
nazwa
|
name | string |
Członek grupy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
nazwa
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
dzielenie na strony
|
pagination | Pagination |
InvoiceDetails
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
liczba
|
number | string | |
|
refNo
|
refNo | string | |
|
typ
|
type | string | |
|
date
|
date | string | |
|
należny
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
płatność
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
saldo
|
balance | double | |
|
stan
|
status | string | |
|
identyfikator dłużnikaClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
nazwa_klienta_dłużnika
|
debtorClientName | string | |
|
dłużnyBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string |
Linie faktury
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
numer linii
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
kod zadania
|
jobcode | string | |
|
nazwa
|
name | string | |
|
Pwt
|
wip | double | |
|
klient
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
menedżer
|
manager | Staff | |
|
dzielenie
|
division | DivisionWithDetails | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string | |
|
dłużnikClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
ZadanieTemplate
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
opis
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Turnaround
|
turnaround | integer | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string |
Typ zadania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
opis
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string |
JobTypeStatus
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
IdentyfikatorKategorii
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
nazwa
|
name | string | |
|
priority
|
priority | string | |
|
data ukończenia
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Pwt
|
wip | double | |
|
klient
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
menedżer
|
manager | Staff | |
|
dzielenie
|
division | DivisionWithDetails | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string | |
|
dłużnikClient
|
debtorClient | DebtorClient | |
|
stan
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
Cesjonariuszy
|
assignees | array of UserDetail | |
|
zespół
|
team | TaskDetail | |
|
pola niestandardowe
|
customFields | array of CustomField |
Jobs_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
dzielenie na strony
|
pagination | Pagination |
Pagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
łączna_liczba_rekordów
|
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
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string | |
|
liczba
|
number | string | |
|
faworyt
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
typ
|
type | string | |
|
entityId
|
entityId | string | |
|
nazwa
|
name | string | |
|
jednostka
|
entity | string | |
|
startDate
|
startDate | string | |
|
data zakończenia
|
endDate | string | |
|
Jednostek
|
units | integer |
Relationships_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
dzielenie na strony
|
pagination | Pagination |
Personel
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
nazwa
|
name | string | |
|
e-mail
|
string |
Szczegóły zadania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer | |
|
nazwa
|
name | string |
Teams
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
nazwa
|
name | string | |
|
Członkowie grupy
|
groupMembers | array of GroupMember |
UserDetail
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
nazwa
|
name | string |
UżytkownicyWithDetails
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
nazwa
|
name | string | |
|
roleName
|
roleName | string | |
|
e-mail
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
adres
|
address | Address | |
|
utworzone
|
created | string | |
|
ostatnia modyfikacja
|
lastModified | string |
Users_Result
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
dzielenie na strony
|
pagination | Pagination |