次の方法で共有


HubSpot CRM V2 (Independent Publisher) (プレビュー)

使いやすい HubSpot CRM を使用すると、レポートを手動で更新したり、チームがクォータに向けてどのように追跡しているか疑問に思う必要がなくなります。 ビジュアル ダッシュボードに営業パイプライン全体をリアルタイムで表示します。 HubSpot CRM は、各取引先担当者を整理されたタイムラインで自動的に整理し、エンリッチして追跡します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://www.hubspot.com/products/crm
プライバシー ポリシー 時https://legal.hubspot.com/privacy-policy
カテゴリー 販売と CRM

接続を作成する

このコネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ Description Required
アクセス トークン ('Bearer ${YOUR_TOKEN}' 形式) securestring この API のアクセス トークン ('Bearer ${YOUR_TOKEN}' 形式) True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

2 つのオブジェクトをマージする

同じタイプの 2 つのオブジェクトをマージします。

2 つのチケットをマージする

同じタイプの 2 つのチケットをマージします。

2 つのフィードバック送信をマージする

同じタイプの 2 つのフィードバック送信をマージします。

2 つの会社をマージする

同じ種類の 2 つの会社をマージします。

2 つの割引をマージする

同じタイプの 2 つの割引をマージします。

2 つの取引をマージする

同じタイプの 2 つの取引をマージします。

2 つの取引先担当者をマージする

同じタイプの 2 つの取引先担当者をマージします。

2 つの品目をマージする

同じタイプの 2 つの品目をマージします。

2 つの料金をマージする

同じタイプの 2 つの料金をマージします。

2 つの目標対象をマージする

同じタイプの 2 つの目標対象をマージします。

2 つの税をマージする

同じタイプの 2 つの税をマージします。

2 つの製品をマージする

同じタイプの 2 つの製品をマージします。

2 つの見積もりをマージする

同じタイプの 2 つの見積もりをマージします。

GDPR に従うためにオブジェクト タイプを削除する

GDPR に従うために、取引先担当者および関連するすべてのオブジェクト タイプを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うためにチケットを削除する

GDPR に従うために、チケットおよび関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うためにフィードバック送信を削除する

GDPR に従うために、フィードバック送信および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために会社を削除する

GDPR に従うために、会社および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために割引を削除する

GDPR に従うために、割引および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために取引を削除する

GDPR に従うために、取引および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために取引先担当者を削除する

GDPR に従うために、取引先担当者および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために品目を削除する

GDPR に従うために、品目および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために料金を削除する

GDPR に従うために、料金および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために目標対象を削除する

GDPR に従うために、目標対象および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために税を削除する

GDPR に従うために、税および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために製品を削除する

GDPR に従うために製品および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

GDPR に従うために見積もりを削除する

GDPR に従うために、見積もりおよび関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

ID でオブジェクトのバッチをアーカイブする

識別子でオブジェクトのバッチをアーカイブします。

ID でオブジェクトのバッチを取得する

内部識別子または一意のプロパティ値でオブジェクトのバッチを取得します。

ID でオブジェクトを取得する

objectidentifier で識別されるオブジェクトを取得します。 objectId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID でチケットのバッチをアーカイブする

識別子でチケットのバッチをアーカイブします。

ID でチケットのバッチを取得する

内部識別子または一意のプロパティ値でチケットのバッチを取得します。

ID でフィードバック送信のバッチをアーカイブする

識別子でフィードバック送信のバッチをアーカイブします。

ID でフィードバック送信のバッチを取得する

内部識別子または一意のプロパティ値でフィードバック送信のバッチを取得します。

ID で会社のバッチをアーカイブする

識別子で会社のバッチをアーカイブします。

ID で会社をアーカイブする

companyId で識別したオブジェクトをごみ箱に移動します。

ID で会社を取得する

companyidentifier で識別されるオブジェクトを取得します。 companyId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID で会社を取得する

内部識別子または一意のプロパティ値で会社のバッチを取得します。

ID で会社を更新する

companyidentifier で識別されるオブジェクトの部分的な更新を実行します。 companyId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

ID で割引のバッチをアーカイブする

識別子で割引のバッチをアーカイブします。

ID で割引のバッチを取得する

内部識別子または一意のプロパティ値で割引のバッチを取得します。

ID で取引のバッチをアーカイブする

識別子で取引のバッチをアーカイブします。

ID で取引のバッチを取得する

内部識別子または一意のプロパティ値で取引のバッチを取得します。

ID で取引をアーカイブする

dealId で識別したオブジェクトをごみ箱に移動します。

ID で取引先担当者のバッチをアーカイブする

識別子で取引先担当者のバッチをアーカイブします。

ID で取引先担当者のバッチを取得する

内部識別子または一意のプロパティ値で取引先担当者のバッチを取得します。

ID で取引先担当者をアーカイブする

contactId で識別したオブジェクトをオブジェクトに移動します。

ID で取引先担当者を取得する

contactidentifier で識別されるオブジェクトを取得します。 contactId は内部オブジェクト識別子を参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID で品目のバッチをアーカイブする

識別子で品目のバッチをアーカイブします。

ID で品目のバッチを取得する

内部識別子または一意のプロパティ値で品目のバッチを取得します。

ID で所有者を取得する

指定した識別子または useridentifier で所有者を取得します。

ID で料金のバッチをアーカイブする

識別子で料金のバッチをアーカイブします。

ID で料金のバッチを取得する

内部識別子または一意のプロパティ値で料金のバッチを取得します。

ID で料金をアーカイブする

feeId で識別したオブジェクトをごみ箱に移動します。

ID で料金を取得する

feeidentifier で識別されるオブジェクトを取得します。 feeId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID で料金を更新する

feeidentifier で識別されるオブジェクトの部分的な更新を実行します。 feeId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

ID で目標対象のバッチをアーカイブする

識別子で目標対象のバッチをアーカイブします。

ID で目標対象のバッチを取得する

内部識別子または一意のプロパティ値で目標対象のバッチを取得します。

ID で目標対象を取得する

goalTargetidentifier で識別されるオブジェクトを取得します。 goalTargetId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID で税のバッチをアーカイブする

識別子で税のバッチをアーカイブします。

ID で税のバッチを取得する

内部識別子または一意のプロパティ値で税のバッチを取得します。

ID で税を取得する

taxidentifier で識別されるオブジェクトを取得します。 taxId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID で製品のバッチをアーカイブする

識別子で製品のバッチをアーカイブします。

ID で製品のバッチを取得する

内部識別子または一意のプロパティ値で製品のバッチを取得します。

ID で見積もりのバッチをアーカイブする

識別子で見積もりのバッチをアーカイブします。

ID で見積もりのバッチを取得する

内部識別子または一意のプロパティ値で見積もりのバッチを取得します。

ID で見積もりをアーカイブする

quoteId で識別したオブジェクトをごみ箱に移動します。

ID で見積もりを取得する

quoteidentifier で識別されるオブジェクトを取得します。 quoteId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

ID を指定して連絡先を更新する

contactidentifier で識別されるオブジェクトの部分的な更新を実行します。 contactId は内部オブジェクト識別子を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

すべてのカードを取得する

指定したアプリのカードの一覧を返します。

アクティブなインポートをキャンセルする

これにより、開発者はアクティブなインポートをキャンセルできます。

アクティブなインポートを取得する

この取引先企業のアクティブなインポートのページ化リストを返します。

インポート エラーを取得する

インポートのエラーのリストを取得します。

インポートに関する情報を取得する

更新を含む、インポート レコードの完全な概要。

エクスポートを開始する

要求本文で指定されるように、ポータルの CRM データのエクスポートを開始します。

オブジェクト タイプで検索する

オブジェクト タイプでオブジェクトのリストを取得します。

オブジェクトのバッチを作成する

オブジェクトのバッチを作成します。

オブジェクトのバッチを更新する

オブジェクトのバッチを更新します。

オブジェクトの関連付けの一覧を表示する

オブジェクトのすべての関連付けをオブジェクト タイプごとに一覧表示します。 1 回の呼び出しにつき 500 に制限されます。

オブジェクトをアーカイブする

objectId で識別したオブジェクトをごみ箱に移動します。

オブジェクトを作成する

指定したプロパティを使用して CRM オブジェクトを作成し、識別子を含むオブジェクトのコピーを返します。

オブジェクトを取得する

オブジェクトのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

オブジェクトを更新する

objectidentifier で識別されるオブジェクトの部分的な更新を実行します。 objectId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

カードを削除する

指定した識別子のカード定義を完全に削除します。 削除すると、このカードのデータ取り込み要求はサービスに送信されなくなります。 これは元に戻せません。

カードを取得する

指定した識別子のカードの定義を返します。

カードを更新する

新しい詳細でカード定義を更新します。

キューを検索する

キューの一覧を取得します。

サンプル カードの詳細の応答を取得する

サンプル カードの詳細の応答を返します。 これは、ユーザーに表示されるカードに表示される詳細を含むペイロードです。 アプリはデータ取り込み要求に応じてこれを送信する必要があります。

ソース リストのすべてのレコードを宛先リストに追加する

ソース リスト (sourceListId で指定されます) のすべてのレコードをデスティネーション リスト (listId で指定されます) に追加します。 すでに宛先リストのメンバーであるレコードは無視されます。 デスティネーション リスト ID とソース リスト ID は異なる必要があります。 宛先リストとソース リストには、同じ種類のレコード (取引先担当者、会社など) が含まれている必要があります。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のデスティネーション リストでのみ機能します。 ソース リストの processingType はどれでも構いません。

タスク ID のステータスを取得する

タスク識別子のステータスを取得します。

チケットのバッチを作成する

チケットのバッチを作成します。

チケットのバッチを更新する

チケットのバッチを更新します。

チケットをアーカイブする

ticketId で識別したオブジェクトをごみ箱に移動します。

チケットを作成する

指定したプロパティでチケットを作成し、識別子を含むオブジェクトのコピーを返します。

チケットを取得する

ticketidentifier で識別されるオブジェクトを取得します。 ticketId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

チケットを取得する

チケットのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

チケットを更新する

ticketidentifier で識別されるオブジェクトの部分的な更新を実行します。 ticketId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

チケットを検索する

チケットの一覧を取得します。

フィードバック送信のバッチを作成する

フィードバック送信のバッチを作成します。

フィードバック送信のバッチを更新する

フィードバック送信のバッチを更新します。

フィードバック送信の一覧を表示する

フィードバック送信のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

フィードバック送信をアーカイブする

feedbackSubmissionId で識別したオブジェクトをごみ箱に移動します。

フィードバック送信を作成する

指定したプロパティを使用してフィードバック送信を作成し、識別子を含むオブジェクトのコピーを返します。

フィードバック送信を取得する

feedbackSubmissionidentifier で識別されるオブジェクトを取得します。 feedbackSubmissionId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

フィードバック送信を更新する

feedbackSubmissionidentifier で識別されるオブジェクトの部分的な更新を実行します。 feedbackSubmissionId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

フィードバック送信を検索する

フィードバック送信の一覧を取得します。

リストからすべてのレコードを削除する

リストからすべてのレコードを削除します。 注意: リストは削除されません。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

リストにレコードを追加またはリストからレコードを削除する

システム内で既に作成されているレコードをリストに追加したり、リストから削除したりします。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

リストのメンバーシップを取り込む

リストのメンバーシップを、リスト内のレコードの recordId で並べ替えられた順序で取り込みます。 after オフセットが提供されるか、オフセットが提供されない場合は、recordId は昇順に並べ替えられます。 before オフセットが提供された場合、レコードは降順に並べ替えられます。 両方のオフセットが提供された場合、afterオフセット パラメーターが before オフセットよりも優先されます。

リストを検索する

空の query 値を指定してすべてのリストからリスト名またはページでリストを検索します。

レコードをリストから削除する

提供したレコードをリストから削除します。 存在しないレコード、またはリストのメンバーでないレコードは無視されます。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

レコードをリストに追加する

提供されたレコードをリストに追加します。 存在しないレコード、またはすでにリストのメンバーであるレコードは無視されます。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

会社のバッチを作成する

会社のバッチを作成します。

会社のバッチを更新する

会社のバッチを更新します。

会社の検索

会社の一覧を取得します。

会社を作成する

指定したプロパティで会社を作成し、識別子を含むオブジェクトのコピーを返します。

会社を取得する

会社のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

割引のバッチを作成する

割引のバッチを作成します。

割引のバッチを更新する

割引のバッチを更新します。

割引の一覧を表示する

割引のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

割引をアーカイブする

discountId で識別したオブジェクトをごみ箱に移動します。

割引を作成する

指定したプロパティを使用して割引を作成し、識別子を含むオブジェクトのコピーを返します。

割引を取得する

discountidentifier で識別されるオブジェクトを取得します。 discountId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

割引を更新する

discountidentifier で識別されるオブジェクトの部分的な更新を実行します。 discountId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

割引を検索する

割引の一覧を取得します。

取引のバッチを作成する

取引のバッチを作成します。

取引のバッチを更新する

取引のバッチを更新します。

取引を作成する

指定されたプロパティで取引を作成し、識別子を含むオブジェクトのコピーを返します。

取引を取得する

dealidentifier で識別されるオブジェクトを取得します。 dealId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

取引を取得する

取引のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

取引を更新する

dealidentifier で識別されるオブジェクトの部分的な更新を実行します。 dealId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

取引を検索する

取引の一覧を取得します。

取引先担当者のバッチを作成する

取引先担当者のバッチを作成します。

取引先担当者のバッチを更新する

取引先担当者のバッチを更新します。

取引先担当者の検索

取引先担当者のリストを取得します。

取引先担当者を取得する

取引先担当者のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

品目のバッチを作成する

品目のバッチを作成します。

品目のバッチを更新する

品目のバッチを更新します。

品目をアーカイブする

lineItemId で識別したオブジェクトをごみ箱に移動します。

品目を作成する

指定したプロパティを使用して品目を作成し、識別子を含むオブジェクトのコピーを返します。

品目を取得する

lineItemidentifier で識別されるオブジェクトを取得します。 lineItemId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

品目を取得する

品目のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

品目を更新する

lineItemidentifier で識別されるオブジェクトの部分的な更新を実行します。 lineItemId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

品目を検索する

品目の一覧を取得します。

所有者を取得する

所有者の一覧を取得します。

料金のバッチを作成する

料金のバッチを作成します。

料金のバッチを更新する

料金のバッチを更新します。

料金の検索

料金の一覧を取得します。

料金を作成する

指定されたプロパティで料金を作成し、識別子を含むオブジェクトのコピーを返します。

料金を取得する

料金のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

新しいインポートを開始する

指定されたファイル リソースからデータのインポートを開始します。 これにより、対応するファイルがアップロードされ、インポート要求オブジェクトを使用してファイル内の行がオブジェクトに変換されます。

新しいカードを作成する

このアプリがインストールされたときに取引先企業でアクティブになる新しいカードを定義します。

既定の関連付けを作成する

2 つのオブジェクト タイプ間に既定の (最も汎用的な) 関連付けタイプを作成します。

既定の関連付けを作成する

2 つのオブジェクト タイプ間に既定の (最も汎用的な) 関連付けタイプを作成します。

特定の関連付けラベルを削除する

オブジェクトの特定の関連付けラベルを一括削除します。 ラベルのない関連付けを削除すると、それらの 2 つのオブジェクト間のラベル付きの関連付けもすべて削除されます。

目標対象のバッチを作成する

目標対象のバッチを作成します。

目標対象のバッチを更新する

目標対象のバッチを更新します。

目標対象をアーカイブする

goalTargetId で識別したオブジェクトをごみ箱に移動します。

目標対象を作成する

指定したプロパティを使用して目標対象を作成し、識別子を含むオブジェクトのコピーを返します。

目標対象を取得する

目標対象のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

目標対象を更新する

goalTargetidentifier で識別されるオブジェクトの部分的な更新を実行します。 goalTargetId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

目標対象を検索する

目標対象の一覧を取得します。

税のバッチを作成する

税のバッチを作成します。

税のバッチを更新する

税のバッチを更新します。

税をアーカイブする

taxId で識別したオブジェクトをごみ箱に移動します。

税を作成する

指定されたプロパティで料金を作成し、識別子を含むオブジェクトのコピーを返します。

税を取得する

税のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

税を更新する

taxidentifier で識別されるオブジェクトの部分的な更新を実行します。 taxId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

税を検索する

税の一覧を取得します。

製品のバッチを作成する

製品のバッチを作成します。

製品のバッチを更新する

製品のバッチを更新します。

製品の検索

製品の一覧を取得します。

製品をアーカイブする

productId で識別したオブジェクトをごみ箱に移動します。

製品を作成する

指定したプロパティで製品を作成し、識別子を含むオブジェクトのコピーを返します。

製品を取得する

productidentifier で識別されるオブジェクトを取得します。 productId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

製品を取得する

製品のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

製品を更新する

productidentifier で識別されるオブジェクトの部分的な更新を実行します。 productId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

見積もりのバッチを作成する

見積もりのバッチを作成します。

見積もりのバッチを更新する

見積もりのバッチを更新します。

見積もりの作成

指定されたプロパティで見積もりを作成し、識別子を含むオブジェクトのコピーを返します。

見積もりを一覧表示する

見積もりのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

見積もりを更新する

quoteidentifier で識別されるオブジェクトの部分的な更新を実行します。 quoteId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

連絡先を作成する

指定したプロパティで取引先担当者を作成し、識別子を含むオブジェクトのコピーを返します。

関連付けをバッチ作成する

オブジェクトの関連付けをバッチ作成します。

関連付けを一括削除する

オブジェクトの関連付けを一括削除します。

関連付けを一括読み取りする

オブジェクトと特定のオブジェクト タイプの関連付けを一括読み取りします。 返されたページング オブジェクトの 'after' フィールドを 'id' の横に追加すると、その objectidentifier から関連付けの次のページを取得できます。 'link' フィールドは非推奨であるため、無視する必要があります。

関連付けを削除する

2 つのレコード間のすべての関連付けを削除します。

関連付けタイプの一覧を表示する

2 つのオブジェクト タイプ間で使用できる有効な関連付けタイプをすべて一覧表示します。

関連付けラベルを作成する

2 つのレコード間に関連付けラベルを設定します。

2 つのオブジェクトをマージする

同じタイプの 2 つのオブジェクトをマージします。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つのチケットをマージする

同じタイプの 2 つのチケットをマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つのフィードバック送信をマージする

同じタイプの 2 つのフィードバック送信をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの会社をマージする

同じ種類の 2 つの会社をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの割引をマージする

同じタイプの 2 つの割引をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの取引をマージする

同じタイプの 2 つの取引をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの取引先担当者をマージする

同じタイプの 2 つの取引先担当者をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの品目をマージする

同じタイプの 2 つの品目をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの料金をマージする

同じタイプの 2 つの料金をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの目標対象をマージする

同じタイプの 2 つの目標対象をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの税をマージする

同じタイプの 2 つの税をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの製品をマージする

同じタイプの 2 つの製品をマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

2 つの見積もりをマージする

同じタイプの 2 つの見積もりをマージします。

パラメーター

名前 キー 必須 説明
マージするオブジェクト識別子
objectIdToMerge string

マージするオブジェクト識別子。

プライマリ オブジェクト ID
primaryObjectId string

プライマリ オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

GDPR に従うためにオブジェクト タイプを削除する

GDPR に従うために、取引先担当者および関連するすべてのオブジェクト タイプを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うためにチケットを削除する

GDPR に従うために、チケットおよび関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うためにフィードバック送信を削除する

GDPR に従うために、フィードバック送信および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために会社を削除する

GDPR に従うために、会社および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために割引を削除する

GDPR に従うために、割引および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために取引を削除する

GDPR に従うために、取引および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために取引先担当者を削除する

GDPR に従うために、取引先担当者および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために品目を削除する

GDPR に従うために、品目および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために料金を削除する

GDPR に従うために、料金および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために目標対象を削除する

GDPR に従うために、目標対象および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために税を削除する

GDPR に従うために、税および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために製品を削除する

GDPR に従うために製品および関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

GDPR に従うために見積もりを削除する

GDPR に従うために、見積もりおよび関連するすべてのコンテンツを完全に削除します。 'メール' に設定されたオプションのプロパティ [ID プロパティ] を使用して、メール アドレスで取引先担当者を識別します。 メール アドレスが見つからない場合、そのメール アドレスはブロックリストに追加され、今後は使用されなくなります。

パラメーター

名前 キー 必須 説明
Object ID
objectId string

オブジェクト識別子。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

返答
string

ID でオブジェクトのバッチをアーカイブする

識別子でオブジェクトのバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

ID
id string

識別子。

戻り値

返答
string

ID でオブジェクトのバッチを取得する

内部識別子または一意のプロパティ値でオブジェクトのバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

オブジェクトの種類
objectType True string

オブジェクトの種類。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID でオブジェクトを取得する

objectidentifier で識別されるオブジェクトを取得します。 objectId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID でチケットのバッチをアーカイブする

識別子でチケットのバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID でチケットのバッチを取得する

内部識別子または一意のプロパティ値でチケットのバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID でフィードバック送信のバッチをアーカイブする

識別子でフィードバック送信のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID でフィードバック送信のバッチを取得する

内部識別子または一意のプロパティ値でフィードバック送信のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で会社のバッチをアーカイブする

識別子で会社のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で会社をアーカイブする

companyId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
企業 ID
companyId True string

会社の識別子。

戻り値

返答
string

ID で会社を取得する

companyidentifier で識別されるオブジェクトを取得します。 companyId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

企業 ID
companyId True string

会社の識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で会社を取得する

内部識別子または一意のプロパティ値で会社のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で会社を更新する

companyidentifier で識別されるオブジェクトの部分的な更新を実行します。 companyId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

企業 ID
companyId True string

会社の識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で割引のバッチをアーカイブする

識別子で割引のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で割引のバッチを取得する

内部識別子または一意のプロパティ値で割引のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で取引のバッチをアーカイブする

識別子で取引のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で取引のバッチを取得する

内部識別子または一意のプロパティ値で取引のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で取引をアーカイブする

dealId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
取引 ID
dealId True string

取引識別子。

戻り値

返答
string

ID で取引先担当者のバッチをアーカイブする

識別子で取引先担当者のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で取引先担当者のバッチを取得する

内部識別子または一意のプロパティ値で取引先担当者のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で取引先担当者をアーカイブする

contactId で識別したオブジェクトをオブジェクトに移動します。

パラメーター

名前 キー 必須 説明
Contact ID
contactId True string

取引先担当者の識別子。

戻り値

返答
string

ID で取引先担当者を取得する

contactidentifier で識別されるオブジェクトを取得します。 contactId は内部オブジェクト識別子を参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

Contact ID
contactId True string

取引先担当者の識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

Results
associations.etc.results array of object
ID
associations.etc.results.id string

識別子。

タイプ
associations.etc.results.type string

種類。

associations.etc.paging.next.after string

後のページ。

Link
associations.etc.paging.next.link string

リンク ページ。

associations.etc.paging.prev.before string

前のページ。

Link
associations.etc.paging.prev.link string

リンク ページ。

ID で品目のバッチをアーカイブする

識別子で品目のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で品目のバッチを取得する

内部識別子または一意のプロパティ値で品目のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で所有者を取得する

指定した識別子または useridentifier で所有者を取得します。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

Owner ID
ownerId True string

所有者 ID。

戻り値

名前 パス 説明
Archived
archived boolean

アーカイブ済みかどうか。

作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

メール
email string

メール アドレス。

First Name
firstName string

名。

Last Name
lastName string

姓。

User ID
userId string

ユーザー識別子。

Teams
teams array of object
ID
teams.id string

識別子。

件名
teams.name string

名前。

主要
teams.primary string

主要。

ID で料金のバッチをアーカイブする

識別子で料金のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で料金のバッチを取得する

内部識別子または一意のプロパティ値で料金のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で料金をアーカイブする

feeId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
料金 ID
feeId True string

料金識別子。

戻り値

返答
string

ID で料金を取得する

feeidentifier で識別されるオブジェクトを取得します。 feeId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

料金 ID
feeId True string

料金識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で料金を更新する

feeidentifier で識別されるオブジェクトの部分的な更新を実行します。 feeId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

料金 ID
feeId True string

料金識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で目標対象のバッチをアーカイブする

識別子で目標対象のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で目標対象のバッチを取得する

内部識別子または一意のプロパティ値で目標対象のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で目標対象を取得する

goalTargetidentifier で識別されるオブジェクトを取得します。 goalTargetId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

目標対象 ID
goalTargetId True string

目標対象識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で税のバッチをアーカイブする

識別子で税のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で税のバッチを取得する

内部識別子または一意のプロパティ値で税のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で税を取得する

taxidentifier で識別されるオブジェクトを取得します。 taxId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

税 ID
taxId True string

税識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID で製品のバッチをアーカイブする

識別子で製品のバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で製品のバッチを取得する

内部識別子または一意のプロパティ値で製品のバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で見積もりのバッチをアーカイブする

識別子で見積もりのバッチをアーカイブします。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

返答
string

ID で見積もりのバッチを取得する

内部識別子または一意のプロパティ値で見積もりのバッチを取得します。

パラメーター

名前 キー 必須 説明
Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID
id string

識別子。

プロパティ​​
properties array of string

プロパティ オブジェクト。

履歴を持つプロパティ
propertiesWithHistory array of string

履歴オブジェクトを持つプロパティ。

ID プロパティ
idProperty string

識別子プロパティ。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

ID で見積もりをアーカイブする

quoteId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
見積もり ID
quoteId True string

見積もり識別子。

戻り値

返答
string

ID で見積もりを取得する

quoteidentifier で識別されるオブジェクトを取得します。 quoteId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

見積もり ID
quoteId True string

見積もり識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

ID を指定して連絡先を更新する

contactidentifier で識別されるオブジェクトの部分的な更新を実行します。 contactId は内部オブジェクト識別子を参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
Contact ID
contactId True string

取引先担当者の識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

すべてのカードを取得する

指定したアプリのカードの一覧を返します。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの識別子。

戻り値

名前 パス 説明
Results
results array of object
基本 URL
results.actions.baseUrls array of string

基本 URL アドレス。

[監査履歴]
results.auditHistory array of object
Action Type
results.auditHistory.actionType string

アクションの種類。

Application ID
results.auditHistory.applicationId string

アプリケーション識別子。

認証ソース
results.auditHistory.authSource string

認証ソース。

変更時刻
results.auditHistory.changedAt string

変更時刻。

開始ユーザー ID
results.auditHistory.initiatingUserId string

開始ユーザー識別子。

オブジェクト タイプ ID
results.auditHistory.objectTypeId string

オブジェクト タイプ識別子。

プロパティ​​
results.display.properties array of object
データ型
results.display.properties.dataType string

データ型です。

Label
results.display.properties.label string

ラベル。

件名
results.display.properties.name string

名前。

オプション
results.display.properties.options array of object
Label
results.display.properties.options.label string

ラベル。

件名
results.display.properties.options.name string

名前。

タイプ
results.display.properties.options.type string

種類。

Object Types
results.fetch.objectTypes array of object
件名
results.fetch.objectTypes.name string

名前。

送信するプロパティ
results.fetch.objectTypes.propertiesToSend array of string

送信するプロパティ。

ターゲット URL
results.fetch.targetUrl string

ターゲット URL アドレス。

ID
results.id string

識別子。

肩書き
results.title string

肩書き。

作成日
results.createdAt string

作成日時。

更新日
results.updatedAt string

更新時刻。

アクティブなインポートをキャンセルする

これにより、開発者はアクティブなインポートをキャンセルできます。

パラメーター

名前 キー 必須 説明
インポート ID
importId True string

インポート識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

アクティブなインポートを取得する

この取引先企業のアクティブなインポートのページ化リストを返します。

パラメーター

名前 キー 必須 説明
after string

以後。

before string

以前。

Limit
limit string

制限。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

ファイル ID
results.metadata.fileIds array of string

ファイル識別子。

オブジェクト リスト
results.metadata.objectLists array of object
リスト ID
results.metadata.objectLists.listId string

リスト識別子です。

オブジェクトの種類
results.metadata.objectLists.objectType string

オブジェクトの種類。

オプトアウト インポート
results.optOutImport string

オプトアウト インポート。

状態
results.state string

都道府県。

更新日
results.updatedAt string

更新時刻。

テンプレート ID
results.importTemplate.templateId string

テンプレートの識別子。

テンプレートのタイプ
results.importTemplate.templateType string

テンプレート タイプ。

インポート ソース
results.importSource string

インポート ソース。

インポート名
results.importName string

インポート名。

paging.next.after string

以後。

Link
paging.next.link string

リンク。

paging.prev.before string

以前。

Link
paging.prev.link string

リンク。

インポート エラーを取得する

インポートのエラーのリストを取得します。

パラメーター

名前 キー 必須 説明
after string

以後。

Limit
limit string

制限。

インポート ID
importId True string

インポート識別子。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

エラーの種類
results.errorType string

エラーの種類。

ID
results.id string

識別子。

ファイル ID
results.sourceData.fileId string

ファイル識別子。

行番号
results.sourceData.lineNumber string

行数。

行データ
results.sourceData.rowData array of string

行データ。

ページ名
results.sourceData.pageName string

ページ名。

オブジェクトの種類
results.objectType string

オブジェクトの種類。

無効な値
results.invalidValue string

値が無効です。

追加のコンテキスト
results.extraContext string

追加のコンテキスト。

オブジェクト タイプ ID
results.objectTypeId string

オブジェクト タイプ識別子。

既知の列番号
results.knownColumnNumber string

既知の列番号。

paging.next.after string

以後。

Link
paging.next.link string

リンク。

インポートに関する情報を取得する

更新を含む、インポート レコードの完全な概要。

パラメーター

名前 キー 必須 説明
インポート ID
importId True string

インポート識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

ファイル ID
metadata.fileIds array of string

ファイル識別子。

オブジェクト リスト
metadata.objectLists array of object
リスト ID
metadata.objectLists.listId string

リスト識別子です。

オブジェクトの種類
metadata.objectLists.objectType string

オブジェクトの種類。

オプトアウト インポート
optOutImport string

オプトアウト インポート。

状態
state string

都道府県。

更新日
updatedAt string

更新時刻。

テンプレート ID
importTemplate.templateId string

テンプレートの識別子。

テンプレートのタイプ
importTemplate.templateType string

テンプレート タイプ。

インポート ソース
importSource string

インポート ソース。

インポート名
importName string

インポート名。

エクスポートを開始する

要求本文で指定されるように、ポータルの CRM データのエクスポートを開始します。

パラメーター

名前 キー 必須 説明
エクスポート名
exportName string

エクスポート名。

エクスポートの種類
exportType string

エクスポートの種類。

Format
format string

形式。

Language
language string

言語。

オブジェクトのプロパティ
objectProperties array of string

オブジェクトのプロパティ。

オブジェクトの種類
objectType string

オブジェクトの種類。

関連するオブジェクトの種類
associatedObjectType string

関連するオブジェクトの種類。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

クエリ
query string

クエリ。

並べ替え
sorts array of string

並べ替え。

戻り値

名前 パス 説明
ID
id string

識別子。

オブジェクト タイプで検索する

オブジェクト タイプでオブジェクトのリストを取得します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

オブジェクトのバッチを作成する

オブジェクトのバッチを作成します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

オブジェクトのバッチを更新する

オブジェクトのバッチを更新します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

オブジェクトの関連付けの一覧を表示する

オブジェクトのすべての関連付けをオブジェクト タイプごとに一覧表示します。 1 回の呼び出しにつき 500 に制限されます。

パラメーター

名前 キー 必須 説明
after string

以後。

Limit
limit string

制限。

オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

戻り値

名前 パス 説明
Results
results array of object
関連付けタイプ
results.associationTypes array of object
カテゴリー
results.associationTypes.category string

カテゴリ。

タイプ ID
results.associationTypes.typeId string

タイプ識別子。

Label
results.associationTypes.label string

ラベル。

終了オブジェクト ID
results.toObjectId string

終了オブジェクト識別子。

paging.next.after string

以後。

Link
paging.next.link string

リンク。

オブジェクトをアーカイブする

objectId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

戻り値

返答
string

オブジェクトを作成する

指定したプロパティを使用して CRM オブジェクトを作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

オブジェクトを取得する

オブジェクトのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

オブジェクトの種類
objectType True string

オブジェクトの種類。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

オブジェクトを更新する

objectidentifier で識別されるオブジェクトの部分的な更新を実行します。 objectId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

カードを削除する

指定した識別子のカード定義を完全に削除します。 削除すると、このカードのデータ取り込み要求はサービスに送信されなくなります。 これは元に戻せません。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの識別子。

Card ID
cardId True string

カード識別子。

戻り値

返答
string

カードを取得する

指定した識別子のカードの定義を返します。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの識別子。

Card ID
cardId True string

カード識別子。

戻り値

名前 パス 説明
基本 URL
actions.baseUrls array of string

基本 URL アドレス。

[監査履歴]
auditHistory array of object
Action Type
auditHistory.actionType string

アクションの種類。

Application ID
auditHistory.applicationId string

アプリケーション識別子。

認証ソース
auditHistory.authSource string

認証ソース。

変更時刻
auditHistory.changedAt string

変更時刻。

開始ユーザー ID
auditHistory.initiatingUserId string

開始ユーザー識別子。

オブジェクト タイプ ID
auditHistory.objectTypeId string

オブジェクト タイプ識別子。

プロパティ​​
display.properties array of object
データ型
display.properties.dataType string

データ型です。

Label
display.properties.label string

ラベル。

件名
display.properties.name string

名前。

オプション
display.properties.options array of object
Label
display.properties.options.label string

ラベル。

件名
display.properties.options.name string

名前。

タイプ
display.properties.options.type string

種類。

Object Types
fetch.objectTypes array of object
件名
fetch.objectTypes.name string

名前。

送信するプロパティ
fetch.objectTypes.propertiesToSend array of string

送信するプロパティ。

ターゲット URL
fetch.targetUrl string

ターゲット URL アドレス。

ID
id string

識別子。

肩書き
title string

肩書き。

作成日
createdAt string

作成日時。

更新日
updatedAt string

更新時刻。

カードを更新する

新しい詳細でカード定義を更新します。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの識別子。

Card ID
cardId True string

カード識別子。

肩書き
title string

肩書き。

件名
name string

名前。

送信するプロパティ
propertiesToSend array of string

送信するプロパティ。

Card Type
cardType string

カードの種類。

ターゲット URL
targetUrl string

ターゲット URL アドレス。

サーバーレス機能
serverlessFunction string

サーバーレス機能。

データ型
dataType string

データ型です。

Label
label string

ラベル。

件名
name string

名前。

Label
label string

ラベル。

件名
name string

名前。

タイプ
type string

種類。

基本 URL
baseUrls array of string

基本 URL アドレス。

戻り値

名前 パス 説明
基本 URL
actions.baseUrls array of string

基本 URL アドレス。

[監査履歴]
auditHistory array of object
Action Type
auditHistory.actionType string

アクションの種類。

Application ID
auditHistory.applicationId string

アプリケーション識別子。

認証ソース
auditHistory.authSource string

認証ソース。

変更時刻
auditHistory.changedAt string

変更時刻。

開始ユーザー ID
auditHistory.initiatingUserId string

開始ユーザー識別子。

オブジェクト タイプ ID
auditHistory.objectTypeId string

オブジェクト タイプ識別子。

プロパティ​​
display.properties array of object
データ型
display.properties.dataType string

データ型です。

Label
display.properties.label string

ラベル。

件名
display.properties.name string

名前。

オプション
display.properties.options array of object
Label
display.properties.options.label string

ラベル。

件名
display.properties.options.name string

名前。

タイプ
display.properties.options.type string

種類。

Object Types
fetch.objectTypes array of object
件名
fetch.objectTypes.name string

名前。

送信するプロパティ
fetch.objectTypes.propertiesToSend array of string

送信するプロパティ。

ターゲット URL
fetch.targetUrl string

ターゲット URL アドレス。

ID
id string

識別子。

肩書き
title string

肩書き。

作成日
createdAt string

作成日時。

更新日
updatedAt string

更新時刻。

キューを検索する

キューの一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

サンプル カードの詳細の応答を取得する

サンプル カードの詳細の応答を返します。 これは、ユーザーに表示されるカードに表示される詳細を含むペイロードです。 アプリはデータ取り込み要求に応じてこれを送信する必要があります。

戻り値

名前 パス 説明
合計数
totalCount string

合計数。

すべての項目のリンク URL
allItemsLinkUrl string

すべての項目のリンク URL アドレス。

カード ラベル
cardLabel string

カード ラベル。

予備
topLevelActions.secondary array of object
HTTP メソッド
topLevelActions.secondary.httpMethod string

HTTP メソッド。

プロパティ名を含む
topLevelActions.secondary.propertyNamesIncluded array of string

プロパティ名が含まれます。

タイプ
topLevelActions.secondary.type string

種類。

[URL]
topLevelActions.secondary.url string

URL アドレス。

キャンセル ボタン ラベル
topLevelActions.secondary.confirmation.cancelButtonLabel string

キャンセル ボタン ラベルです。

確認ボタン ラベル
topLevelActions.secondary.confirmation.confirmButtonLabel string

確認ボタン ラベルです。

プロンプト
topLevelActions.secondary.confirmation.prompt string

プロンプト。

Label
topLevelActions.secondary.label string

ラベル。

身長
topLevelActions.settings.height string

高さ。

プロパティ名を含む
topLevelActions.settings.propertyNamesIncluded array of string

プロパティ名が含まれます。

タイプ
topLevelActions.settings.type string

種類。

[URL]
topLevelActions.settings.url string

URL アドレス。

Width
topLevelActions.settings.width string

幅。

Label
topLevelActions.settings.label string

ラベル。

HTTP メソッド
topLevelActions.primary.httpMethod string

HTTP メソッド。

プロパティ名を含む
topLevelActions.primary.propertyNamesIncluded array of string

プロパティ名が含まれます。

タイプ
topLevelActions.primary.type string

種類。

[URL]
topLevelActions.primary.url string

URL アドレス。

キャンセル ボタン ラベル
topLevelActions.primary.confirmation.cancelButtonLabel string

キャンセル ボタン ラベルです。

確認ボタン ラベル
topLevelActions.primary.confirmation.confirmButtonLabel string

確認ボタン ラベルです。

プロンプト
topLevelActions.primary.confirmation.prompt string

プロンプト。

Label
topLevelActions.primary.label string

ラベル。

セクション
sections array of object
Actions
sections.actions array of object
HTTP メソッド
sections.actions.httpMethod string

HTTP メソッド。

プロパティ名を含む
sections.actions.propertyNamesIncluded array of string

プロパティ名が含まれます。

タイプ
sections.actions.type string

種類。

[URL]
sections.actions.url string

URL アドレス。

キャンセル ボタン ラベル
sections.actions.confirmation.cancelButtonLabel string

キャンセル ボタン ラベルです。

確認ボタン ラベル
sections.actions.confirmation.confirmButtonLabel string

確認ボタン ラベルです。

プロンプト
sections.actions.confirmation.prompt string

プロンプト。

Label
sections.actions.label string

ラベル。

ID
sections.id string

識別子。

肩書き
sections.title string

肩書き。

トークン
sections.tokens array of object
価値
sections.tokens.value string

値。

件名
sections.tokens.name string

名前。

Label
sections.tokens.label string

ラベル。

データ型
sections.tokens.dataType string

データ型です。

リンクの URL
sections.linkUrl string

リンクの URL アドレス。

応答のバージョン
responseVersion string

応答のバージョンです。

ソース リストのすべてのレコードを宛先リストに追加する

ソース リスト (sourceListId で指定されます) のすべてのレコードをデスティネーション リスト (listId で指定されます) に追加します。 すでに宛先リストのメンバーであるレコードは無視されます。 デスティネーション リスト ID とソース リスト ID は異なる必要があります。 宛先リストとソース リストには、同じ種類のレコード (取引先担当者、会社など) が含まれている必要があります。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のデスティネーション リストでのみ機能します。 ソース リストの processingType はどれでも構いません。

パラメーター

名前 キー 必須 説明
リスト ID
listId True string

リスト識別子です。

ソース リスト ID
sourceListId True string

ソース リスト識別子。

戻り値

返答
string

タスク ID のステータスを取得する

タスク識別子のステータスを取得します。

パラメーター

名前 キー 必須 説明
Task ID
taskId True string

タスクの識別子です。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

Result
result string

結果。

エラー
numErrors string

エラーの数。

エラー
errors array of object
カテゴリー
errors.category string

カテゴリ。

エラー
errors.errors array of object
Message
errors.errors.message string

メッセージ。

含む
errors.errors.in string

含むです。

コード
errors.errors.code string

コード。

サブ カテゴリ
errors.errors.subCategory string

サブ カテゴリ。

Message
errors.message string

メッセージ。

Status
errors.status string

状態。

ID
errors.id string

識別子。

依頼者
requestedAt string

要求時刻。

チケットのバッチを作成する

チケットのバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

チケットのバッチを更新する

チケットのバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

チケットをアーカイブする

ticketId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
チケット ID
ticketId True string

チケット識別子。

戻り値

返答
string

チケットを作成する

指定したプロパティでチケットを作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

チケットを取得する

ticketidentifier で識別されるオブジェクトを取得します。 ticketId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

チケット ID
ticketId True string

チケット識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

チケットを取得する

チケットのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

チケットを更新する

ticketidentifier で識別されるオブジェクトの部分的な更新を実行します。 ticketId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

チケット ID
ticketId True string

チケット識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

チケットを検索する

チケットの一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

フィードバック送信のバッチを作成する

フィードバック送信のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

フィードバック送信のバッチを更新する

フィードバック送信のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

フィードバック送信の一覧を表示する

フィードバック送信のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

フィードバック送信をアーカイブする

feedbackSubmissionId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
フィードバック送信 ID
feedbackSubmissionId True string

フィードバック送信識別子。

戻り値

返答
string

フィードバック送信を作成する

指定したプロパティを使用してフィードバック送信を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

フィードバック送信を取得する

feedbackSubmissionidentifier で識別されるオブジェクトを取得します。 feedbackSubmissionId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

フィードバック送信 ID
feedbackSubmissionId True string

フィードバック送信識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

フィードバック送信を更新する

feedbackSubmissionidentifier で識別されるオブジェクトの部分的な更新を実行します。 feedbackSubmissionId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

フィードバック送信 ID
feedbackSubmissionId True string

フィードバック送信識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

フィードバック送信を検索する

フィードバック送信の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

リストからすべてのレコードを削除する

リストからすべてのレコードを削除します。 注意: リストは削除されません。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

パラメーター

名前 キー 必須 説明
リスト ID
listId True string

リスト識別子です。

戻り値

返答
string

リストにレコードを追加またはリストからレコードを削除する

システム内で既に作成されているレコードをリストに追加したり、リストから削除したりします。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

パラメーター

名前 キー 必須 説明
リスト ID
listId True string

リスト識別子です。

追加するレコード ID
recordIdsToAdd array of string

追加するレコード識別子。

削除するレコード ID
recordIdsToRemove array of string

削除するレコード識別子。

戻り値

名前 パス 説明
レコード ID がない
recordIdsMissing array of string

レコード識別子が見つかりません。

レコード ID が削除された
recordIdsRemoved array of string

レコード識別子が削除されました。

レコード ID が追加された
recordsIdsAdded array of string

レコード識別子が追加されました。

リストのメンバーシップを取り込む

リストのメンバーシップを、リスト内のレコードの recordId で並べ替えられた順序で取り込みます。 after オフセットが提供されるか、オフセットが提供されない場合は、recordId は昇順に並べ替えられます。 before オフセットが提供された場合、レコードは降順に並べ替えられます。 両方のオフセットが提供された場合、afterオフセット パラメーターが before オフセットよりも優先されます。

パラメーター

名前 キー 必須 説明
after string

以後。

before string

以前。

Limit
limit string

制限。

リスト ID
listId True string

リスト識別子です。

戻り値

名前 パス 説明
Results
results array of string

結果。

paging.next.after string

以後。

Link
paging.next.link string

リンク。

paging.prev.before string

以前。

Link
paging.prev.link string

リンク。

リストを検索する

空の query 値を指定してすべてのリストからリスト名またはページでリストを検索します。

パラメーター

名前 キー 必須 説明
追加のプロパティ
additionalProperties array of string

追加のプロパティ。

ページ
offset string

オフセット。

クエリ
query string

クエリ。

count string

カウント。

戻り値

名前 パス 説明
その他あり
hasMore boolean

その他があるかどうか。

リスト
lists array of object
リスト ID
lists.listId string

リスト識別子です。

リストのバージョン
lists.listVersion string

リストのバージョン。

件名
lists.name string

名前。

オブジェクト タイプ ID
lists.objectTypeId string

オブジェクト タイプ識別子。

Processing Status
lists.processingStatus string

処理の状態。

処理の種類
lists.processingType string

処理の種類。

ID で更新
lists.updatedById string

識別子で更新。

フィルター更新日時
lists.filtersUpdatedAt string

フィルターが更新された日時。

作成日
lists.createdAt string

作成日時。

Deleted At
lists.deletedAt string

削除日時。

作成者 ID
lists.createdById string

識別子によって作成。

更新日
lists.updatedAt string

更新時刻。

ページ
offset string

オフセット。

トータル
total string

総数。

レコードをリストから削除する

提供したレコードをリストから削除します。 存在しないレコード、またはリストのメンバーでないレコードは無視されます。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

パラメーター

名前 キー 必須 説明
リスト ID
listId True string

リスト識別子です。

body
body True array of string

戻り値

名前 パス 説明
レコード ID がない
recordIdsMissing array of string

レコード識別子が見つかりません。

レコード ID が削除された
recordIdsRemoved array of string

レコード識別子が削除されました。

レコード ID が追加された
recordsIdsAdded array of string

レコード識別子が追加されました。

レコードをリストに追加する

提供されたレコードをリストに追加します。 存在しないレコード、またはすでにリストのメンバーであるレコードは無視されます。 このエンドポイントは、processingTypeMANUAL または SNAPSHOT のリストでのみ機能します。

パラメーター

名前 キー 必須 説明
リスト ID
listId True string

リスト識別子です。

body
body True array of string

戻り値

名前 パス 説明
レコード ID がない
recordIdsMissing array of string

レコード識別子が見つかりません。

レコード ID が削除された
recordIdsRemoved array of string

レコード識別子が削除されました。

レコード ID が追加された
recordsIdsAdded array of string

レコード識別子が追加されました。

会社のバッチを作成する

会社のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

会社のバッチを更新する

会社のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

会社の検索

会社の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

会社を作成する

指定したプロパティで会社を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

会社を取得する

会社のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

割引のバッチを作成する

割引のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

割引のバッチを更新する

割引のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

割引の一覧を表示する

割引のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

割引をアーカイブする

discountId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
割引 ID
discountId True string

割引識別子。

戻り値

返答
string

割引を作成する

指定したプロパティを使用して割引を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

nostrudcf
nostrudcf string

nostrudcf。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

割引を取得する

discountidentifier で識別されるオブジェクトを取得します。 discountId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

割引 ID
discountId True string

割引識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

割引を更新する

discountidentifier で識別されるオブジェクトの部分的な更新を実行します。 discountId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

割引 ID
discountId True string

割引識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

割引を検索する

割引の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

取引のバッチを作成する

取引のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

取引のバッチを更新する

取引のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

取引を作成する

指定されたプロパティで取引を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

取引を取得する

dealidentifier で識別されるオブジェクトを取得します。 dealId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

取引 ID
dealId True string

取引識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

取引を取得する

取引のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

取引を更新する

dealidentifier で識別されるオブジェクトの部分的な更新を実行します。 dealId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

取引 ID
dealId True string

取引識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

取引を検索する

取引の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

取引先担当者のバッチを作成する

取引先担当者のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

取引先担当者のバッチを更新する

取引先担当者のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

取引先担当者の検索

取引先担当者のリストを取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

取引先担当者を取得する

取引先担当者のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

品目のバッチを作成する

品目のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

品目のバッチを更新する

品目のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

品目をアーカイブする

lineItemId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
品目 ID
lineItemId True string

品目識別子。

戻り値

返答
string

品目を作成する

指定したプロパティを使用して品目を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

品目を取得する

lineItemidentifier で識別されるオブジェクトを取得します。 lineItemId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

品目 ID
lineItemId True string

品目識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

品目を取得する

品目のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

品目を更新する

lineItemidentifier で識別されるオブジェクトの部分的な更新を実行します。 lineItemId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

品目 ID
lineItemId True string

品目識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

品目を検索する

品目の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

所有者を取得する

所有者の一覧を取得します。

パラメーター

名前 キー 必須 説明
メール
email True string

メール アドレス。

after string

後のページ。

Limit
limit string

制限。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
Archived
results.archived boolean

アーカイブ済みかどうか。

作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

メール
results.email string

メール アドレス。

First Name
results.firstName string

名。

Last Name
results.lastName string

姓。

User ID
results.userId string

ユーザー識別子。

Teams
results.teams array of object
ID
results.teams.id string

識別子。

件名
results.teams.name string

名前。

主要
results.teams.primary string

主要。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

料金のバッチを作成する

料金のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

料金のバッチを更新する

料金のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

料金の検索

料金の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

料金を作成する

指定されたプロパティで料金を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

料金を取得する

料金のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

新しいインポートを開始する

指定されたファイル リソースからデータのインポートを開始します。 これにより、対応するファイルがアップロードされ、インポート要求オブジェクトを使用してファイル内の行がオブジェクトに変換されます。

パラメーター

名前 キー 必須 説明
Content Type
Content-Type True string

コンテンツ タイプ。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

ファイル ID
metadata.fileIds array of string

ファイル識別子。

オブジェクト リスト
metadata.objectLists array of object
リスト ID
metadata.objectLists.listId string

リスト識別子です。

オブジェクトの種類
metadata.objectLists.objectType string

オブジェクトの種類。

オプトアウト インポート
optOutImport string

オプトアウト インポート。

状態
state string

都道府県。

更新日
updatedAt string

更新時刻。

テンプレート ID
importTemplate.templateId string

テンプレートの識別子。

テンプレートのタイプ
importTemplate.templateType string

テンプレート タイプ。

インポート ソース
importSource string

インポート ソース。

インポート名
importName string

インポート名。

新しいカードを作成する

このアプリがインストールされたときに取引先企業でアクティブになる新しいカードを定義します。

パラメーター

名前 キー 必須 説明
App ID
appId True string

アプリの識別子。

基本 URL
baseUrls array of string

基本 URL アドレス。

データ型
dataType string

データ型です。

Label
label string

ラベル。

件名
name string

名前。

Label
label string

ラベル。

件名
name string

名前。

タイプ
type string

種類。

件名
name string

名前。

送信するプロパティ
propertiesToSend array of string

送信するプロパティ。

ターゲット URL
targetUrl string

ターゲット URL アドレス。

Card Type
cardType string

カードの種類。

サーバーレス機能
serverlessFunction string

サーバーレス機能。

肩書き
title string

肩書き。

戻り値

名前 パス 説明
基本 URL
actions.baseUrls array of string

基本 URL アドレス。

[監査履歴]
auditHistory array of object
Action Type
auditHistory.actionType string

アクションの種類。

Application ID
auditHistory.applicationId string

アプリケーション識別子。

認証ソース
auditHistory.authSource string

認証ソース。

変更時刻
auditHistory.changedAt string

変更時刻。

開始ユーザー ID
auditHistory.initiatingUserId string

開始ユーザー識別子。

オブジェクト タイプ ID
auditHistory.objectTypeId string

オブジェクト タイプ識別子。

プロパティ​​
display.properties array of object
データ型
display.properties.dataType string

データ型です。

Label
display.properties.label string

ラベル。

件名
display.properties.name string

名前。

オプション
display.properties.options array of object
Label
display.properties.options.label string

ラベル。

件名
display.properties.options.name string

名前。

タイプ
display.properties.options.type string

種類。

Object Types
fetch.objectTypes array of object
件名
fetch.objectTypes.name string

名前。

送信するプロパティ
fetch.objectTypes.propertiesToSend array of string

送信するプロパティ。

ターゲット URL
fetch.targetUrl string

ターゲット URL アドレス。

ID
id string

識別子。

肩書き
title string

肩書き。

作成日
createdAt string

作成日時。

更新日
updatedAt string

更新時刻。

既定の関連付けを作成する

2 つのオブジェクト タイプ間に既定の (最も汎用的な) 関連付けタイプを作成します。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

開始オブジェクト ID
fromObjectId True string

開始オブジェクト識別子。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

終了オブジェクト ID
toObjectId True string

終了オブジェクト識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
関連付けカテゴリ
results.associationSpec.associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
results.associationSpec.associationTypeId string

関連付けタイプ識別子。

ID
results.from.id string

識別子。

ID
results.to.id string

識別子。

開始した
startedAt string

開始日時。

Status
status string

状態。

エラー
numErrors string

エラーの数。

依頼者
requestedAt string

要求時刻。

エラー
errors array of object
カテゴリー
errors.category string

カテゴリ。

エラー
errors.errors array of object
Message
errors.errors.message string

メッセージ。

サブ カテゴリ
errors.errors.subCategory string

サブ カテゴリ。

コード
errors.errors.code string

コード。

含む
errors.errors.in string

含むです。

Message
errors.message string

メッセージ。

Status
errors.status string

状態。

ID
errors.id string

識別子。

既定の関連付けを作成する

2 つのオブジェクト タイプ間に既定の (最も汎用的な) 関連付けタイプを作成します。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

ID
id string

識別子。

ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
関連付けカテゴリ
results.associationSpec.associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
results.associationSpec.associationTypeId string

関連付けタイプ識別子。

ID
results.from.id string

識別子。

ID
results.to.id string

識別子。

開始した
startedAt string

開始日時。

Status
status string

状態。

エラー
numErrors string

エラーの数。

依頼者
requestedAt string

要求時刻。

エラー
errors array of object
カテゴリー
errors.category string

カテゴリ。

エラー
errors.errors array of object
Message
errors.errors.message string

メッセージ。

サブ カテゴリ
errors.errors.subCategory string

サブ カテゴリ。

コード
errors.errors.code string

コード。

含む
errors.errors.in string

含むです。

Message
errors.message string

メッセージ。

Status
errors.status string

状態。

ID
errors.id string

識別子。

特定の関連付けラベルを削除する

オブジェクトの特定の関連付けラベルを一括削除します。 ラベルのない関連付けを削除すると、それらの 2 つのオブジェクト間のラベル付きの関連付けもすべて削除されます。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

ID
id string

識別子。

ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

返答
string

目標対象のバッチを作成する

目標対象のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

目標対象のバッチを更新する

目標対象のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

目標対象をアーカイブする

goalTargetId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
目標対象 ID
goalTargetId True string

目標対象識別子。

戻り値

返答
string

目標対象を作成する

指定したプロパティを使用して目標対象を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

目標対象を取得する

目標対象のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

目標対象を更新する

goalTargetidentifier で識別されるオブジェクトの部分的な更新を実行します。 goalTargetId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

目標対象 ID
goalTargetId True string

目標対象識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

目標対象を検索する

目標対象の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

税のバッチを作成する

税のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

税のバッチを更新する

税のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

税をアーカイブする

taxId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
税 ID
taxId True string

税識別子。

戻り値

返答
string

税を作成する

指定されたプロパティで料金を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

税を取得する

税のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

税を更新する

taxidentifier で識別されるオブジェクトの部分的な更新を実行します。 taxId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

税 ID
taxId True string

税識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

税を検索する

税の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

製品のバッチを作成する

製品のバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

製品のバッチを更新する

製品のバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

製品の検索

製品の一覧を取得します。

パラメーター

名前 キー 必須 説明
after string

後のページ。

Operator
operator string

演算子です。

プロパティ名
propertyName string

プロパティの名前。

価値
value string

値。

最高値
highValue string

最高値。

Values
values array of string

値。

Limit
limit string

制限。

プロパティ​​
properties array of string

プロパティ オブジェクト。

並べ替え
sorts array of string

並べ替え。

クエリ
query string

クエリ。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

トータル
total string

総数。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

製品をアーカイブする

productId で識別したオブジェクトをごみ箱に移動します。

パラメーター

名前 キー 必須 説明
Product ID
productId True string

製品識別子。

戻り値

返答
string

製品を作成する

指定したプロパティで製品を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

製品を取得する

productidentifier で識別されるオブジェクトを取得します。 productId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

ID プロパティ
idProperty string

識別子プロパティ。

Product ID
productId True string

製品識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

製品を取得する

製品のページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

後のページ。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

製品を更新する

productidentifier で識別されるオブジェクトの部分的な更新を実行します。 productId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

Product ID
productId True string

製品識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

見積もりのバッチを作成する

見積もりのバッチを作成します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

見積もりのバッチを更新する

見積もりのバッチを更新します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

見積もりの作成

指定されたプロパティで見積もりを作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

elit_26
elit_26 string

elit_26。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

見積もりを一覧表示する

見積もりのページを取得します。 プロパティのクエリ パラメーターが返す対象を制御します。

パラメーター

名前 キー 必須 説明
Limit
limit string

制限。

after string

以後。

プロパティ​​
properties string

プロパティ。

履歴を持つプロパティ
propertiesWithHistory string

履歴を持つプロパティ。

関連付け
associations string

関連付け。

Archived
archived boolean

アーカイブ済み結果のみを返すかどうか。

戻り値

名前 パス 説明
Results
results array of object
作成日
results.createdAt string

作成日時。

ID
results.id string

識別子。

更新日
results.updatedAt string

更新時刻。

Archived
results.archived boolean

アーカイブ済みかどうか。

アーカイブ日時
results.archivedAt string

アーカイブ日時。

paging.next.after string

後のページ。

Link
paging.next.link string

リンク。

見積もりを更新する

quoteidentifier で識別されるオブジェクトの部分的な更新を実行します。 quoteId は、既定で内部オブジェクト ID を参照するか、idProperty クエリ パラメーターで指定された一意のプロパティ値をオプションで参照します。 指定されたプロパティ値は上書きされます。 読み取り専用および存在しないプロパティは無視されます。 プロパティ値は、空の文字列を渡すことでクリアできます。

パラメーター

名前 キー 必須 説明
ID プロパティ
idProperty string

識別子プロパティ。

見積もり ID
quoteId True string

見積もり識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

連絡先を作成する

指定したプロパティで取引先担当者を作成し、識別子を含むオブジェクトのコピーを返します。

パラメーター

名前 キー 必須 説明
ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
作成日
createdAt string

作成日時。

ID
id string

識別子。

更新日
updatedAt string

更新時刻。

Archived
archived boolean

アーカイブ済みかどうか。

アーカイブ日時
archivedAt string

アーカイブ日時。

関連付けをバッチ作成する

オブジェクトの関連付けをバッチ作成します。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

ID
id string

識別子。

ID
id string

識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
開始オブジェクト ID
results.fromObjectId string

開始オブジェクト識別子。

開始オブジェクト タイプ ID
results.fromObjectTypeId string

開始オブジェクト タイプ識別子。

ラベル
results.labels array of string

ラベルです。

終了オブジェクト ID
results.toObjectId string

終了オブジェクト識別子。

終了オブジェクト タイプ ID
results.toObjectTypeId string

終了オブジェクト タイプ識別子。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

関連付けを一括削除する

オブジェクトの関連付けを一括削除します。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

ID
id string

識別子。

ID
id string

識別子。

戻り値

返答
string

関連付けを一括読み取りする

オブジェクトと特定のオブジェクト タイプの関連付けを一括読み取りします。 返されたページング オブジェクトの 'after' フィールドを 'id' の横に追加すると、その objectidentifier から関連付けの次のページを取得できます。 'link' フィールドは非推奨であるため、無視する必要があります。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

ID
id string

識別子。

after string

リンクの後。

戻り値

名前 パス 説明
完了日時
completedAt string

完了日時。

Results
results array of object
ID
results.from.id string

識別子。

受信先
results.to array of object
関連付けタイプ
results.to.associationTypes array of object
カテゴリー
results.to.associationTypes.category string

カテゴリ。

タイプ ID
results.to.associationTypes.typeId string

タイプ識別子。

Label
results.to.associationTypes.label string

ラベル。

終了オブジェクト ID
results.to.toObjectId string

終了オブジェクト識別子。

results.paging.next.after string

リンクの後。

Link
results.paging.next.link string

リンク。

results.paging.prev.before string

リンクの前。

Link
results.paging.prev.link string

リンク。

開始した
startedAt string

開始日時。

Status
status string

状態。

依頼者
requestedAt string

要求時刻。

関連付けを削除する

2 つのレコード間のすべての関連付けを削除します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

終了オブジェクト ID
toObjectId True string

終了オブジェクト識別子。

戻り値

返答
string

関連付けタイプの一覧を表示する

2 つのオブジェクト タイプ間で使用できる有効な関連付けタイプをすべて一覧表示します。

パラメーター

名前 キー 必須 説明
開始オブジェクト タイプ
fromObjectType True string

開始オブジェクト タイプ。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

戻り値

名前 パス 説明
Results
results array of object
ID
results.id string

識別子。

件名
results.name string

名前。

関連付けラベルを作成する

2 つのレコード間に関連付けラベルを設定します。

パラメーター

名前 キー 必須 説明
オブジェクトの種類
objectType True string

オブジェクトの種類。

Object ID
objectId True string

オブジェクト識別子。

終了オブジェクト タイプ
toObjectType True string

終了オブジェクト タイプ。

終了オブジェクト ID
toObjectId True string

終了オブジェクト識別子。

関連付けカテゴリ
associationCategory string

関連付けカテゴリ。

関連付けタイプ ID
associationTypeId string

関連付けタイプ識別子。

戻り値

名前 パス 説明
開始オブジェクト ID
fromObjectId string

開始オブジェクト識別子。

開始オブジェクト タイプ ID
fromObjectTypeId string

開始オブジェクト タイプ識別子。

ラベル
labels array of string

ラベルです。

終了オブジェクト ID
toObjectId string

終了オブジェクト識別子。

終了オブジェクト タイプ ID
toObjectTypeId string

終了オブジェクト タイプ識別子。

定義

string

これは基本的なデータ型 '文字列' です。