契約API (/contracts)

概要

契約APIを使用して、関与するビジネスグループ、主要な日付、契約のステータス、財務条件などで、契約の作成、更新、検索を行います。

コントラクトにアクセスするためのURLは次のとおりです。 https ://{your_instance_name}/api/contracts

詳細については、統合のベストプラクティスを参照してください。

アクション

動詞 パス アクション Description
PUT /api/contracts /: id/add_approver add_approver 契約書に承認者を手動で追加
PUT /api/contracts /: id/ccc_signature_created ccc_signature_created CCCで署名が追加されたことを通知します。
PUT /api/contracts /: id/check_in check_in 法的書類をチェックインする
PUT /api/contracts /: id/check_out check_out 法的書類をご確認ください。
PUT /api/contracts /: id/complete complete 契約を完了状態に移動
POST /aPI/契約 作成 契約を作成
POST /api/contracts /: id/create_published create_published /api/contracts /: id/create_published
GET /aPI/契約 インデックス 契約書を検索
POST /api/contracts /: id/legal_agreement legal_agreement 法的なlegal_agreementファイルを追加または更新
PUT /api/contracts /: id/legal_agreement legal_agreement 法的なlegal_agreementファイルを追加または更新
PUT /api/contracts /: id/remove_approval remove_approval 手動で追加された承認者を削除
GET /api/contract /: id/retrieve_legal_agreement retrieve_legal_agreement 法的なlegal_agreementファイルを取得
GET /api/contract /: id/retrieve_executive_summary retrieve_executive_summary エグゼクティブサマリーファイルを取得する
GET /api/contracts /: id 表示 契約を表示
PUT /api/contracts /: id/submit_for_approval submit_for_approval 承認のために契約を送信
PUT /api/contracts /: id 更新 契約を更新
PUT /api/contracts /: id/update_published update_published 契約が公開されると更新されます。*
PUT /api/contracts /: id/withdraw_signatures withdraw_signatures CCC withdraw_signaturesの後、契約を該当するステータスに移す

*締結完了済み または 公開済み契約の更新 （ドラフトを作成せずに直接更新）には、 有効化契約階層 が会社の設定でオンになっている必要があります（設定>会社情報）。 CLM Standardをお持ちでない場合は、契約の改訂に取り組むことができます。

Elements

要素 Description 必須 一意 許容値 入力 出力 データタイプ
amended-contract-type 修正された契約タイプ yes
 yes
 string(255)
auto-extend-end-date-for-renewal 有効期限を自動更新 yes
 yes
 boolean
consent 同意通知 通知、同意、必要なし、割当不可 yes
 yes
 string(255)
content-groups ビジネスグループ yes
 yes
 ビジネスグループ
contract-owner 契約オーナー yes
 yes
 ユーザー
contract-terms 契約期間 yes
 yes
 契約期間
contract-type カテゴリ化のためのカスタム定義ラベル no no any yes
 yes

contract-type-custom-field-1 契約タイプのカスタムフィールド1 no no any yes
 yes
 string(255)
contract-type-custom-field-2 契約タイプのカスタムフィールド2 no no any yes
 yes
 string(255)
contract-type-custom-field-3 契約タイプのカスタムフィールド3 no no any yes
 yes
 string(255)
contract-type-custom-field-4 契約タイプのカスタムフィールド4 no no any yes
 yes
 string(255)
contract-type-custom-field-5 契約タイプのカスタムフィールド5 no no any yes
 yes
 string(255)
contract-type-custom-field-6 契約タイプのカスタムフィールド6 no no any yes
 yes
 string(255)
contract-type-custom-field-7 契約タイプのカスタムフィールド7 no no any yes
 yes
 string(255)
contract-type-custom-field-8 契約タイプのカスタムフィールド8 no no any yes
 yes
 string(255)
contract-type-custom-field-9 契約タイプのカスタムフィールド9 no no any yes
 yes
 string(255)
contract-type-custom-field-10 契約タイプのカスタムフィールド10 no no any yes
 yes
 string(255)
作成日時 CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します yes
 datetime
created-by 作成したユーザー yes
 ユーザー
currency 契約通貨コード yes
 yes
 Currency
current-approval 現在の承認 yes
 承認
current-parallel-approvals 現在の並行承認 yes
 承認
default-account デフォルトアカウント yes
 yes
 アカウント
部署 所有者部署 no no any yes
 yes
 部署
description 契約に関する説明メモ false false any yes
 yes
 string(1024)
diversity-categories サプライヤー多様性カテゴリー yes
 文字列
終了日 有効期限 no yes
 yes
 datetime
execution-date 契約が完了し、法的拘束力がある日付 no no any yes
 yes
 datetime
ID Coupaの一意の識別子 yes
 整数
is-default サプライヤー請求書の既定勘定科目 yes
 yes
 boolean
legal-agreement-url 契約書のオプションのURL yes
 yes
 string(255)
length-of-notice-unit 通知の期間の単位(日/月/年) 日、月、年 yes
 yes
 string(255)
length-of-notice-value 通知の期間の値 yes
 yes
 string(255)
locked-by-other-party CLMS契約当事者が編集ロックを保持している no no yes
 文字列
locked-by-user-id 編集ロックを保持しているCLMSユーザー no no yes
 整数
master-contract マスター契約番号または名前 yes
 yes
 契約
max-commit 最大コミット金額 yes
 yes
 decimal(32,4)
maximum-value 最大コミット金額 yes
 yes
 decimal(32,4)
min-commit 最小コミット金額 yes
 yes
 decimal(32,4)
minimum-value 最小コミット金額 yes
 yes
 decimal(32,4)
名前 契約の名前 yes
 yes
 yes
 yes
 string(100)
no-of-renewals 更新の数 yes
 許容される値に["1..100"]が含まれるようになりました yes
 yes
 整数
数字 Contract Number yes
 yes
 yes
 yes
 string(50)
object-line オブジェクト明細 no no yes
 ObjectLine
order-window-tz order_window_tz 有効なタイムゾーン yes
 yes
 string(255)
親 親 yes
 yes
 契約
支払条件 契約の支払条件コード yes
 yes
 支払条件
po-message 発注ウィンドウ発注書メッセージ yes
 yes
 string(255)
preferred サプライヤーの優先契約を示す yes
 yes
 boolean
proxy-supplier-id 代理サプライヤーの識別子 any yes
 yes
 整数
published-date 契約が公開された日付 no no any yes
 yes
 datetime
quote-response-id 見積回答のID yes
 整数
ra-risk-request Raリスクリクエスト yes
 RaRiskRequest

rate-card 料金表 yes
 RateCard
reason-insight-events 理由インサイトイベント yes
 yes
 yes
 理由インサイトイベント
renewal-length-unit 更新期間の単位(日/月/年) yes
 日、月、年 yes
 yes
 string(255)
renewal-length-value 更新期間の値 yes
 yes
 yes
 整数
requisition-message 発注ウィンドウ申請書メッセージ yes
 yes
 string(255)
reviewer-user-ids CLMS内部レビュアー no no yes
 整数
savings-pct 契約価格設定による節減 0～100のパーセンテージ yes
 yes
 decimal(20,2)
schedule schedule yes
 yes
 発注ウィンドウ
発送条件 契約の発送条件コード yes
 yes
 発送条件
source-id 契約作成のソースID yes
 yes
 sting(255)
source-type 契約作成のソースタイプ yes
 yes
 string(255)
start-date Start Date yes
 yes
 datetime
status 契約のステータス yes
 yes
 yes
 draft
strict-invoicing-rules 厳密な請求書作成の規則 yes
 yes
 boolean
stop-spend-based-on-max-value 上限値に基づく支出の停止 no no yes, no yes
 yes
 string(255)
submitter 承認のために契約を送信したユーザー yes
 ユーザー
supplier Supplier Name yes
 yes
 yes
 サプライヤー
supplier-account サプライヤーアカウント番号 yes
 yes
 string(255)
supplier-invoiceable サプライヤーによる直接請求の可否 yes
 yes
 boolean
taggings タグ付け no no yes
 yes
 タグ付けAPI
タグ タグ no no yes
 yes
 タグAPI
term-type 条件の種類 固定、自動更新、永久 yes
 yes
 string(255)
terminated 解消済み yes
 yes
 boolean
termination-notice 契約解消通知 yes, no yes
 yes
 string(255)
termination-notice-length-unit 終了通知期間の単位(日/月/年) 日、月、年 yes
 yes
 string(255)
termination-notice-length-value 契約解消通知の長さの値 yes
 yes
 整数
条件 条件 yes
 yes
 テキスト
type 契約タイプ マスター契約、修正契約 yes
 文字列
updated-at CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します yes
 datetime
updated-by 更新したユーザー yes
 ユーザー
use-order-windows 注文ウィンドウを使用する yes
 yes
 boolean
used-for-buying 購入に使用 yes
 yes
 boolean
バージョン バージョン yes
 yes
 整数
stop-spend-based-on-max-value 上限値に基づく支出の停止 no no yes, no yes
 yes
 string(255)
external_contract_id 外部契約識別子 no no yes
 yes
 string(255)
fill-with-counterparty 取引先を入力 yes
 yes
 boolean
whose_paper 契約書の作成元 no no 指定なし、自社のもの、取引先のもの yes
 yes
 整数
contract_dispute no no yes
 yes

intellectual_property_and_data no no yes
 yes

esign_provider_account no no yes
 yes

contract_clauses no no yes
 yes
 []
use_online_signing 電子署名が必要 no no yes
 boolean
contract_classification 契約の分類 no no yes
 yes

contract_detail 契約の詳細 no no yes
 yes

contract_parties_field_container 契約関係者フィールドコンテナ no no yes
 yes

contract_terms_and_renewal 契約期間と更新 no no yes
 yes

contract_termination 契約解消 no no yes
 yes

contract_performance 契約評価 no no yes
 yes

contract_price_and_payment 契約価格と支払 no no yes
 yes

contract_relationship_and_reporting 契約関係とレポート no no yes
 yes

注:
  • 契約の大規模なデータセットを扱う場合は、常にいくつかの条件でGETを制限してください。
  • コンテンツグループとカテゴリはシステムにすでに存在している必要があります。