申請書API (/requisitions)

依頼にアクセスするためのURLは次のとおりです。 https ://{your_instance_name}/api/requisitions

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

申請書APIオブジェクト

以下は、UIを通じて利用可能な経費関連オブジェクトの全リストです。 ただし、すべてのオブジェクトにエンドポイントがあるわけではありません。一部は他のオブジェクトから参照されるのみで、直接更新できないものもあります。
注:
  • 静的な勘定科目表を使用してこのAPIを送信する場合、含まれるセグメント値が既存の勘定科目からのものである必要があります。
  • 動的な勘定科目表を使用してこのAPIを送信する場合、含まれるセグメント値は既存の勘定科目セグメントまたは検索値と一致する必要があります。 一致するセグメント値に対する勘定科目が存在しない場合は、APIにより自動で作成されます。

アクション

申請書APIでは以下の操作が可能です。

動詞パスアクション説明
PUT/api/requisitions /: id/add_approveradd_approver申請書に承認者を手動で追加
POST/api/requisitions/add_to_cartadd_to_cartカートに追加
POST/aPI/申請書
作成下書き状態の申請書を作成(手動での送信が必要)
GET/api/requisitions/current_cartcurrent_cart現在のカート情報を取得。存在しない場合は作成・送信されます
GET/aPI/申請書
インデックス申請書の照会
GET/api/requisitions/mine自分/api/requisitions/mine
PUT/api/requisitions /: id/remove_approvalremove_approval手動で追加された承認者を削除
PUT/api/requisitions /: id/save_for_latersave_for_laterAPI申請書のために保存して後で処理
GET/api/requisitions /: id表示申請書を表示
POST/api/requisitions/submit_for_approvalsubmit_for_approval申請書を作成し、承認/バイヤーアクションのために送信
PUT/api/requisitions /: id更新申請書を更新
PUT/api/requisitions /: id/update_and_submit_for_approvalupdate_and_submit_for_approval申請書を更新して、承認申請を送信
DELETE/api/requisitions /: id削除申請書を削除
POST/api/requisitions/schedule_issuanceschedule_issuance申請明細の発行日を設定し、スケジュールされた日付までに申請が承認されない場合は、設定された日数後に発行を再試行することもできます。

ペイロードの例：

{" requisition_line_ids ":[ 54214,54220,54224 ]," schedule_issuance_date ":" MM/DD/YYYY "," schedule_retry_interval ": 10}

詳細については、 スケジュールPO発行APIを参照してください。

POST/api/requisitions/unschedule_issuanceunschedule_issuance申請明細からスケジュールされた発行日と再試行間隔を削除します。

ペイロードの例：

{" requisition_line_ids ": [54215, 54216, 54217]}

詳細については、 スケジュールPO発行APIを参照してください。

Elements

要素Description必須一意許容値入力出力データタイプ
approvals承認yes
承認
current-parallel-approvals現在の並行承認yes
承認
approverapproveryes
ユーザー
添付ファイル添付ファイルyes
添付ファイル
buyer-noteバイヤーからのコメントまたはメモyes
yes
テキスト
作成日時CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成しますyes
datetime
created-by作成したユーザーyes
yes
yes
ユーザー
currencyCurrency Codeyes
USD
current-approval現在/承認待ちyes
承認
部署申請書部署yes
yes
部署
exported取引がエクスポート済みかどうかを示すyes
boolean
external-po-reference外部発注書参照。顧客が自動生成された発注番号を上書きする発注番号を提供できるようにしますnoyes
anyyes
string(255)
hide-priceサプライヤーに対し価格を非表示にします。 (TrueまたはFalse)nonoyes
RequisitionHeader
IDCoupaの一意の識別子yes
整数
理由申請の理由コメントyes
yes
テキスト
last-exported-at最終エクスポート時刻yes
datetime
line-count申請書ヘッダー明細数nonoanyyes
整数
milestonesマイルストーンyes
yes
Procurement::Milestone
mobile-currency既定の通貨yes
USD
mobile-totaltotalyes
小数
納品希望日納品希望日yes
yes
datetime
PカードPカード名yes
yes
Pカード
price-hiddenサプライヤーに価格を非表示にするか (TrueまたはFalse)yes
boolean
receiving-warehouse-id受領倉庫IDnonoanyyes
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-atsubmitted_atyes
datetime
タグyes
yes
[]
taggingsyes
yes
[]
total自国通貨での合計金額yes
小数
updated-atCoupaが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、サプライヤー予備品番に一致する、優先または最も安価なサプライヤーアイテム。
注:
  • サプライヤーアイテムがカタログに紐づいている場合、そのカタログは「承認済み」ステータスであり、かつ現在の日付がカタログの開始日および終了日の範囲内である必要があります。
  • サプライヤーアイテムが契約に紐づいている場合、その契約は「公開済み」ステータスであり、かつ現在の日付がカタログの開始日および終了日の範囲内である必要があります。