発注書API (/purchase_orders)
概要
発注書APIを使用する場合、次のリソースエンドポイントから作業することができます。
|
リソース |
パス |
Description |
|---|---|---|
|
発注書ヘッダー |
|
発注明細、支払条件、住所などを含む完全な発注書。 |
|
発注明細 |
|
アイテム情報や会計の詳細など、発注明細に関する詳細情報。 詳細については、発注明細APIと発注明細割当APIをご参照ください。 |
|
発注変更 |
|
承認を行うかどうかにかかわらず、発注変更リクエストを作成して管理します。 |
|
理由の洞察 |
|
発注を再開する際の理由を入力します。 |
アクション
発注書APIでは以下の操作が可能です。
|
動詞 |
パス |
アクション |
Description |
|---|---|---|---|
|
PUT |
|
cancel |
キャンセル |
|
PUT |
|
close |
発注書を終了します。 詳細については、発注書の終了をご参照ください。 |
|
POST |
|
作成 |
外部発注書機能の一部として発注書を作成します。 Coupaベースの発注書には使用しないでください。 |
|
PUT |
|
ignore_window_and_issue |
ウィンドウと問題を無視 |
|
GET |
|
インデックス |
発注書の検索 |
|
PUT |
|
issue |
発注書を発行し、サプライヤーに送信します。 |
|
PUT |
|
issue_without_send |
サプライヤーに発注書を送信せずに発行します。 |
|
PUT |
|
release_from_buyer_hold |
バイヤーが保留中の発注書をリリース |
|
PUT |
|
reopen |
仮完了の発注書を再開します。 仮完了の詳細については、発注書の完了をご参照ください。 |
|
GET |
|
表示 |
発注書を表示 |
|
PATCH |
|
更新 |
発注書を更新 |
|
PUT |
|
更新 |
発注書を更新 |
Elements
|
要素 |
Description |
必須 |
一意 |
許容値 |
入力 |
出力 |
データタイプ |
|---|---|---|---|---|---|---|---|
|
acknowledged-at |
acknowledged_at |
yes |
datetime |
||||
|
acknowledged-flag |
発注書はサプライヤーの承認を受けていますか? |
yes |
yes |
boolean |
|||
|
添付ファイル |
attachments |
yes |
yes |
||||
|
change-type |
発注書の最新の変更タイプです。発注書の変更が申請によるものか、修正によるものかを示します。 |
変更、修正、確認 |
yes |
string(255) |
|||
| confirmation_status | 確認ステータス | no | pending_supplier_action, confirmed, pending_buyer_action, completed, overridden, archived, pending_integration, integration_failed, backgrounded, po_revise_backgrounded, po_change_backgrounded, pending_approval, po_change_failed, reconfirmation_backgrounded, supplier_draft, buyer_draft, partially_confirmed | yes | string(255) | ||
|
coupa-accelerate-status |
請求書の固定割引による割引支払条件の有無を示すステータス |
accelerated |
yes |
string(255) |
|||
|
作成日時 |
Coupaで日付レコードが作成されました。 |
yes |
datetime |
||||
|
created-by |
請求書を作成したユーザーのCoupa ID |
yes |
|||||
|
currency |
取引の通貨 |
yes |
yes |
||||
|
current-integration-history-records |
現在の連携履歴レコード |
yes |
|||||
|
exported |
取引がエクスポート済みかどうかを示します。 デフォルトでは、エクスポートされたフィールドを更新している間に他のフィールドを更新することはできません。 この動作を変更するには、カスタマーサポートにお問い合わせください。 |
yes |
boolean |
||||
|
hide-price |
サプライヤーに対し価格を非表示にします。 (TrueまたはFalse) |
no |
no |
yes |
boolean |
||
|
ID |
Coupaの内部ID |
yes |
整数 |
||||
|
internal-revision |
内部修正番号 - 内部での変更か、発注書がサプライヤーに再送信される変更が発生するたびに増加します。 |
yes |
整数 |
||||
|
invoice-stop |
請求書停止フラグ |
yes |
boolean |
||||
|
last-exported-at |
取引が最後にエクスポートされた日時 (形式: YYYY-MM-DDTHH:MM:SS+HH:MMZ) |
yes |
datetime |
||||
|
milestones |
マイルストーン |
yes |
yes |
Procurement::Milestone |
|||
|
order-lines |
order_lines |
yes |
yes |
yes |
|||
|
payment-method |
payment_method |
yes |
yes |
string(255) |
|||
|
支払条件 |
支払条件 |
yes |
yes |
||||
|
Pカード |
Pカード |
yes |
yes |
Pカード |
|||
|
po-number |
発注番号 |
yes |
yes |
yes |
yes |
string(20) |
|
|
price-hidden |
サプライヤーに対し価格を非表示にします。 (TrueまたはFalse) |
yes |
boolean |
||||
|
reason-insight-events |
変更、再開などの理由インサイトイベント |
yes |
|||||
|
申請者 |
アカウントのログインを申請中 |
yes |
|||||
|
requisition-header |
申請書ヘッダー |
yes |
|||||
|
ship-to-address |
ship_to_address |
no |
no |
any |
yes |
yes |
|
|
発送先宛名 |
発注の宛先となるユーザー。 発送先宛名。 |
no |
no |
any |
yes |
yes |
string(255) |
|
ship-to-user |
ship_to_user |
yes |
yes |
yes |
|||
|
発送条件 |
支払条件 |
yes |
yes |
||||
|
ステータス |
発注書ステータス |
buyer_hold, cancelled, closed, currency_hold, draft, error, expensed, issued, supplier_hold, supplier_window_hold, exported |
yes |
string(50) |
|||
|
supplier |
サプライヤーのCoupa内部ID番号 |
yes |
yes |
yes |
|||
|
supplier-site |
サプライヤーサイト |
no |
no |
any |
yes |
yes |
|
|
transmission-emails |
送信メールのコンマ区切りリスト |
no |
no |
any |
yes |
yes |
text |
|
transmission-method-override |
送信方法の上書き |
no |
no |
supplier_default, email、do_not_transmit |
yes |
yes |
string(30) |
|
transmission-status |
送信ステータス |
no |
no |
created, deferred, deferred_processing, pending_manual, pending_manual_cancel, awaiting_online_purchase, scheduled_for_email, sent_via_email, scheduled_for_cxml, scheduled_for_xml, sent_via_cxml, sent_via_xml, sent_manually, purchased_online, transmission_failure |
yes |
文字列 |
|
| total | 合計 | no | decimal(32,4) | ||||
|
type |
発注のタイプ |
ExternalOrderHeader |
yes |
string(255) |
|||
|
updated-at |
最終更新日 |
yes |
datetime |
||||
|
updated-by |
請求書を作成したユーザーのCoupa ID |
yes |
|||||
|
バージョン |
発注書サプライヤーバージョン番号 - 発注書が変更されると増加し、サプライヤーへの再送信がトリガーされます。 |
yes |
yes |
整数 |
|||
|
classification |
Classification |
msp, supplier, vms |
yes |
yes |
string(255) |
||
|
currency |
取引の通貨 |
yes |
|||||
|
confirm-by-hrs |
確認者 |
yes |
整数 |
||||
|
order-confirmation-level |
確認レベル |
yes |
int(11) |
||||
|
user-members |
ユーザーメンバー |
yes |
ユーザー |
||||
|
user-group-members |
ユーザーグループメンバー |
yes |
ユーザー |
||||
-
ソースフィールドの値に基づいてクエリ可能になる依存フィールドがあります。 たとえば、
po - method = emailに対してクエリを実行した場合、po - emailを追加のクエリ条件として追加できます。 「はい*」のフィールドをご覧ください。 -
大規模なデータセットの場合、パフォーマンスの最適化のために、常にいくつかのGET条件で結果を制限してください。
-
発注変更は、必ずしもバージョン番号を増やすとは限りません。 詳細は発注書の修正を引き起こすフィールドをご参照ください。
updated - atフィールドは、何らかの変更が行われたかどうかを判断するために常に使用できます。 -
APIクエリに返される
invoice-totalを表示するには、default_purchase_orders_filterをデフォルトに設定する必要があります。 既定の発注APIフィルターを更新すると、API GETコールにinvoice-totalが表示されます。
コード例
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>
仮完了の発注書を再開
仮完了の詳細については、発注書の完了をご参照ください。
理由インサイト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>
理由インサイトコードを使用
<?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>