申請書API (/requisitions)
依頼にアクセスするためのURLは次のとおりです。 https ://{your_instance_name}/api/requisitions
詳細については、統合のベストプラクティスを参照してください。
申請書APIオブジェクト
以下は、UIを通じて利用可能な経費関連オブジェクトの全リストです。 ただし、すべてのオブジェクトにエンドポイントがあるわけではありません。一部は他のオブジェクトから参照されるのみで、直接更新できないものもあります。
注:
- 静的な勘定科目表を使用してこのAPIを送信する場合、含まれるセグメント値が既存の勘定科目からのものである必要があります。
- 動的な勘定科目表を使用してこのAPIを送信する場合、含まれるセグメント値は既存の勘定科目セグメントまたは検索値と一致する必要があります。 一致するセグメント値に対する勘定科目が存在しない場合は、APIにより自動で作成されます。
アクション
申請書APIでは以下の操作が可能です。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| PUT | /api/requisitions /: id/add_approver |
add_approver | 申請書に承認者を手動で追加 |
| POST | /api/requisitions/add_to_cart |
add_to_cart | カートに追加 |
| POST | /aPI/申請書 |
作成 | 下書き状態の申請書を作成(手動での送信が必要) |
| GET | /api/requisitions/current_cart |
current_cart | 現在のカート情報を取得。存在しない場合は作成・送信されます |
| GET | /aPI/申請書 |
インデックス | 申請書の照会 |
| GET | /api/requisitions/mine |
自分 | /api/requisitions/mine |
| PUT | /api/requisitions /: id/remove_approval |
remove_approval | 手動で追加された承認者を削除 |
| PUT | /api/requisitions /: id/save_for_later |
save_for_later | API申請書のために保存して後で処理 |
| GET | /api/requisitions /: id |
表示 | 申請書を表示 |
| POST | /api/requisitions/submit_for_approval |
submit_for_approval | 申請書を作成し、承認/バイヤーアクションのために送信 |
| PUT | /api/requisitions /: id |
更新 | 申請書を更新 |
| PUT | /api/requisitions /: id/update_and_submit_for_approval |
update_and_submit_for_approval | 申請書を更新して、承認申請を送信 |
| DELETE | /api/requisitions /: id |
削除 | 申請書を削除 |
| POST | /api/requisitions/schedule_issuance |
schedule_issuance | 申請明細の発行日を設定し、スケジュールされた日付までに申請が承認されない場合は、設定された日数後に発行を再試行することもできます。 ペイロードの例： 詳細については、 スケジュールPO発行APIを参照してください。 |
| POST | /api/requisitions/unschedule_issuance |
unschedule_issuance | 申請明細からスケジュールされた発行日と再試行間隔を削除します。 ペイロードの例： 詳細については、 スケジュールPO発行APIを参照してください。 |
Elements
| 要素 | Description | 必須 | 一意 | 許容値 | 入力 | 出力 | データタイプ |
|---|---|---|---|---|---|---|---|
| approvals | 承認 | yes | 承認 | ||||
| current-parallel-approvals | 現在の並行承認 | yes | 承認 | ||||
| approver | approver | yes | ユーザー | ||||
| 添付ファイル | 添付ファイル | yes | 添付ファイル | ||||
| buyer-note | バイヤーからのコメントまたはメモ | yes | yes | テキスト | |||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | yes | yes | ユーザー | ||
| currency | Currency Code | yes | USD | ||||
| current-approval | 現在/承認待ち | yes | 承認 | ||||
| 部署 | 申請書部署 | yes | yes | 部署 | |||
| exported | 取引がエクスポート済みかどうかを示す | yes | boolean | ||||
| external-po-reference | 外部発注書参照。顧客が自動生成された発注番号を上書きする発注番号を提供できるようにします | no | yes | any | yes | string(255) | |
| hide-price | サプライヤーに対し価格を非表示にします。 (TrueまたはFalse) | no | no | yes | RequisitionHeader | ||
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| 理由 | 申請の理由コメント | yes | yes | テキスト | |||
| last-exported-at | 最終エクスポート時刻 | yes | datetime | ||||
| line-count | 申請書ヘッダー明細数 | no | no | any | yes | 整数 | |
| milestones | マイルストーン | yes | yes | Procurement::Milestone | |||
| mobile-currency | 既定の通貨 | yes | USD | ||||
| mobile-total | total | yes | 小数 | ||||
| 納品希望日 | 納品希望日 | yes | yes | datetime | |||
| Pカード | Pカード名 | yes | yes | Pカード | |||
| price-hidden | サプライヤーに価格を非表示にするか (TrueまたはFalse) | yes | boolean | ||||
| receiving-warehouse-id | 受領倉庫ID | no | no | any | yes | yes | 整数 |
| recurring-rules | 繰り返しルール | yes | |||||
| reject-reason-comment | 前回の却下理由コメント | yes | 文字列 | ||||
| req_title | オプションの申請書タイトル | yes | yes | string(50) | |||
| requested-by | 申請者 | yes | yes | ユーザー | |||
| 申請者 | 申請者 | yes | yes | ユーザー | |||
| requisition-lines | 申請明細 | yes | yes | yes | RequisitionLine | ||
| ship-to-address | 住所の名前 | yes | yes | yes | 住所 | ||
| 発送先宛名 | 発送先住所(宛名) | yes | yes | string(255) | |||
| status | 取引ステータス. 申請ステータスの詳細については、申請ステータスの定義を参照してください。 | yes |
draft、cart、pending_buyer_action、pending_approval、 approved ordered partially_received、received、 abandoned、backgrounded、withdrawn |
yes | string(50) | ||
| submitted-at | submitted_at | yes | datetime | ||||
| タグ | yes | yes | [] | ||||
| taggings | yes | yes | [] | ||||
| total | 自国通貨での合計金額 | yes | 小数 | ||||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-by | 更新したユーザー | yes | ユーザー | ||||
| user_members | ユーザーメンバー | yes | ユーザー | ||||
| user_group_members | ユーザーグループメンバー | yes | ユーザー |
注:
created_by要素はAPIユーザーキーからデフォルト設定されますが、申請APIによって上書きすることが可能です。 申請APIにAPIユーザーキー値の上書きを許可するには、Coupaサポートにお問い合わせください。
注:
- requisition-lineでは、description (フリーフォーム)またはitem (カタログアイテム)のいずれかを使用できます。 アイテムIDを使用する場合は、該当のアイテムが存在している必要があります。 <source-type></source-type>は使用されておらず、無視されます。
- requested-byにおける通貨、ユーザー、サプライヤーは、システム上でステータスが「アクティブ」である必要があります。
- Item:アイテムに対して優先サプライヤーおよび価格が存在する場合、それが使用されます。 ただし、unit-priceが指定されている場合は、アイテムに設定されたデフォルト価格を上書きします。 descriptionとitemの両方を指定してもエラーにはなりませんが、itemを使用すると、descriptionはitemの説明に置き換えられ、指定したdescriptionフィールドは無視されます。
- デフォルト設定: XML内で特に指定がない限り、システム内の関連デフォルト設定が適用されます。 たとえば、支払および発送の条件はサプライヤーレコードからのデフォルト設定が適用されます。
- 明細番号: APIはline-numが新しい明細ごとに1ずつ増加することを想定しています。 同じline-numを使用すると、システムは同じ番号の他のすべての明細を無視します。
- バージョン30.2.2のリリースアップデートの一環として、申請者のコンテントグループ外のユーザーに対して申請書を作成できない問題を修正しました。 これにより、申請APIはUIの動作を反映するようになりました。
-
バージョン34.4.0のリリースアップデートの一環として、申請APIを使用して、他の申請書から明細を挿入することで新しい申請書を作成できるようになりました。ただし、参照元の申請書のステータスが下書きの場合に限ります。 申請書のステータスが下書きでない場合、その申請書のいかなる明細も新しい申請書作成に参照することはできません。
API経由で「作成者」ユーザーが設定される場合、そのユーザーのコンテンツグループへのアクセス権が、申請書作成のために検証されます。 詳細は以下の表をご参照ください。
| allow_created_by_override_via_api | 作成者はコンテンツグループを介してアクセスできる | 申請者はコンテンツグループを介してアクセスできる | API経由の作成を許可する |
|---|---|---|---|
| 真 | はい | 該当なし | はい |
| 真 | N | 該当なし | N |
| FALSE | 該当なし | 該当なし | はい |
既定のサプライヤーアイテムの動作
API経由で数量ベースの明細を含む申請書が作成された場合、以下のルールに基づいて、申請明細にサプライヤーアイテムがデフォルトで設定されます。
| APIペイロード | 期待される結果 |
|---|---|
| アイテムID | 優先または最も安価なサプライヤーアイテム |
| アイテムID、サプライヤー | 指定されたサプライヤーIDに一致する、優先または最も安価なサプライヤーアイテム |
| アイテムID、サプライヤー、ソース品番 | 指定されたサプライヤーIDとソース品番に一致する、優先または最も安価なサプライヤーアイテム |
| アイテムID、サプライヤー、ソース品番、サプライヤー予備品番 | 指定されたサプライヤーID、ソース品番、サプライヤー予備品番に一致する、優先または最も安価なサプライヤーアイテム。 |
| アイテムID、サプライヤー、契約 | 指定されたサプライヤーIDと契約IDに一致する、優先または最も安価なサプライヤーアイテム |
| アイテムID、サプライヤー、契約、価格 | 指定されたサプライヤーIDと契約IDに一致する、優先または最も安価なサプライヤーアイテム(価格は一致条件に含まれません) |
| アイテムID、サプライヤー、契約、ソース品番 | 指定されたサプライヤーID、契約ID、ソース品番に一致する、優先または最も安価なサプライヤーアイテム |
| アイテムID、サプライヤー、契約、ソース品番、サプライヤー予備品番 | 指定されたサプライヤーID、契約ID、サプライヤー予備品番に一致する、優先または最も安価なサプライヤーアイテム。 |
注:
- サプライヤーアイテムがカタログに紐づいている場合、そのカタログは「承認済み」ステータスであり、かつ現在の日付がカタログの開始日および終了日の範囲内である必要があります。
- サプライヤーアイテムが契約に紐づいている場合、その契約は「公開済み」ステータスであり、かつ現在の日付がカタログの開始日および終了日の範囲内である必要があります。