発注書API (/ purchase_orders)
発注書APIを使用して、発注書を作成、更新、または照会します。
概要
発注書APIを使用する場合、いくつかのリソースエンドポイントを使用できます。
| リソース | パス | 説明 |
|---|---|---|
| POヘッダー | /api/purchase_orders |
PO明細、支払条件、住所などを含む完全な発注書。 |
| PO品目 | /api/purchase_order_lines |
アイテム情報や会計の詳細などの発注明細に関する詳細情報。詳細については、発注書明細APIと発注書明細割り当てAPIを参照してください。 |
| POの変更 | /api/purchase_order_changes |
PO変更リクエストが承認を促進するかどうかにかかわらず、PO変更リクエストを作成し、管理します。 |
| 理由の分析データ | /api/reason_insights/ |
注文を再開する際の理由を記入してください。 |
アクション
発注書APIを使用すると、次のことができます。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| プット | /api/purchase_orders /: id/cancel |
cancel | キャンセル |
| プット | /api/purchase_orders /: id/close |
終了 | 発注書を閉じます。詳細については、発注書の終了を参照してください。 |
| 投稿 | /api/purchase_orders |
作成 | 外部発注書機能の一部として発注書を作成します。CoupaベースのPOには使用しないでください。 |
| プット | /api/purchase_orders /: id/ignore_window_and_issue |
ignore_window_and_issue | ウィンドウと問題を無視する |
| 取得 | /api/purchase_orders |
index | 発注書を問い合わせ |
| プット | /api/purchase_orders /: id/issue |
issue | 発注書を発行し、サプライヤーに送ります。 |
| プット | /api/purchase_orders /: id/issue_without_send |
issue_without_send | サプライヤーに発注書を送らずに問題が発生しました。 |
| プット | /api/purchase_orders /: id/release_from_buyer_hold |
バイヤーの保留からのリリース | 購入者が保留中の発注書をリリース |
| プット | /api/purchase_orders /: id/reopen |
再開する | ソフトクローズされた発注書を再度開きます。ソフトクローズの詳細については、発注書のクローズを参照してください。 |
| 取得 | /api/purchase_orders /: id |
表示 | 発注書を表示 |
| パッチ | /api/purchase_orders /: id |
更新 | 発注書を更新 |
| プット | /api/purchase_orders /: id |
update | 発注書を更新 |
要素
| 要素 | 説明 | 申請済み | 一意 | 許容値 | In | アウト | データタイプ |
|---|---|---|---|---|---|---|---|
| acknowledged - at | acknowledged_at | はい | 日時 | ||||
| acknowledged - flag | 発注書はサプライヤーの承認を受けていますか？ | はい | はい | boolean | |||
| 添付ファイル | 添付ファイル | はい | はい | 添付 | |||
| change - type | 発注書の最新の変更タイプです。発注書の変更が申請によるものか、修正によるものかを示します。 | 変更、改訂、確認 | はい | string (255) | |||
| coupa - accelerate - status | 請求書の固定割引による割引支払条件の有無を示すステータス | 加速 | はい | string (255) | |||
| created - at | Coupaで日付レコードが作成されました。 | はい | 日時 | ||||
| created - by | 請求書を作成したユーザーのCoupa ID | はい | ユーザー | ||||
| currency | 取引の通貨 | はい | はい | 通貨 | |||
| current - integration - history - records | 連携履歴レコードをスキップ | はい | 連携履歴レコード | ||||
| exported | 取引がエクスポートされたか示します | はい | boolean | ||||
| hide - price | サプライヤーに価格を表示しない。「はい」または「はい」 | no | no | はい | boolean | ||
| iD | Coupaの内部ID | はい | 整数 | ||||
| internal - revision | 内部改訂番号-内部での変更か、発注書がサプライヤーに再送信される変更が発生するたびに増加します。 | はい | 整数 | ||||
| invoice - stop | 請求書停止フラグ | はい | boolean | ||||
| last - exported - at | 取引が最後にエクスポートされた日時はYYYY - MM - DDTHH: MM: SS + HH: MMZの形式になります | はい | 日時 | ||||
| マイルストーン | マイルストーン | はい | はい | 購買::マイルストーン | |||
| order - lines | 注文品目 | はい | はい | はい | 注文明細 | ||
| payment - method | 支払方法 | はい | はい | string (255) | |||
| payment - term | 支払条件 | はい | はい | 支払条件 | |||
| pカード | pカード | はい | はい | Pcard | |||
| po - number | 発注番号 | はい | はい | はい | はい | string (20) | |
| price - hidden | サプライヤーに価格を表示しない。「はい」または「はい」 | はい | boolean | ||||
| reason - insight - events | 変更、再開などの理由インサイトイベント | はい | 理由インサイトイベント | ||||
| 請求者 | アカウントのログインを申請中 | はい | ユーザー | ||||
| requisition - header | 申請書ヘッダー | はい | 申請書ヘッダー | ||||
| ship - to - address | 発送先住所 | no | いいえ | any | はい | はい | 住所 |
| ship - to - Attention | 注文の宛先となるユーザー。船の注意を喚起してください。 | no | no | any | はい | はい | string (255) |
| ship - to - user | 発送先ユーザー | はい | はい | はい | ユーザー | ||
| shipping - term | 支払条件 | はい | はい | ShippingTerm | |||
| ステータス | 発注ステータス | buyer_hold, cancelled, closed, currency_hold, draft, error, expensed, issued, supplier_hold, supplier_window_hold, exported | はい | string (50) | |||
| サプライヤー | サプライヤーのCoupa内部ID番号 | はい | はい | はい | サプライヤー | ||
| supplier - site | サプライヤーサイト | no | いいえ | any | はい | はい | サプライヤーサイト |
| transmission - emails | コンマ区切りの送信メールリスト | no | いいえ | 任意の | はい | はい | テキスト |
| transmission - method - override | 送信方法の上書き | いいえ | no | サプライヤー_デフォルト、メール、送信しない | はい | はい | string (30) |
| transmission - status | 送信ステータス | no | no | 作成済み、延期された、延期された処理、保留中のマニュアル、保留中のマニュアルのキャンセル、オンライン購入の待ち時間、メールのスケジュール、メールの送信、cxmlのスケジュール、xmlのスケジュール、cxmlの送信、手動で送信、オンライン購入、トランスミッションの失敗 | はい | string | |
| タイプ | 注文のタイプ | ExternalOrderHeader | はい | string (255) | |||
| updated - at | 最終更新日: | はい | 日時 | ||||
| 更新者： | 請求書を作成したユーザーのCoupa ID | はい | ユーザー | ||||
| バージョン | 発注書サプライヤーバージョン番号-発注書が変更されると増加し、サプライヤーへの再送信がトリガーされます。 | はい | はい | 整数 | |||
| 分類 | 分類 | msp,サプライヤー, vms | はい | はい | string (255) | ||
| 通貨 | 取引の通貨 | はい | |||||
| confirm - by - hours | 確認者 | はい | 整数 | ||||
| order - confirmation - level | 確認レベル | はい | int (11) | ||||
| user - members | ユーザーメンバー | はい | ユーザー | ||||
| user - group - members | ユーザーグループのメンバー | はい | ユーザー | ||||
メモ
- ソースフィールドからの値に基づいてクエリ可能になる依存フィールドがあります。たとえば、po - method = emailに対してクエリ
を実行する場合、po - emailを追加のクエリ条件として追加できます。はい*のフィールドを参照してください。 - 大規模なデータセットやパフォーマンスの最適化のためには、常にいくつかのGET基準で結果を制限する必要があります。
- POの変更は、必ずしもバージョン番号を増やすとは限りません。詳細は、発注書の修正を引き起こすフィールドを参照してください。Updated -
atフィールドは、変更が加えられたかどうかを判断するために常に使用できます。
コード例
PUTを使用して注文品目を削除する
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<order-lines>
<order-line>
<id>coupa_line_id</id>
<_delete>true</_delete>
</order-line>
</order-lines>
</order-header> ソフトクローズ済みPOを再度開く
ソフトクローズの詳細については、発注書のクローズを参照してください。
Reason Insight IDの使用
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<reason-insight-id>1</reason-insight-id>
<reason-insight-event-comment>コメント本文</reason-insight-event-comment>
</order-header>Reason Insightコードを使用する
<?xml version="1.0" encoding="UTF-8"?>
<order-header>
<reason-insight-code>コード</reason-insight-code>
<reason-insight-event-comment>コメント本文</reason-insight-event-comment>
</order-header>