KC (预览版)
KC 实践管理使用户能够安全地访问客户端和业务数据,使用户能够通过自动化工作流高效地检索和管理信息。
此连接器在以下产品和区域中可用:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域: - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(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 实践管理
概述
这提供对 Kloud Connect 实践管理 API 的访问权限。
Features
- 列出客户端
- 创建客户端
- 联系人列表
- 创建联系人
- 列出发票
- 创建时间表
- 列出任务
- 创建任务
- 列出作业
- 创造就业机会
- 访问实践管理数据
Authentication
OAuth 2.0 通过 Kloud Connect Identity Server
支持
support@kloudconnect.com.au
操作
| 列出不可计费的时间类型 |
返回可用的不可计费时间表类型。 |
| 列出作业 |
返回工作流作业的分页列表。 |
| 列出作业优先级 |
返回可用的工作流作业优先级。 |
| 列出作业模板 |
返回可用的工作流作业模板。 |
| 列出作业类型 |
返回可用的工作流作业类型。 |
| 列出作业类型状态 |
返回可用的工作流作业类型状态。 |
| 列出划分 |
返回分页列表。 |
| 列出发票 |
返回分页的发票列表。 |
| 列出团队 |
返回可用的团队。 |
| 列出客户端 |
返回客户端的分页列表。 |
| 列出客户端关系 |
返回客户端关系的分页列表。 |
| 列出客户端标记 |
返回可用的客户端标记。 |
| 列出用户 |
返回分页的用户列表。 |
| 列出联系人 |
返回分页的联系人列表。 |
| 创建作业 |
创建工作流作业。 |
| 创建客户端 |
创建客户端。 |
| 创建客户端组 |
创建客户端组。 |
| 按 ID 更新客户端 |
按 ID 更新客户端。 |
| 按 ID 获取客户端 |
按 ID 返回客户端的详细信息。 |
| 按上下文获取自定义字段 |
返回指定上下文的自定义字段。 |
| 日志时间 |
创建时间表时间条目。 |
| 更新作业 |
按 ID 更新工作流作业。 |
| 更新作业状态和优先级 |
更新工作流作业的状态和优先级。 |
| 更新客户端组 |
按组代码更新客户端组。 |
| 更新联系人 |
按 ID 更新联系人。 |
| 获取债务客户映射 |
返回客户的债务客户映射。 |
| 获取客户端组 |
获取客户端组 |
列出不可计费的时间类型
返回可用的不可计费时间表类型。
列出作业
返回工作流作业的分页列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每个页面要返回的作业数。 |
|
|
合作伙伴 ID
|
partnerId | string |
按合作伙伴标识符筛选作业。 |
|
|
客户端名称
|
clientName | string |
按客户端名称筛选作业。 |
|
|
客户端代码
|
clientcode | string |
按客户端代码筛选作业。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳上或之后修改的作业。 |
|
|
借方客户端
|
isDebitClient | boolean |
按借方客户端标志筛选作业。 |
|
|
自定义字段
|
isCustomField | boolean |
在作业结果中包含自定义字段。 |
返回
- Body
- Jobs_Result
列出作业优先级
列出作业模板
列出作业类型
列出作业类型状态
列出划分
返回分页列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每页要返回的除数。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳上或之后修改的除法。 |
返回
- Body
- Divisions_Result
列出发票
返回分页的发票列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每页要返回的发票数。 |
|
|
草稿发票
|
isDraftInvoice | boolean |
按草稿发票标志筛选发票。 |
|
|
包括发票详细信息
|
includeInvoiceDetails | boolean |
在响应中包含发票详细信息记录。 |
|
|
地位
|
status | string |
按状态筛选发票。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳上或之后修改的发票。 |
|
|
借方客户端
|
isDebitClient | boolean |
按借方客户端标志筛选发票。 |
|
|
客户端名称
|
clientname | string |
按客户端名称筛选发票。 |
|
|
客户端代码
|
clientcode | string |
按客户端代码筛选发票。 |
|
|
作业名称
|
jobname | string |
按作业名称筛选发票。 |
|
|
作业代码
|
jobcode | string |
按作业代码筛选发票。 |
|
|
计费实体 ID
|
billingEntityId | string |
按计费实体标识符筛选发票。 |
返回
- Body
- InvoiceDetail_Result
列出团队
列出客户端
返回客户端的分页列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码(基于 1)。 |
|
|
页面大小
|
pageSize | integer |
每页的项目数。 |
|
|
合作伙伴 ID
|
partnerId | string |
按合作伙伴标识符进行筛选。 |
|
|
借方客户端
|
isDebitClient | boolean |
按借方客户端标志进行筛选。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳(ISO 8601)后修改的客户端。 |
|
|
组代码
|
groupCode | string |
按组代码进行筛选。 |
|
|
客户端 ID
|
clientId | integer |
按客户端 ID 进行筛选。 |
|
|
自定义字段
|
isCustomField | boolean |
包括自定义字段。 |
返回
- Body
- Client_Result
列出客户端关系
返回客户端关系的分页列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
客户端 ID
|
clientId | True | integer |
客户端标识符。 |
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每页要返回的关系数。 |
返回
- Body
- Relationships_Result
列出客户端标记
返回可用的客户端标记。
列出用户
返回分页的用户列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每页要返回的用户数。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳上或之后修改的用户。 |
|
|
角色名称
|
rolename | string |
按角色名称筛选用户。 |
返回
- Body
- Users_Result
列出联系人
返回分页的联系人列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
page | integer |
结果页码。 |
|
|
页面大小
|
pageSize | integer |
每页要返回的联系人数。 |
|
|
修改自
|
modifiedSince | string |
返回在此时间戳上或之后修改的联系人。 |
|
|
联系人 ID
|
contactId | integer |
按联系人标识符筛选联系人。 |
|
|
客户端 ID 筛选器
|
isClientId | boolean |
指示是否应将联系人 ID 筛选器视为客户端 ID。 |
|
|
自定义字段
|
isCustomField | boolean |
在联系人结果中包含自定义字段。 |
返回
- Body
- Contact_Result
创建作业
创建工作流作业。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
hierarchyclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
作业名称
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
合作伙伴 ID
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
截止日期
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
优先级
|
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 | string | ||
|
partnershipName
|
partnershipName | string | ||
|
smsfName
|
smsfName | string | ||
|
softwareType
|
softwareType | string | ||
|
softwareName
|
softwareName | string | ||
|
合作伙伴 ID
|
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 | string | ||
|
电子邮件
|
string | |||
|
喜欢
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
类型
|
type | string | ||
|
数字
|
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 | ||
|
addressLine1
|
addressLine1 | string | ||
|
地址行 2
|
addressLine2 | string | ||
|
郊区
|
suburb | string | ||
|
状态
|
state | string | ||
|
国家
|
country | string | ||
|
邮政编码
|
postCode | string | ||
|
行业
|
industry | string | ||
|
角色
|
role | string | ||
|
工资
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
荷兰
|
abn | integer | ||
|
可以
|
acn | integer | ||
|
喧嚣
|
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
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
创建客户端组
创建客户端组。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
groupName
|
groupName | string | ||
|
合作伙伴 ID
|
partnerId | string | ||
|
标记
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
按 ID 更新客户端
按 ID 更新客户端。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
客户端 ID
|
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 | string | ||
|
partnershipName
|
partnershipName | string | ||
|
smsfName
|
smsfName | string | ||
|
softwareType
|
softwareType | string | ||
|
softwareName
|
softwareName | string | ||
|
合作伙伴 ID
|
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 | string | ||
|
电子邮件
|
string | |||
|
喜欢
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
类型
|
type | string | ||
|
数字
|
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 | ||
|
addressLine1
|
addressLine1 | string | ||
|
地址行 2
|
addressLine2 | string | ||
|
郊区
|
suburb | string | ||
|
状态
|
state | string | ||
|
国家
|
country | string | ||
|
邮政编码
|
postCode | string | ||
|
行业
|
industry | string | ||
|
角色
|
role | string | ||
|
工资
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
tfn
|
tfn | integer | ||
|
荷兰
|
abn | integer | ||
|
可以
|
acn | integer | ||
|
喧嚣
|
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
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
按 ID 获取客户端
按 ID 返回客户端的详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
客户端 ID
|
clientId | True | integer |
客户端标识符。 |
|
自定义字段
|
isCustomField | boolean |
包括自定义字段。 |
返回
- Body
- ClientDetails_Result
按上下文获取自定义字段
返回指定上下文的自定义字段。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
背景
|
context | True | string |
自定义字段上下文。 |
日志时间
创建时间表时间条目。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
单位
|
units | double | ||
|
开始时间
|
starttime | string | ||
|
率
|
rate | double | ||
|
描述
|
description | string |
更新作业
按 ID 更新工作流作业。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
职位编号
|
jobId | True | integer |
工作流作业标识符。 |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
hierarchyclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
作业名称
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
合作伙伴 ID
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
截止日期
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
优先级
|
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 |
更新作业状态和优先级
更新工作流作业的状态和优先级。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
优先级
|
priority | string | ||
|
状态
|
status | string | ||
|
statusOwner
|
statusOwner | string |
更新客户端组
按组代码更新客户端组。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组代码
|
groupCode | True | string |
客户端组代码。 |
|
groupName
|
groupName | string | ||
|
合作伙伴 ID
|
partnerId | string | ||
|
标记
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
更新联系人
按 ID 更新联系人。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
联系人 ID
|
contactId | True | integer |
联系人标识符。 |
|
称呼
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
中间名
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
性别
|
gender | string | ||
|
类型
|
type | string | ||
|
数字
|
number | string | ||
|
喜欢
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
类型
|
type | string | ||
|
电子邮件
|
string | |||
|
喜欢
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
companyName
|
companyName | string | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
preferredName
|
preferredName | string | ||
|
喧嚣
|
din | string | ||
|
dateOfBirth
|
dateOfBirth | date-time | ||
|
isImportent
|
isImportent | boolean | ||
|
addressType
|
addressType | string | ||
|
单位
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
地址行 2
|
addressLine2 | string | ||
|
郊区
|
suburb | string | ||
|
状态
|
state | string | ||
|
国家
|
country | string | ||
|
邮政编码
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
获取债务客户映射
获取客户端组
获取客户端组
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Page
|
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 |
|
标记
|
clientGroups.tags | array of |
标记 |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
实体类型 (entityType)
|
clientGroups.clients.entityType | string |
实体类型 (entityType) |
|
clientname
|
clientGroups.clients.clientname | string |
clientname |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
hierarchyClientId
|
clientGroups.clients.debtorClientId | integer |
hierarchyClientId |
|
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 |
定义
地址
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
单位
|
unit | string | |
|
careOf
|
careOf | string | |
|
addressLine1
|
addressLine1 | string | |
|
地址行 2
|
addressLine2 | string | |
|
郊区
|
suburb | string | |
|
状态
|
state | string | |
|
国家
|
country | string | |
|
邮政编码
|
postCode | string |
Client
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string | |
|
称呼
|
salutation | string | |
|
名字
|
name | string | |
|
firstName
|
firstName | string | |
|
中间名
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
电子邮件
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
划分
|
division | Division | |
|
实体类型 (entityType)
|
entityType | string | |
|
合作伙伴
|
partner | Staff | |
|
管理员
|
manager | Staff | |
|
联系人
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
可以
|
acn | string | |
|
荷兰
|
abn | string | |
|
tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
已创建
|
created | string | |
|
上次修改
|
lastModified | string | |
|
wip
|
wip | string | |
|
位置
|
location | string | |
|
状态
|
status | string | |
|
组
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
hierarchyid
|
debtorid | integer | |
|
debtorname
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string | |
|
称呼
|
salutation | string | |
|
名字
|
name | string | |
|
firstName
|
firstName | string | |
|
中间名
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
电子邮件
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
划分
|
division | Division | |
|
实体类型 (entityType)
|
entityType | string | |
|
合作伙伴
|
partner | Staff | |
|
管理员
|
manager | Staff | |
|
联系人
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
可以
|
acn | string | |
|
荷兰
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
已创建
|
created | string | |
|
上次修改
|
lastModified | string | |
|
wip
|
wip | string | |
|
位置
|
location | string | |
|
状态
|
status | string | |
|
组
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField | |
|
喧嚣
|
din | string | |
|
tfn
|
tfn | string | |
|
bankName
|
bankName | string | |
|
bankAccountName
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
bankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
客户端
|
client | array of ClientDetails |
ClientSummary
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
代码
|
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 | |
|
电子邮件
|
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 | |
|
电子邮件
|
array of Email | ||
|
companyName
|
companyName | string | |
|
placeOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
喧嚣
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
已创建
|
created | string | |
|
上次修改
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
名字
|
name | string | |
|
位置
|
location | string | |
|
上下文
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
联系人
|
contacts | array of ContactEntity | |
|
分页
|
pagination | Pagination |
CustomField
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
DebtorClient
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
代码
|
code | string | |
|
名字
|
name | string |
除法
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
名字
|
name | string |
DivisionWithDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
名字
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string |
Divisionext
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
名字
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string | |
|
lastModifiedBy
|
lastModifiedBy | string | |
|
已创建
|
created | string |
Divisions_Result
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
部门
|
divisions | array of Divisionext | |
|
分页
|
pagination | Pagination |
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
类型
|
type | string | |
|
电子邮件
|
string | ||
|
喜欢
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
组
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
代码
|
code | string | |
|
名字
|
name | string |
小组成员
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
名字
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
发票
|
invoices | array of InvoiceDetails | |
|
分页
|
pagination | Pagination |
InvoiceDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
数字
|
number | string | |
|
refNo
|
refNo | string | |
|
类型
|
type | string | |
|
date
|
date | string | |
|
由于
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
付款
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
余额
|
balance | double | |
|
状态
|
status | string | |
|
hierarchyClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
debtorClientName
|
debtorClientName | string | |
|
debtorBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
已创建
|
created | string | |
|
上次修改
|
lastModified | string |
InvoiceLines
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
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 | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
合作伙伴
|
partner | Staff | |
|
管理员
|
manager | Staff | |
|
划分
|
division | DivisionWithDetails | |
|
已创建
|
created | string | |
|
上次修改
|
lastModified | string | |
|
debtorClient
|
debtorClient | string | |
|
invoiceid
|
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 | |
|
类别ID
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
名字
|
name | string | |
|
优先级
|
priority | string | |
|
截止日期
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
Wip
|
wip | double | |
|
客户端
|
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 | array of TaskDetail | |
|
assignees
|
assignees | array of UserDetail | |
|
团队
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
分页
|
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 | string | |
|
数字
|
number | string | |
|
喜欢
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
关系
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
类型
|
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 | |
|
电子邮件
|
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 | |
|
电子邮件
|
|||
|
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 |