KC (предварительная версия)
Управление практикой KC обеспечивает безопасный доступ к клиентским и бизнес-данным, позволяя пользователям эффективно получать информацию и управлять ими с помощью автоматизированных рабочих процессов.
Этот соединитель доступен в следующих продуктах и регионах:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Name | Поддержка Kloud Connect |
| URL | https://www.kloudconnect.com.au/ |
| Адрес электронной почты | support@kloudconnect.com.au |
| Метаданные соединителя | |
|---|---|
| Publisher | Kloud Connect |
| Веб-сайт | https://www.kloudconnect.com.au/ |
| Политика конфиденциальности | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Categories | Управление бизнесом; Финансировать |
Kloud Connect Practice Management
Обзор
Это обеспечивает доступ к API-интерфейсам управления практикой Kloud Connect.
Features
- Перечисление клиентов
- Создание клиентов
- Список контактов
- Создание контактов
- Перечисление счетов
- Создание расписания
- Перечисление задач
- Создание задач
- Список вакансий
- Создание заданий
- Доступ к данным управления практикой
Аутентификация
OAuth 2.0 через сервер удостоверений Kloud Connect
Поддержка
support@kloudconnect.com.au
Действия
| Время журнала |
Создает запись расписания. |
| Вывод списка связей клиентов |
Возвращает список связей клиента со страницами. |
| Вывод списка состояний типа задания |
Возвращает доступные состояния задания рабочего процесса. |
| Вывод списка тегов клиента |
Возвращает доступные теги клиента. |
| Вывод списка типов времени, не являющихся выставлением счетов |
Возвращает доступные неопланимые типы расписаний. |
| Вывод списка типов заданий |
Возвращает доступные типы заданий рабочего процесса. |
| Вывод списка шаблонов заданий |
Возвращает доступные шаблоны заданий рабочего процесса. |
| Обновление группы клиентов |
Обновляет группу клиентов по коду группы. |
| Обновление задания |
Обновляет задание рабочего процесса по идентификатору. |
| Обновление клиента по идентификатору |
Обновляет клиент по идентификатору. |
| Обновление контакта |
Обновляет контакт по идентификатору. |
| Обновление состояния задания и приоритета |
Обновляет состояние и приоритет заданий рабочих процессов. |
| Перечисление клиентов |
Возвращает список страничных клиентов. |
| Перечисление приоритетов заданий |
Возвращает доступные приоритеты заданий рабочего процесса. |
| Перечисление разделов |
Возвращает страничный список разделов. |
| Перечисление счетов |
Возвращает страничный список счетов. |
| Получение клиента по идентификатору |
Возвращает сведения о клиенте по идентификатору. |
| получение клиентских групп |
получение клиентских групп |
| Получение настраиваемых полей по контексту |
Возвращает настраиваемые поля для указанного контекста. |
| Получение сопоставления клиентов-заемщиков |
Возвращает сопоставление клиентов-должников для клиента. |
| Создание группы клиентов |
Создает группу клиентов. |
| Создание задания |
Создает задание рабочего процесса. |
| Создание клиента |
Создается клиент. |
| Список заданий |
Возвращает список страничных заданий рабочих процессов. |
| Список команд |
Возвращает доступные команды. |
| Список контактов |
Возвращает список страничных контактов. |
| Список пользователей |
Возвращает страничный список пользователей. |
Время журнала
Создает запись расписания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
Taskid
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
Единиц
|
units | double | ||
|
время начала
|
starttime | string | ||
|
Ставка
|
rate | double | ||
|
описание
|
description | string |
Вывод списка связей клиентов
Возвращает список связей клиента со страницами.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор клиента
|
clientId | True | integer |
Идентификатор клиента. |
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество связей, возвращаемых на страницу. |
Возвращаемое значение
- Тело
- Relationships_Result
Вывод списка состояний типа задания
Вывод списка тегов клиента
Возвращает доступные теги клиента.
Вывод списка типов времени, не являющихся выставлением счетов
Возвращает доступные неопланимые типы расписаний.
Вывод списка типов заданий
Вывод списка шаблонов заданий
Обновление группы клиентов
Обновляет группу клиентов по коду группы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код группы
|
groupCode | True | string |
Код группы клиентов. |
|
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 |
Обновление задания
Обновляет задание рабочего процесса по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | integer |
Идентификатор задания рабочего процесса. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
дебиклиентId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
имя задачи
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
описание
|
description | 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 |
Обновление клиента по идентификатору
Обновляет клиент по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор клиента
|
clientId | True | integer |
Идентификатор клиента. |
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
приветствие
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
второе имя
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
тип доверия
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName
|
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 | boolean | ||
|
preferredName;
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
гендер
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
любимый
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
любимый
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
веб-сайт
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
единица
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
адресная строка1
|
addressLine1 | string | ||
|
адресная строка2
|
addressLine2 | string | ||
|
пригород
|
suburb | string | ||
|
state
|
state | string | ||
|
страна
|
country | string | ||
|
почтовый индекс
|
postCode | string | ||
|
промышленность
|
industry | string | ||
|
role
|
role | string | ||
|
зарплата
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Резидент
|
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 | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Обновление контакта
Обновляет контакт по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contactId | True | integer |
Идентификатор контакта. |
|
приветствие
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
второе имя
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
гендер
|
gender | string | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
любимый
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
любимый
|
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 | ||
|
единица
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
адресная строка1
|
addressLine1 | string | ||
|
адресная строка2
|
addressLine2 | string | ||
|
пригород
|
suburb | string | ||
|
state
|
state | string | ||
|
страна
|
country | string | ||
|
почтовый индекс
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Обновление состояния задания и приоритета
Обновляет состояние и приоритет заданий рабочих процессов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
статус
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Перечисление клиентов
Возвращает список страничных клиентов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов (на основе 1). |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов на странице. |
|
|
Partner ID
|
partnerId | string |
Фильтрация по идентификатору партнера. |
|
|
Дебетовый клиент
|
isDebitClient | boolean |
Фильтруйте по флагу дебетового клиента. |
|
|
Изменено с момента
|
modifiedSince | string |
Возвращать клиенты, измененные или после этого метки времени (ISO 8601). |
|
|
Код группы
|
groupCode | string |
Фильтрация по коду группы. |
|
|
идентификатор клиента
|
clientId | integer |
Фильтрация по идентификатору клиента. |
|
|
Настраиваемые поля
|
isCustomField | boolean |
Включите настраиваемые поля. |
Возвращаемое значение
- Тело
- Client_Result
Перечисление приоритетов заданий
Возвращает доступные приоритеты заданий рабочего процесса.
Возвращаемое значение
- Тело
- JobPriorityValues
Перечисление разделов
Возвращает страничный список разделов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество разделов, возвращаемых на страницу. |
|
|
Изменено с момента
|
modifiedSince | string |
Возвращайте деления, измененные или после этого метки времени. |
Возвращаемое значение
- Тело
- Divisions_Result
Перечисление счетов
Возвращает страничный список счетов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество счетов, возвращаемых на страницу. |
|
|
Черновик счета
|
isDraftInvoice | boolean |
Фильтрация счетов по черновику флага счета. |
|
|
Включение сведений о счете
|
includeInvoiceDetails | boolean |
Включите в ответ записи сведений о счете. |
|
|
Status
|
status | string |
Фильтрация счетов по состоянию. |
|
|
Изменено с момента
|
modifiedSince | string |
Возвращайте счета, измененные или после этого метки времени. |
|
|
Дебетовый клиент
|
isDebitClient | boolean |
Фильтрация счетов по флагу дебетового клиента. |
|
|
имя клиента;
|
clientname | string |
Фильтрация счетов по имени клиента. |
|
|
Код клиента
|
clientcode | string |
Фильтрация счетов по коду клиента. |
|
|
Имя задания
|
jobname | string |
Фильтрация счетов по имени задания. |
|
|
Код задания
|
jobcode | string |
Фильтрация счетов по коду задания. |
|
|
Идентификатор сущности выставления счетов
|
billingEntityId | string |
Фильтрация счетов по идентификатору сущности выставления счетов. |
Возвращаемое значение
- Тело
- InvoiceDetail_Result
Получение клиента по идентификатору
Возвращает сведения о клиенте по идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор клиента
|
clientId | True | integer |
Идентификатор клиента. |
|
Настраиваемые поля
|
isCustomField | boolean |
Включите настраиваемые поля. |
Возвращаемое значение
- Тело
- ClientDetails_Result
получение клиентских групп
получение клиентских групп
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество групп клиентов, возвращаемых на страницу. |
|
|
Код группы
|
groupCode | string |
Фильтрация групп клиентов по коду группы. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
contact
|
clientGroups.contact | string |
contact |
|
tags
|
clientGroups.tags | array of |
tags |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
entityType
|
clientGroups.clients.entityType | string |
entityType |
|
имя клиента
|
clientGroups.clients.clientname | string |
имя клиента |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debtorClientId
|
clientGroups.clients.debtorClientId | integer |
debtorClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
создано
|
clientGroups.created | string |
создано |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
всего_записей
|
pagination.total_records | integer |
всего_записей |
|
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 |
Получение настраиваемых полей по контексту
Возвращает настраиваемые поля для указанного контекста.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контекст
|
context | True | string |
Контекст настраиваемых полей. |
Получение сопоставления клиентов-заемщиков
Возвращает сопоставление клиентов-должников для клиента.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор клиента
|
clientId | True | integer |
Идентификатор клиента. |
Возвращаемое значение
- Тело
- ClientDebtor
Создание группы клиентов
Создает группу клиентов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
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 |
Создание задания
Создает задание рабочего процесса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
дебиклиентId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
имя задачи
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
описание
|
description | 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 |
Создание клиента
Создается клиент.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
entityType
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
приветствие
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
второе имя
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
тип доверия
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName
|
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 | boolean | ||
|
preferredName;
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
гендер
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
любимый
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
number
|
number | string | ||
|
любимый
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
веб-сайт
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
единица
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
адресная строка1
|
addressLine1 | string | ||
|
адресная строка2
|
addressLine2 | string | ||
|
пригород
|
suburb | string | ||
|
state
|
state | string | ||
|
страна
|
country | string | ||
|
почтовый индекс
|
postCode | string | ||
|
промышленность
|
industry | string | ||
|
role
|
role | string | ||
|
зарплата
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
Cna
|
acn | integer | ||
|
Din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
Резидент
|
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 | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Список заданий
Возвращает список страничных заданий рабочих процессов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество заданий, возвращаемых на страницу. |
|
|
Partner ID
|
partnerId | string |
Фильтрация заданий по идентификатору партнера. |
|
|
имя клиента;
|
clientName | string |
Фильтрация заданий по имени клиента. |
|
|
Код клиента
|
clientcode | string |
Фильтрация заданий по клиентскому коду. |
|
|
Изменено с момента
|
modifiedSince | string |
Возвращайте задания, измененные или после этого метки времени. |
|
|
Дебетовый клиент
|
isDebitClient | boolean |
Фильтрация заданий по флагу дебетового клиента. |
|
|
Настраиваемые поля
|
isCustomField | boolean |
Включите настраиваемые поля в результаты задания. |
Возвращаемое значение
- Тело
- Jobs_Result
Список команд
Список контактов
Возвращает список страничных контактов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество контактов, возвращаемых на страницу. |
|
|
Изменено с момента
|
modifiedSince | string |
Возврат контактов, измененных или после этого метки времени. |
|
|
Код контактного лица
|
contactId | integer |
Фильтрация контактов по идентификатору контакта. |
|
|
Фильтр идентификатора клиента
|
isClientId | boolean |
Указывает, должен ли фильтр идентификатора контакта рассматриваться как идентификатор клиента. |
|
|
Настраиваемые поля
|
isCustomField | boolean |
Включите настраиваемые поля в результаты контакта. |
Возвращаемое значение
- Тело
- Contact_Result
Список пользователей
Возвращает страничный список пользователей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результатов. |
|
|
Размер страницы
|
pageSize | integer |
Количество пользователей, возвращаемых на страницу. |
|
|
Изменено с момента
|
modifiedSince | string |
Возвращает пользователей, измененных или после этого метки времени. |
|
|
Имя роли
|
rolename | string |
Фильтрация пользователей по имени роли. |
Возвращаемое значение
- Тело
- Users_Result
Определения
Адрес
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
единица
|
unit | string | |
|
careOf
|
careOf | string | |
|
адресная строка1
|
addressLine1 | string | |
|
адресная строка2
|
addressLine2 | string | |
|
пригород
|
suburb | string | |
|
state
|
state | string | |
|
страна
|
country | string | |
|
почтовый индекс
|
postCode | string |
Client
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
code
|
code | string | |
|
приветствие
|
salutation | string | |
|
имя
|
name | string | |
|
firstName
|
firstName | string | |
|
второе имя
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName;
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
подразделение
|
division | Division | |
|
entityType
|
entityType | string | |
|
Партнер
|
partner | Staff | |
|
руководитель
|
manager | Staff | |
|
contacts
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
Abn
|
abn | string | |
|
tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
статус
|
status | string | |
|
group
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мюбид
|
debtorid | integer | |
|
имя_должника
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
code
|
code | string | |
|
приветствие
|
salutation | string | |
|
имя
|
name | string | |
|
firstName
|
firstName | string | |
|
второе имя
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName;
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
подразделение
|
division | Division | |
|
entityType
|
entityType | string | |
|
Партнер
|
partner | Staff | |
|
руководитель
|
manager | Staff | |
|
contacts
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
Cna
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string | |
|
Wip
|
wip | string | |
|
location
|
location | string | |
|
статус
|
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
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
client
|
client | array of ClientDetails |
ClientSummary
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
имя
|
name | string |
Client_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
Разбивка на страницы
|
pagination | Pagination |
Контакт
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
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
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
приветствие
|
salutation | string | |
|
firstName
|
firstName | string | |
|
второе имя
|
middleName | string | |
|
lastName
|
lastName | string | |
|
гендер
|
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 | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
имя
|
name | string | |
|
location
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
contacts
|
contacts | array of ContactEntity | |
|
Разбивка на страницы
|
pagination | Pagination |
CustomField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
ДебиторКлиент
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
имя
|
name | string |
Подразделение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
имя
|
name | string |
DivisionWithDetails
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
имя
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
Дата последнего изменения
|
lastModifiedAt | string |
Divisionext
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
имя
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
Дата последнего изменения
|
lastModifiedAt | string | |
|
последние изменения внесены
|
lastModifiedBy | string | |
|
создано
|
created | string |
Divisions_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Подразделений
|
divisions | array of Divisionext | |
|
Разбивка на страницы
|
pagination | Pagination |
Адрес электронной почты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string | |
|
email
|
string | ||
|
любимый
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Group
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
code
|
code | string | |
|
имя
|
name | string |
Участник группы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
имя
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
Разбивка на страницы
|
pagination | Pagination |
InvoiceDetails
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
number
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
должный
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
уплата
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
равновесие
|
balance | double | |
|
статус
|
status | string | |
|
debtorClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
debtorClientName
|
debtorClientName | string | |
|
debtorBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
Задания счетов
|
invoiceJobs | array of JobInvoice | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string |
Строки счета
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
lineNumber
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
имя
|
name | string | |
|
Wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Партнер
|
partner | Staff | |
|
руководитель
|
manager | Staff | |
|
подразделение
|
division | DivisionWithDetails | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string | |
|
debtorClient
|
debtorClient | string | |
|
счет-фактура
|
invoiceid | integer |
JobPriorityValues
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
JobTemplate
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
описание
|
description | string | |
|
estimateType
|
estimateType | string | |
|
Поворот
|
turnaround | integer | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string |
Тип работы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
описание
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string |
JobTypeStatus
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
имя
|
name | string | |
|
priority
|
priority | string | |
|
dueDate
|
dueDate | string | |
|
предполагаемое время
|
estimatedTime | double | |
|
Wip
|
wip | double | |
|
client
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
Партнер
|
partner | Staff | |
|
руководитель
|
manager | Staff | |
|
подразделение
|
division | DivisionWithDetails | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string | |
|
debtorClient
|
debtorClient | DebtorClient | |
|
статус
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
TotalTask
|
totalTask | integer | |
|
tasks
|
tasks | array of TaskDetail | |
|
Назначенных
|
assignees | array of UserDetail | |
|
команда
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
Разбивка на страницы
|
pagination | Pagination |
Pagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
всего_записей
|
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 |
Телефон
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | string | |
|
number
|
number | string | |
|
любимый
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Связь
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
entityId
|
entityId | string | |
|
имя
|
name | string | |
|
Объект
|
entity | string | |
|
startDate
|
startDate | string | |
|
Дата окончания
|
endDate | string | |
|
Единиц
|
units | integer |
Relationships_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
Разбивка на страницы
|
pagination | Pagination |
Персонал
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string | |
|
имя
|
name | string | |
|
email
|
string |
TaskDetail
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | integer | |
|
имя
|
name | string |
Teams
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
имя
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string | |
|
имя
|
name | string |
UsersWithDetails
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string | |
|
имя
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
address
|
address | Address | |
|
создано
|
created | string | |
|
последнееИзменение
|
lastModified | string |
Users_Result
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
Разбивка на страницы
|
pagination | Pagination |