KC (プレビュー)
KC プラクティス管理を使用すると、クライアントとビジネス データへの安全なアクセスが可能になり、ユーザーは自動化されたワークフローを使用して情報を効率的に取得および管理できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | Regions |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate(パワーオートメート) | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| 連絡先 | |
|---|---|
| 名前 | クロウド接続のサポート |
| URL | https://www.kloudconnect.com.au/ |
| support@kloudconnect.com.au |
| コネクタ メタデータ | |
|---|---|
| パブリッシャー | クロウド接続 |
| Web サイト | https://www.kloudconnect.com.au/ |
| プライバシー ポリシー | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| カテゴリ | ビジネス管理;金融 |
Kloud Connect のプラクティス管理
Overview
これにより、クロウド Connect プラクティス管理 API へのアクセスが提供されます。
特徴
- クライアントを一覧表示する
- クライアントの作成
- 連絡先を一覧表示する
- 連絡先の作成
- 請求書を一覧表示する
- タイムシートの作成
- タスクの一覧表示
- タスクの作成
- ジョブのリスト
- 仕事を作る
- プラクティス管理データにアクセスする
Authentication
Loud Connect Identity Server 経由の OAuth 2.0
Support
support@kloudconnect.com.au
アクション
| ID でクライアントを取得する |
ID でクライアントの詳細を返します。 |
| ID でクライアントを更新する |
ID でクライアントを更新します。 |
| クライアント グループを作成する |
クライアント グループを作成します。 |
| クライアント グループを取得する |
クライアント グループを取得する |
| クライアント グループを更新する |
グループ コードによってクライアント グループを更新します。 |
| クライアント タグを一覧表示する |
使用可能なクライアント タグを返します。 |
| クライアントのリレーションシップを一覧表示する |
クライアントリレーションシップのページングされたリストを返します。 |
| クライアントの作成 |
クライアントを作成します。 |
| クライアントを一覧表示する |
クライアントのページングされたリストを返します。 |
| コンテキスト別にユーザー設定フィールドを取得する |
指定したコンテキストのユーザー設定フィールドを返します。 |
| ジョブ テンプレートを一覧表示する |
使用可能なワークフロー ジョブ テンプレートを返します。 |
| ジョブの優先順位を一覧表示する |
使用可能なワークフロー ジョブの優先順位を返します。 |
| ジョブの状態と優先度を更新する |
ワークフロー ジョブの状態と優先度を更新します。 |
| ジョブの種類の状態を一覧表示する |
使用可能なワークフロー ジョブの種類の状態を返します。 |
| ジョブの種類を一覧表示する |
使用可能なワークフロー ジョブの種類を返します。 |
| ジョブを一覧表示する |
ワークフロー ジョブのページングされた一覧を返します。 |
| ジョブを作成する |
ワークフロー ジョブを作成します。 |
| ジョブを更新する |
ID でワークフロー ジョブを更新します。 |
| チームの一覧表示 |
利用可能なチームを返します。 |
| ユーザーを一覧表示する |
ユーザーのページングされた一覧を返します。 |
| ログ時間 |
タイムシートの時刻エントリを作成します。 |
| 債務者クライアント マッピングを取得する |
クライアントの債務者クライアント マッピングを返します。 |
| 区分を一覧表示する |
区分のページングされたリストを返します。 |
| 課金対象外の時間の種類を一覧表示する |
利用可能な課金対象外のタイムシートの種類を返します。 |
| 請求書を一覧表示する |
請求書のページングされた一覧を返します。 |
| 連絡先を一覧表示する |
連絡先のページングされたリストを返します。 |
| 連絡先を更新する |
ID で連絡先を更新します。 |
ID でクライアントを取得する
ID でクライアントの詳細を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント ID
|
clientId | True | integer |
Client identifier. (クライアント識別子。) |
|
カスタム フィールド
|
isCustomField | boolean |
ユーザー設定フィールドを含めます。 |
返品
- Body
- ClientDetails_Result
ID でクライアントを更新する
ID でクライアントを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント ID
|
clientId | True | integer |
Client identifier. (クライアント識別子。) |
|
エンティティタイプ
|
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
|
number | string | ||
|
お気に入り
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
Web サイト
|
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 | string | ||
|
country
|
country | string | ||
|
郵便 番号
|
postCode | string | ||
|
業界
|
industry | string | ||
|
ロール
|
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 | 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
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
Contactid
|
contactId | integer |
クライアント グループを取得する
クライアント グループを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
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 |
|
エンティティタイプ
|
clientGroups.clients.entityType | string |
エンティティタイプ |
|
Clientname
|
clientGroups.clients.clientname | string |
Clientname |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
debtorClientId
|
clientGroups.clients.debtorClientId | integer |
debtorClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
created
|
clientGroups.created | string |
created |
|
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 |
|
総ページ数
|
pagination.total_pages | integer |
総ページ数 |
|
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 |
クライアント グループを更新する
グループ コードによってクライアント グループを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ コード
|
groupCode | True | string |
クライアント グループ コード。 |
|
groupName
|
groupName | string | ||
|
パートナーID
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
Contactid
|
contactId | integer |
クライアント タグを一覧表示する
使用可能なクライアント タグを返します。
クライアントのリレーションシップを一覧表示する
クライアントリレーションシップのページングされたリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント ID
|
clientId | True | integer |
Client identifier. (クライアント識別子。) |
|
ページ
|
page | integer |
結果ページ番号。 |
|
|
ページ サイズ
|
pageSize | integer |
ページごとに返されるリレーションシップの数。 |
返品
- Body
- Relationships_Result
クライアントの作成
クライアントを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エンティティタイプ
|
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
|
number | string | ||
|
お気に入り
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
Web サイト
|
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 | string | ||
|
country
|
country | string | ||
|
郵便 番号
|
postCode | string | ||
|
業界
|
industry | string | ||
|
ロール
|
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 | 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 |
クライアントを一覧表示する
クライアントのページングされたリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
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
コンテキスト別にユーザー設定フィールドを取得する
指定したコンテキストのユーザー設定フィールドを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Context
|
context | True | string |
ユーザー設定フィールド コンテキスト。 |
ジョブ テンプレートを一覧表示する
ジョブの優先順位を一覧表示する
ジョブの状態と優先度を更新する
ワークフロー ジョブの状態と優先度を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
priority
|
priority | string | ||
|
状態
|
status | string | ||
|
statusOwner
|
statusOwner | string |
ジョブの種類の状態を一覧表示する
ジョブの種類を一覧表示する
ジョブを一覧表示する
ワークフロー ジョブのページングされた一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果ページ番号。 |
|
|
ページ サイズ
|
pageSize | integer |
1 ページあたりに返されるジョブの数。 |
|
|
パートナー ID
|
partnerId | string |
パートナー識別子でジョブをフィルター処理します。 |
|
|
クライアント名
|
clientName | string |
クライアント名でジョブをフィルター処理します。 |
|
|
クライアント コード
|
clientcode | string |
クライアント コードでジョブをフィルター処理します。 |
|
|
以降に変更されました
|
modifiedSince | string |
このタイムスタンプ以降に変更されたジョブを返します。 |
|
|
デビット クライアント
|
isDebitClient | boolean |
デビット クライアント フラグでジョブをフィルター処理します。 |
|
|
カスタム フィールド
|
isCustomField | boolean |
ジョブの結果にユーザー設定フィールドを含めます。 |
返品
- Body
- Jobs_Result
ジョブを作成する
ワークフロー ジョブを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debtorclientId
|
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
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
識別子
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
ジョブを更新する
ID でワークフロー ジョブを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
職務 ID
|
jobId | True | integer |
ワークフロー ジョブ識別子。 |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
debtorclientId
|
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
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
priority
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
識別子
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
チームの一覧表示
ユーザーを一覧表示する
ユーザーのページングされた一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果ページ番号。 |
|
|
ページ サイズ
|
pageSize | integer |
1 ページあたりに返すユーザーの数。 |
|
|
以降に変更されました
|
modifiedSince | string |
このタイムスタンプ以降に変更されたユーザーを返します。 |
|
|
役割名
|
rolename | string |
ロール名でユーザーをフィルター処理します。 |
返品
- Body
- Users_Result
ログ時間
タイムシートの時刻エントリを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
Taskid
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
単位
|
units | double | ||
|
開始時間
|
starttime | string | ||
|
率
|
rate | double | ||
|
description
|
description | string |
債務者クライアント マッピングを取得する
クライアントの債務者クライアント マッピングを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント ID
|
clientId | True | integer |
Client identifier. (クライアント識別子。) |
返品
- Body
- ClientDebtor
区分を一覧表示する
区分のページングされたリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果ページ番号。 |
|
|
ページ サイズ
|
pageSize | integer |
ページごとに返される分割の数。 |
|
|
以降に変更されました
|
modifiedSince | string |
このタイムスタンプ以降に変更された部分を返します。 |
返品
- Body
- Divisions_Result
課金対象外の時間の種類を一覧表示する
利用可能な課金対象外のタイムシートの種類を返します。
請求書を一覧表示する
請求書のページングされた一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
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 | integer |
結果ページ番号。 |
|
|
ページ サイズ
|
pageSize | integer |
ページごとに返される連絡先の数。 |
|
|
以降に変更されました
|
modifiedSince | string |
このタイムスタンプ以降に変更された連絡先を返します。 |
|
|
コンタクトID
|
contactId | integer |
連絡先識別子で連絡先をフィルター処理します。 |
|
|
クライアント ID フィルター
|
isClientId | boolean |
連絡先 ID フィルターをクライアント ID として扱う必要があるかどうかを示します。 |
|
|
カスタム フィールド
|
isCustomField | boolean |
連絡先の結果にユーザー設定フィールドを含めます。 |
返品
- Body
- Contact_Result
連絡先を更新する
ID で連絡先を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンタクトID
|
contactId | True | integer |
連絡先識別子。 |
|
挨拶
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
ミドルネーム
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
ジェンダー
|
gender | string | ||
|
型
|
type | string | ||
|
number
|
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
|
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 | string | ||
|
country
|
country | string | ||
|
郵便 番号
|
postCode | string | ||
|
識別子
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
定義
アドレス
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
ユニット
|
unit | string | |
|
careOf
|
careOf | string | |
|
アドレスライン1
|
addressLine1 | string | |
|
アドレスライン2
|
addressLine2 | string | |
|
郊外
|
suburb | string | |
|
状態
|
state | string | |
|
country
|
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 | Division | |
|
エンティティタイプ
|
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
|
created | string | |
|
最終更新
|
lastModified | string | |
|
仕掛品
|
wip | string | |
|
位置
|
location | string | |
|
状態
|
status | string | |
|
グループ
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
識別子
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
debtorid
|
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 | Division | |
|
エンティティタイプ
|
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
|
created | string | |
|
最終更新
|
lastModified | string | |
|
仕掛品
|
wip | string | |
|
位置
|
location | string | |
|
状態
|
status | string | |
|
グループ
|
group | Group | |
|
debtorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
識別子
|
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 | array of ClientDetails |
ClientSummary
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
コード
|
code | string | |
|
名前
|
name | string |
Client_Result
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
改ページ位置の自動修正
|
pagination | Pagination |
連絡先
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
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
|
din | string | |
|
Contactid
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
名前
|
name | string | |
|
位置
|
location | string | |
|
コンテキスト
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
contacts
|
contacts | array of ContactEntity | |
|
改ページ位置の自動修正
|
pagination | Pagination |
CustomField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
value
|
value | string |
DebtorClient
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
コード
|
code | string | |
|
名前
|
name | string |
部門
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
名前
|
name | string |
DivisionWithDetails
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
名前
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
最終変更日時
|
lastModifiedAt | string |
Divisionext
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
名前
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
最終変更日時
|
lastModifiedAt | string | |
|
最終更新者
|
lastModifiedBy | string | |
|
created
|
created | string |
Divisions_Result
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
部門
|
divisions | array of Divisionext | |
|
改ページ位置の自動修正
|
pagination | Pagination |
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
type | string | |
|
メール
|
string | ||
|
お気に入り
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
グループ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
コード
|
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 | integer | |
|
number
|
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 | |
|
debtorClientId
|
debtorClientId | integer | |
|
debtorClientCode
|
debtorClientCode | string | |
|
debtorClientName
|
debtorClientName | string | |
|
debtorBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string |
請求書明細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
lineNumber
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
Linetotal
|
lineTotal | double |
JobInvoice
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
名前
|
name | string | |
|
wip
|
wip | double | |
|
クライアント
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
パートナー
|
partner | Staff | |
|
マネージャー
|
manager | Staff | |
|
division
|
division | DivisionWithDetails | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string | |
|
debtorClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
ジョブテンプレート
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
ターンアラウンド
|
turnaround | integer | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string |
職種
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string |
JobTypeStatus
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
CategoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
名前
|
name | string | |
|
priority
|
priority | string | |
|
dueDate
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
wip
|
wip | double | |
|
クライアント
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
パートナー
|
partner | Staff | |
|
マネージャー
|
manager | Staff | |
|
division
|
division | DivisionWithDetails | |
|
created
|
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 |
ページネーション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
総レコード数
|
total_records | integer | |
|
current_page
|
current_page | integer | |
|
page_Size
|
page_Size | integer | |
|
総ページ数
|
total_pages | integer | |
|
next_page
|
next_page | integer | |
|
next_pageurl
|
next_pageurl | string | |
|
prev_page
|
prev_page | integer | |
|
prev_pageurl
|
prev_pageurl | string |
Phone
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
type | string | |
|
number
|
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 | string | |
|
名前
|
name | string | |
|
メール
|
string |
TaskDetail
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer | |
|
名前
|
name | string |
Teams
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
名前
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | string | |
|
名前
|
name | string |
UsersWithDetails
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | string | |
|
名前
|
name | string | |
|
roleName
|
roleName | string | |
|
メール
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
address
|
address | Address | |
|
created
|
created | string | |
|
最終更新
|
lastModified | string |
Users_Result
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
改ページ位置の自動修正
|
pagination | Pagination |