契約API (/contracts)
契約APIを使用して、関与するビジネスグループ、主要な日付、契約のステータス、財務条件など、契約を作成、更新、またはクエリします。
契約APIを使用して、関与するビジネスグループ、主要な日付、契約のステータス、財務条件など、契約を作成、更新、またはクエリします。
契約にアクセスするためのURLは次のとおりです。 https://{your_instance_name}/api/contracts
詳細については、 「インテグレーションのベストプラクティス 」を参照してください。
wiki.tree()
アクション
| 動詞 | パス | アクション | 説明 | ||
|---|---|---|---|---|---|
| プット | /api/contracts/:id/add_approver |
承認者を追加 | 契約の承認者を手動で追加する | ||
| プット | /api/contracts/:id/ccc_signature_created |
ccc_signature_created | CCCで署名が追加されたことを通知します。 | ||
| プット | /api/contracts/:id/complete |
完了 | 契約を完了状態に移行します。 | ||
| 投稿 | /api/contracts |
作成 | 契約を作成 | ||
| 投稿 | /api/contracts/:id/create_published |
発行済みを作成 | /api/contracts/:id/create_published |
||
| 取得 | /api/contracts |
インデックス | 契約をクエリ | ||
| 投稿 | /api/contracts/:id/legal_agreement |
契約書 | legal legal_agreementファイルを追加または更新 | ||
| プット | /api/contracts/:id/legal_agreement |
契約書 | legal legal_agreementファイルを追加または更新 | ||
| プット | /api/contracts/:id/remove_approval |
承認を削除 | 手入力で追加された承認者を削除 | ||
| 取得 | /api/contracts/:id/retrieve_legal_agreement |
契約書を取得 | legal_legal_agreementファイルの取得 | ||
| 取得 | /api/contracts/:id |
表示 | 契約を表示 | ||
| プット | /api/contracts/:id/submit_for_approval |
承認を得るために送信 | 承認を得るために契約を送信します。 | ||
| プット | /api/contracts/:id |
更新 | 契約を更新 | ||
| プット | /api/contracts/:id/update_published |
update_published | 公開時に契約を更新します。* | ||
| プット | /api/contracts/:id/withdraw_signatures |
取り下げ署名 | CCC署名取り下げ後、契約を該当ステータスに移す | ||
*完了した契約または公開済みの契約を（ドラフトを作成せずに直接）更新するには、会社の設定([設定]>[会社情報])で[契約ヒエラルキーを有効にする]がオンになっている必要があります。 CLM Standardがない場合は、契約修正を行うことができます。
要素
| 要素 | 説明 | 必須 | 一意 | 許容値 | で | 出力 | データタイプ |
|---|---|---|---|---|---|---|---|
| 修正済みの契約タイプ | 修正された契約タイプ | はい | はい | 文字列（255） | |||
| 更新終了日を自動延長 | 有効期限を自動更新 | はい | はい | ブール値 | |||
| 同意 | 同意の通知 | notice、consent、not_required、not_assignable | はい | はい | 文字列（255） | ||
| コンテンツグループ | ビジネスグループ | はい | はい | ビジネスグループ | |||
| 契約所有者 | 契約所有者 | はい | はい | ユーザー | |||
| 契約条件 | 契約条件 | はい | はい | 契約条件 | |||
| 契約タイプ | 分類のためのカスタム定義ラベル | no | no | 任意 | はい | はい | |
| contract-type-custom-field-1 | 契約タイプのカスタムフィールド1 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-2 | 契約タイプのカスタムフィールド2 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-3 | 契約タイプのカスタムフィールド3 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-4 | 契約タイプのカスタムフィールド4 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-5 | 契約タイプのカスタムフィールド5 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-6 | 契約タイプのカスタムフィールド6 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-7 | 契約タイプのカスタムフィールド7 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-8 | 契約タイプのカスタムフィールド8 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-9 | 契約タイプのカスタムフィールド9 | no | no | 任意 | はい | はい | 文字列（255） |
| contract-type-custom-field-10 | 契約タイプのカスタムフィールド10 | no | no | 任意 | はい | はい | 文字列（255） |
| created-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 作成者 | 作成したユーザー | はい | ユーザー | ||||
| currency | 契約通貨コード | はい | はい | 通貨 | |||
| 現在の承認 | 現在の承認 | はい | 承認 | ||||
| 既定の勘定科目 | 既定の勘定科目 | はい | はい | 勘定科目 | |||
| department | 所有者部署 | no | no | 任意 | はい | はい | 部署 |
| description | 契約に関する記述 | false | false | 任意 | はい | はい | 文字列（1024） |
| 多様性カテゴリー | サプライヤー多様性カテゴリー | はい | 文字列 | ||||
| 終了日 | 有効期限 | no | はい | はい | 日時 | ||
| 実行日 | 契約が完了し、法的拘束力がある日付 | no | no | 任意 | はい | はい | 日時 |
| id | Coupaの一意の識別子 | はい | 整数 | ||||
| 既定 | サプライヤーインボイスの既定勘定科目 | はい | はい | ブール値 | |||
| 契約書のurl | 契約書のオプションのURL | はい | はい | 文字列（255） | |||
| 通知の長さ単位 | 通知期間の単位（日/月/年） | days、months、years | はい | はい | 文字列（255） | ||
| 通知期間の値 | 通知期間の値 | はい | はい | 文字列（255） | |||
| 他の人によってロックされた | 編集ロックを保持しているCLMS契約関係者 | no | no | はい | string型 | ||
| ユーザーIDでロック済み | 編集ロックを保持しているCLMSユーザー | no | no | はい | 整数 | ||
| 基本契約 | マスター契約番号または名前 | はい | はい | 契約 | |||
| 最大コミット | 最大コミット金額 | はい | はい | 小数（32,4） | |||
| 最大値 | 最大コミット金額 | はい | はい | 小数（32,4） | |||
| 最小コミット | 最小コミット金額 | はい | はい | 小数（32,4） | |||
| 最小値 | 最小コミット金額 | はい | はい | 小数（32,4） | |||
| name | 契約名 | はい | はい | はい | はい | 文字列（100） | |
| 更新なし | 更新の回数 | はい | 許容値には["1..100"]が含まれるようになりました | はい | はい | 整数 | |
| number | 契約番号 | はい | はい | はい | はい | 文字列（50） | |
| 注文ウィンドウtz | order_window_tz | 有効なタイムゾーン | はい | はい | 文字列（255） | ||
| 親 | 親 | はい | はい | 契約 | |||
| payment-term | 契約の支払条件コード | はい | はい | 支払条件 | |||
| poメッセージ | 注文ウィンドウ発注書メッセージ | はい | はい | 文字列（255） | |||
| 推奨 | サプライヤーの推奨契約を示します | はい | はい | ブール値 | |||
| 代理サプライヤーID | 代理サプライヤーの識別子 | 任意 | はい | はい | 整数 | ||
| 公開日 | 契約が公開された日付 | no | no | 任意 | はい | はい | 日時 |
| 見積返答ID | 見積返答のID | はい | 整数 | ||||
| ra-risk-request | Raリスク申請 | はい | RaRiskリクエスト | ||||
| reason-insight-events | Reason Insightイベント | はい | はい | はい | Reason Insightイベント | ||
| 更新長さ単位 | 更新期間の単位（日/月/年） | はい | days、months、years | はい | はい | 文字列（255） | |
| 更新期間の値 | 更新期間の値 | はい | はい | はい | 整数 | ||
| 申請書メッセージ | 注文ウィンドウ請求書メッセージ | はい | はい | 文字列（255） | |||
| レビュアーのユーザーid | CLMS内部レビュー担当者 | no | no | はい | 整数 | ||
| 節減率 | 契約価格設定による節減 | はい | はい | 小数（20,2） | |||
| スケジュール | スケジュール | はい | はい | 注文ウィンドウ | |||
| 配送条件 | 契約の配送条件コード | はい | はい | 配送条件 | |||
| ソースID | 契約作成のソースID | はい | はい | 文字列（255） | |||
| ソースタイプ | 契約作成のソースタイプ | はい | はい | 文字列（255） | |||
| 開始日 | 開始日 | はい | はい | 日時 | |||
| status | 契約のステータス | はい | はい | はい | ドラフト | ||
| 厳格な請求書発行ルール | 厳格なインボイス作成の規則 | はい | はい | ブール値 | |||
| 最大支出額に基づく支出の停止 | 最大値に基づいて支出を停止 | no | no | yes、no | はい | はい | 文字列（255） |
| 送信者 | 承認のために契約を送信したユーザー | はい | ユーザー | ||||
| supplier | サプライヤー名 | はい | はい | はい | サプライヤー | ||
| サプライヤーアカウント | サプライヤーの口座番号 | はい | はい | 文字列（255） | |||
| サプライヤー請求可能 | サプライヤーは直接インボイスを発行できます | はい | はい | ブール値 | |||
| taggings | タグ付け | no | no | はい | はい | タグ付けAPI | |
| tags | タグ | no | no | はい | はい | タグAPI | |
| 条件タイプ | 条件タイプ | fixed、auto_renew、perpetual | はい | はい | 文字列（255） | ||
| 契約解消 | 契約解消 | はい | はい | ブール値 | |||
| 契約解消通知 | 契約解消通知 | yes、no | はい | はい | 文字列（255） | ||
| 契約解消通知の長さ単位 | 契約解消通知期間の単位（日/月/年） | days、months、years | はい | はい | 文字列（255） | ||
| 契約解消通知の長さ値 | 契約解消通知の長さの値 | はい | はい | 整数 | |||
| 条件 | 条件 | はい | はい | テキスト | |||
| type | 契約タイプ | MasterContract、AmendmentContract | はい | string型 | |||
| updated-at | 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます | はい | 日時 | ||||
| 更新者 | 更新したユーザー | はい | ユーザー | ||||
| use-order-windows | 注文ウィンドウを使用する | はい | はい | ブール値 | |||
| 購買用の | 購入に使用 | はい | はい | ブール値 | |||
| version | version | はい | はい | 整数 | |||
| 最大支出額に基づく支出の停止 | 最大値に基づいて支出を停止 | no | no | yes、no | はい | はい | 文字列（255） |
| external_contract_id | 外部契約識別子 | no | no | はい | はい | 文字列（255） | |
| 紙媒体 | 紙媒体の所有者 | no | no | not_specified、our_paper、counterparty_paper | はい | はい | 整数 |
| contract_dispute | no | no | はい | はい | |||
| 知的財産とデータ | no | no | はい | はい | |||
| 電子署名プロバイダーアカウント | no | no | はい | はい | |||
| 契約条項 | no | no | はい | はい | [] | ||
| 使用オンライン署名 | 電子署名が必要 | no | no | はい | ブール値 | ||
| contract_classification | 契約の分類 | no | no | はい | はい | ||
| contract_detail | 契約詳細 | no | no | はい | はい | ||
| contract_parties_field_container | 契約関係者フィールドコンテナ | no | no | はい | はい | ||
| contract_terms_and_renewal | 契約条件と更新 | no | no | はい | はい | ||
| 契約解消 | 契約解消 | no | no | はい | はい | ||
| contract_performance | 契約履行 | no | no | はい | はい | ||
| contract_price_and_payment | 契約価格と支払 | no | no | はい | はい | ||
| contract_relationship_and_reporting | 契約関係とレポート | no | no | はい | はい |
メモ
- 大規模な契約データセットを扱う場合は、いくつかの基準でGETを常に制限してください。
- コンテンツグループとカテゴリーはシステムにすでに存在している必要があります。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。