Contracts API (/ contracts)
契約APIを使用して、関連するビジネスグループ、主要な日付、契約のステータス、財務条件などの契約を作成、更新、またはクエリします。
概要
契約APIを使用して、関連するビジネスグループ、主要な日付、契約のステータス、財務条件などの契約を作成、更新、またはクエリします。
契約にアクセスするためのURLは次のとおりです: https :// {your_instance_name}/api/contracts
詳細については、統合のベストプラクティスを参照してください。
子オブジェクト
- 契約APIの呼び出しの例
- 契約分類API
- 契約条項API
- 契約条項参照API
- 契約内容API
- 契約修正依頼API
- 契約関係者API
- 契約関係者連絡先API
- 契約テンプレートAPI (/ contracts/templates)
- 契約期間API
- 契約タイプAPI
- Country Subdivision API
- 知的財産とデータAPI
- Reason Insights API
- Reason Insights Events API
アクション
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| プット | /api/contracts /: id/add_approver |
add_approver | 契約の承認者を手入力で追加 |
| プット | /api/contracts /: id/ccc_signature_created |
ccc_signature_created | CCCで署名が追加されたことを通知します。 |
| プット | /api/contracts /: id/complete |
完了 | 契約を完了状態に移行します。 |
| 投稿 | /api/contracts |
作成 | 契約を作成 |
| 投稿 | /api/contracts /: id/create_published |
create_published | /api/contracts /: id/create_published |
| 取得 | /api/contracts |
index | 契約を問い合わせ |
| 投稿 | /api/contracts /: id/legal_agreement |
legal_agreement | LEGAL LEGAL_AGREEMENTファイルを追加または更新 |
| プット | /api/contracts /: id/legal_agreement |
legal_agreement | LEGAL LEGAL_AGREEMENTファイルを追加または更新 |
| プット | /api/contracts /: id/remove_approval |
remove_approval | 手入力で追加された承認者を削除 |
| 取得 | /api/contracts /: id/retrieve_legal_agreement |
retrieve_legal_agreement | Legal legal_agreementファイルを取得する |
| 取得 | /api/contracts /: id |
表示 | 契約を表示 |
| プット | /api/contracts /: id/submit_for_approval |
submit_for_approval | 契約を承認のために提出します。 |
| プット | /api/contracts /: id |
update | 連絡先の更新 |
| プット | /api/contracts /: id/update_published |
update_published | 契約が公開されると更新されます。* |
| プット | /api/contracts /: id/withdraw_signatures |
withdraw_signatures | CCC withdraw_signaturesの後、契約を該当するステータスに移す |
*完了または公開された契約を(ドラフトを作成せずに直接)更新するには、会社の設定([設定] > [会社情報])で契約階層を有効にする必要があります。CLM Standardをお持ちでない場合は、契約の改訂を行うことができます。
要素
| 要素 | 説明 | 申請書 | 一意 | 許容値 | In | アウト | データタイプ |
|---|---|---|---|---|---|---|---|
| amended - contract - type | 修正契約タイプ | はい | はい | string (255) | |||
| 自動延長- end - date - for - renewal | 有効期限を自動更新 | はい | はい | boolean | |||
| 同意 | 同意通知 | notice、consent、not_required、not_assignable | はい | はい | string (255) | ||
| content - groups | ビジネスグループ | はい | はい | ビジネスグループ | |||
| contract - owner | 契約所有者 | はい | はい | ユーザー | |||
| 契約期間 | contract_terms | はい | はい | 契約期間 | |||
| contract - type | カテゴリ化のためのカスタム定義ラベル | いいえ | no | 任意の | はい | はい | |
| contract - type - custom - field -1 | 契約タイプのカスタムフィールド1 | no | no | 任意の | はい | はい | string (255) |
| contract - type - custom - field -2 | 契約タイプのカスタムフィールド2 | no | いいえ | any | はい | はい | string (255) |
| contract - type - custom - field -3 | 契約タイプのカスタムフィールド3 | no | no | any | はい | はい | string (255) |
| contract - type - custom - field -4 | 契約タイプカスタムフィールド4 | いいえ | no | 任意の | はい | はい | string (255) |
| contract - type - custom - field -5 | 契約タイプカスタムフィールド5 | no | いいえ | 任意の | はい | はい | string (255) |
| contract - type - custom - field -6 | 契約タイプのカスタムフィールド6 | いいえ | no | 任意の | はい | はい | string (255) |
| contract - type - custom - field -7 | 契約タイプのカスタムフィールド7 | no | いいえ | any | はい | はい | string (255) |
| contract - type - custom - field -8 | 契約タイプのカスタムフィールド8 | no | no | 任意の | はい | はい | string (255) |
| contract - type - custom - field -9 | 契約タイプカスタムフィールド9 | no | いいえ | 任意の | はい | はい | string (255) |
| contract - type - custom - field -10 | 契約タイプのカスタムフィールド10 | いいえ | no | any | はい | はい | string (255) |
| created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| created - by | 作成したユーザー | はい | ユーザー | ||||
| 通貨 | 契約通貨コード | はい | はい | 通貨 | |||
| current - approval | 現在の承認 | はい | 承認 | ||||
| current - parallel - approvals | 現在の並列承認 | はい | 承認 | ||||
| default - account | default_account | はい | はい | 勘定科目 | |||
| 部署 | オーナー部門 | no | no | 任意の | はい | はい | 部署 |
| 説明 | 契約に関する説明 | 偽 | 偽 | 任意の | はい | はい | string (1024) |
| diversity - categories | のサプライヤー多様性カテゴリ | はい | string | ||||
| end - date | 有効期限 | no | はい | はい | 日時 | ||
| execution - date | 契約が完了し、法的拘束力を持つ日付 | いいえ | no | 任意の | はい | はい | 日時 |
| iD | Coupaの一意の識別子 | はい | 整数 | ||||
| is - default | サプライヤー請求書の既定勘定科目 | はい | はい | boolean | |||
| legal - agreement - url | 契約書のURL (任意) | はい | はい | string (255) | |||
| length - of - notice - unit | 通知の期間の単位(日/月/年) | 日、月、年 | はい | はい | string (255) | ||
| length - of - notice - value | 通知の期間の値 | はい | はい | string (255) | |||
| locked - by - other - party | 編集ロックを保持しているCLMS契約当事者 | いいえ | no | はい | string | ||
| locked - by - user - id | 編集ロックを保持しているCLMSユーザー | no | いいえ | はい | 整数 | ||
| マスターコントラクト | マスター契約番号または名前 | はい | はい | 契約 | |||
| max - commit | 最大コミット金額 | はい | はい | 小数( 32,4 ) | |||
| maximum - value | コミット金額上限 | はい | はい | 小数( 32,4 ) | |||
| min - commit | 最小コミット金額 | はい | はい | 小数( 32,4 ) | |||
| minimum - value | 最小コミット金額 | はい | はい | 小数( 32,4 ) | |||
| 名前 | 契約名 | はい | はい | はい | はい | string (100) | |
| no - of - renewals | 更新の数 | はい | 許容値に[" 1... 100 "]が含まれるようになりました | はい | はい | 整数 | |
| number | 契約番号 | はい | はい | はい | はい | string (50) | |
| order - window - tz | order_window_tz | 有効なタイムゾーン | はい | はい | string (255) | ||
| 親 | 親 | はい | はい | 契約 | |||
| payment - term | 契約の支払期限コード | はい | はい | 支払条件 | |||
| po - message | 注文ウィンドウ発注書メッセージ | はい | はい | string (255) | |||
| preferred | サプライヤー向けの優先契約を示す | はい | はい | boolean | |||
| proxy - supplier - id | 代理サプライヤーの識別子 | any | はい | はい | 整数 | ||
| published - date | 契約が発行された日付 | no | いいえ | 任意の | はい | はい | 日時 |
| quote - response - id | 見積回答のID | はい | 整数 | ||||
| ra - risk - request | Raリスクリクエスト | はい | RaRiskRequest | ||||
| reason - insight - events | 理由インサイトイベント | はい | はい | はい | 理由インサイトイベント | ||
| renewal - length - unit | 更新期間の単位(日/月/年) | はい | 日、月、年 | はい | はい | string (255) | |
| renewal - length - value | 更新期間の値 | はい | はい | はい | 整数 | ||
| requisition - message | 注文ウィンドウ申請書メッセージ | はい | はい | string (255) | |||
| reviewer - user - id | CLMS内部レビュー担当者 | no | no | はい | 整数 | ||
| savings - pct | 契約価格設定によるコスト節約 | 0 ~ 100のパーセンテージ | はい | はい | 小数( 20,2 ) | ||
| スケジュール | スケジュール | はい | はい | 注文ウィンドウ | |||
| shipping - term | 契約上の配送条件コード | はい | はい | 発送条件 | |||
| source - id | 契約作成のソースID | はい | はい | 刺す(255) | |||
| source - type | 契約作成のソースタイプ | はい | はい | string (255) | |||
| start - date | 開始日 | はい | はい | 日時 | |||
| ステータス | 契約のステータス | はい | はい | はい | ドラフト | ||
| strict - invoicing - rules | 厳密な請求書作成の規則 | はい | はい | boolean | |||
| stop - spend - based - on - max - value | 上限値に基づく支出の停止 | no | no | はい、いいえ | はい | はい | string (255) |
| 送信者 | 承認のために契約を提出したユーザー | はい | ユーザー | ||||
| サプライヤー | サプライヤー名 | はい | はい | はい | サプライヤー | ||
| サプライヤーアカウント | サプライヤーアカウント番号 | はい | はい | string (255) | |||
| サプライヤー請求可能 | サプライヤーは直接請求できます | はい | はい | boolean | |||
| タグ | タグ付け | no | no | はい | はい | タグ付けAPI | |
| タグ | タグ | no | いいえ | はい | はい | タグAPI | |
| term - type | 条件の種類 | fixed、auto_renew、perpetual | はい | はい | string (255) | ||
| terminated | 契約解消 | はい | はい | boolean | |||
| termination - notice | 解消通知 | はい、いいえ | はい | はい | string (255) | ||
| termination - notice - length - unit | 契約解消通知の単位の長さ(日/月/年) | 日、月、年 | はい | はい | string (255) | ||
| termination - notice - length - value | 契約解消通知の長さの値 | はい | はい | 整数 | |||
| 条件 | 条件 | はい | はい | テキスト | |||
| タイプ | 契約タイプ | マスター契約、修正契約 | はい | string | |||
| updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| 更新者: | 更新したユーザー | はい | ユーザー | ||||
| use - order - windows | 注文ウィンドウを使用する | はい | はい | boolean | |||
| used - for - buy | 購入に使用 | はい | はい | boolean | |||
| バージョン | バージョン | はい | はい | 整数 | |||
| stop - spend - based - on - max - value | 上限値に基づく支出の停止 | no | いいえ | はい、いいえ | はい | はい | string (255) |
| external_contract_id | 外部契約識別子 | いいえ | no | はい | はい | string (255) | |
| fill - with - counterparty | 取引先を入力 | はい | はい | boolean | |||
| whose_paper | 紙媒体の所有者 | no | いいえ | not_specified, our_paper, counterparty_paper | はい | はい | 整数 |
| contract_dispute | no | いいえ | はい | はい | |||
| intellectual_property_and_data | no | no | はい | はい | |||
| esign_provider_account | no | no | はい | はい | |||
| contract_clauses | no | no | はい | はい | [] | ||
| use_online_signing | 電子署名が必要 | いいえ | いいえ | はい | boolean | ||
| contract_classification | 契約の分類 | no | いいえ | はい | はい | ||
| contract_detail | 契約の詳細 | no | いいえ | はい | はい | ||
| contract_parties_field_container | 契約当事者フィールドコンテナ | no | no | はい | はい | ||
| contract_terms_and_renewal | 契約の期間と更新 | いいえ | いいえ | はい | はい | ||
| contract_termination | 契約の終了 | いいえ | no | はい | はい | ||
| contract_performance | 契約の履行 | no | いいえ | はい | はい | ||
| contract_price_and_payment | 契約価格と支払 | いいえ | no | はい | はい | ||
| contract_relationship_and_reporting | 契約関係と報告 | いいえ | no | はい | はい |
メモ
- 契約の大きなデータセットを扱う場合は、常にいくつかの基準でGETを制限してください。
- コンテンツグループとカテゴリはすでにシステムに存在している必要があります。