JA 地球アイコン
ユーザーアイコン
このページ
  • 最終編集日時: 13 May 2022
何かお探しですか？ 製品 Coupa製品ドキュメント インテグレーション技術文書 Coupa Core API リソース 取引リソース 請求書API (/invoices)

請求書API (/invoices)

インボイスAPIを使用して、発注書に関連付けられたインボイスを作成、更新、またはクエリします。

概要

インボイスにアクセスするためのURLは次のとおりです。 https://{your_instance_name}/api/invoices

リリース29以降、Coupaは、他の請求書購入者チャネルと同等に、請求書発行APIを完全に機能するように強化しました。この更新の詳細については、 請求書作成のための拡張インボイス発行APIカバレッジ 。

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

請求書APIオブジェクト

これは、UIを介して利用可能な請求書オブジェクトの完全なリストです。ただし、ここにリストされているすべてのオブジェクトにエンドポイントがあるわけではありません。一部のオブジェクトはオブジェクトによってのみ参照され、直接更新することはできません。 

wiki.tree();

アクション

請求書APIでは次のことができます。

動詞 パス アクション 説明
プット /api/invoices/:id/abandon 放棄 インボイスを放棄
プット /api/invoices/:id/add_approver 承認者を追加 請求書の承認者を手動で追加する
プット /api/invoices/:id/bypass_approvals 承認をスキップ

承認をスキップ

顧客側のサードパーティシステムが請求書を可能な限り迅速に承認および支払うことを許可します。

プット /api/invoices/:id/bypass_current_approval 現在の承認をスキップ

現在の承認をスキップ

顧客側のサードパーティシステムが現在の承認者から請求書を承認してもらい、請求書の支払を可能な限り迅速に受け取れるようにします。

プット /api/invoices/:id/dispute 論争

論争請求書

システムコールを介して請求書を論争済みステータスに移動することを許可します。請求書を論争済みに移行すると、請求書に問題があることをサプライヤーに通知します。クレーム申請には、次のようにクレーム理由をペイロードに含めることができます。 

<invoice-header>
  <dispute-reason>
    <code>INCORRECT-QUANTITY</code>
  </dispute-reason>
  <comment>A supplier comment</comment>
</invoice-header>

これには、INCORRECT_QUANTITYが有効で有効なクレーム理由である必要があります。

プット /api/invoices/:id/flip_to_advance_ship_notice 事前出荷明細通知に切り替え

インボイスを事前出荷明細通知に変換

取得 /api/invoices/:id/retrieve_image_scan 画像スキャンの取得 画像スキャンを取得/ダウンロード
プット /api/invoices/:id/image_scan 画像スキャン 画像スキャンの添付ファイルまたは画像スキャンのURLを更新
取得 /api/invoices インデックス 請求書を問い合わせ
プット /api/invoices/:id/remove_approval 承認の削除 手入力で追加された承認者を削除
プット /api/invoices/:id/restart_approvals 承認の再開

承認の再開

顧客側のサードパーティシステムが現在の承認チェーンをクリアし、変更を加えた請求書の新しい承認チェーンを再生成できるようにします。

取得 /api/invoices/:id/retrieve_clearance_document 清算文書の取得 清算文書の取得/ダウンロード
取得 /api/invoices/:id/retrieve_legal_invoice_pdf retrieve_legal_invoice_pdf 法定請求書のPDFをダウンロード/取得します。このアクションにより、APIコールによってPDF添付ファイルをエクスポートできます。
プット /api/invoices/:id/revalidate_tolerances 許容誤差の再検証

許容誤差の再検証

顧客側のサードパーティシステムが、問題のある請求書を再提出できるようにします。

取得 /api/invoices/:id 表示 インボイスを表示
プット /api/invoices/:id/submit 提出 承認を得るためにドラフトのインボイスを送信
パッチ /api/invoices/:id 更新

請求書を更新

プット /api/invoices/:id 更新

請求書を更新

APIを使用して請求書の情報を更新するために使用されます

プット /api/invoices/:id/update_line_accounts 品目アカウントの更新

品目アカウントの更新

モバイルユーザーが請求書を更新するために使用します

プット /api/invoices/:id/void 無効

承認済み請求書を無効にする

これは、承認済みで受領待ちの請求書にのみ使用できます。

  • BUYER_VOIDABLE_STATUSES = [:pending_receipt, :approved, :draft]
  • SUPPLIER_VOIDABLE_STATUSES = [:pending_receipt, :approved]
プット /api/invoices/:id/withdraw_dispute 論争の取消

論争の取消

サプライヤーが何もアクションを行わなかったり、購入者側に誤りがあったりすると、修正依頼のあった請求書を承認プロセスに戻すことができます。

要素

要素 説明 必須 一意 許容値 で 出力 データタイプ
放棄理由 放棄理由 no no 任意 はい 理由インサイト
勘定科目タイプ 勘定科目表の参照 はい はい はい 勘定科目タイプ
advance-payment-received-amount 受領された前受金/前払金の金額 はい はい 小数（30,4）
amount-due-less-discount 割引の適用後に支払うべき金額 任意 はい decimal型
approvals 承認 はい 承認
添付ファイル はい 添付書類
アーカイブエンティティID アーカイブエンティティのID はい 整数
請求先住所 請求先住所 はい はい はい 住所
購入者の税務登録情報 購入者の税務登録情報 はい* はい 税務登録情報
キャンセル済み 取引がキャンセルされたかどうかを示します はい ブール値
cash-accounting-scheme-reference 現金会計スキームを使用している場合のメモ はい はい 文字列（255）
清算文書 清算文書の添付ファイル名。/retrieve_clearance_documentからアクセス可能 はい string型
comments comments はい はい 文字列（255）
準拠 請求書コンプライアンスインジケーター はい ブール値
confirmation 確認 はい 文字列（50）
contract 裏付け契約番号 はい はい 契約
coupa-accelerate-status インボイスの固定割引による割引支払条件の有無を示すステータス 高速化 はい 文字列（40）
created-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます はい 日時
作成者 作成したユーザー はい ユーザー
credit-note-differences-with-original-invoice 元のインボイスとのクレジットメモの違い はい はい 小数（30,4）
credit-reason クレジットを作成する理由 はい はい 文字列（255）
currency 通貨コード はい はい 通貨
current-integration-history-records 現在のインテグレーション履歴記録 はい インテグレーション履歴記録
customer-accounting-tax-less-discount 割引の適用後の顧客の会計の税金 任意 はい decimal型
customs-declaration-date 税関申告日 はい はい 日時
customs-declaration-number 税関申告番号 はい はい 文字列（60）
customs-office 税関 はい はい テキスト
date-received 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で受領日 はい 日時
delivery-date 供給日 no no 任意 はい 日時
宛先国 コンプライアンスに使用される宛先の国 はい 国
discount-amount サプライヤーから提供された割引額 はい はい 小数（32,4）
割引期日 割引支払条件に基づいて計算された割引期日 はい 日時
discount-percent 割引 % はい はい 浮動小数
dispute-method クレーム方法 no no 任意 はい 文字列（10）
クレーム理由 クレーム理由 no no 任意 はい クレーム理由
document-type インボイスまたはクレジットメモ 請求書、クレジットメモ はい 文字列（255）
早期支払規定 早期支払インセンティブ はい はい 文字列（255）
exchange-rate 為替レート はい はい 小数（30,9）
exported 取引がエクスポートされたか示します はい ブール値
失敗した許容誤差 失敗となった許容誤差 はい はい 請求書：:FailedTolerance
folio-number フォリオ番号 はい 文字列（20）
form-of-payment 支払フォーム はい 文字列（10）
gross-total 総計 はい decimal型
gross-total-less-discount 割引の適用後の請求書合計 任意 はい decimal型
handling-amount 取扱手数料 はい はい 小数（32,4）
id Coupaの一意の識別子 はい 整数
画像スキャン 請求書画像スキャンの添付ファイル名 はい 文字列（25）
画像スキャンコンテンツタイプ 画像スキャンのコンテンツタイプ はい 文字列(191)
image-scan-file-name 画像スキャンのファイル名 はい 文字列（255）
image-scan-file-size 画像スキャンファイルのサイズ(MB) はい 文字列(12)
画像スキャンURL 請求書画像スキャンURL。「http://'」または「https://'」で始める必要があります。 はい 文字列（255）
送られてくる請求書 送られてくる請求書の参照 はい 送られてくるインボイス
inbox-name 受信トレイ名 はい string型
internal-note 内部メモ はい はい テキスト
請求書料金 請求書料金 はい はい 請求書手数料
invoice-date インボイスの日付 はい はい はい 日時
請求元住所 請求元住所 はい* はい サプライヤー支払先
請求品目 レコード識別子 はい はい 請求品目
invoice-number 請求書番号 はい はい はい 文字列（40）
インボイス支払レシート 請求書関連の支払レシート情報 はい インボイス支払レシート
invoice-reference-number 請求書参照番号（IRN） はい はい
issuance-place 発行地 はい 文字列（50）
last-exported-at 取引が最後にエクスポートされた日時はYYYY-MM-DDTHH:MM:SS+HH:MMZの形式になります はい 日時
late-payment-penalties 遅延支払違約金 はい はい 文字列（255）
法定宛先国 コンプライアンスに使用される法定宛先国 詳細については、 準拠国リスト 。 はい 国
line-level-taxation この請求書の品目レベルで税金が提供されるかどうかを示すフラグ はい はい はい ブール値
ロックバージョンキー ロックバージョン はい 整数
margin-scheme マージンスキームを使用する理由 はい はい 文字列（255）
misc-amount その他の金額 はい はい 小数（32,4）
net-due-date 正味支払条件に基づいて計算された正味期日 はい 日時
net-total-less-discount 割引の適用後の正味合計 任意 はい decimal型
発生国 コンプライアンスに使用される発行元の国 はい 国
origin-currency-gross 現地通貨の総額 はい* はい 小数（32,4）
origin-currency-net 現地通貨の正味額 はい* はい 小数（32,4）
original-invoice-date 元の請求日は次の場合に必要です is-credit-note=true はい** はい 日時
original-invoice-number 元の請求日は次の場合に必要です is-credit-note=true はい** はい 文字列（40）
paid Paid はい はい ブール値
支払請求書 インボイスの支払 はい
payment-channel インボイス支払の処理方法 – ERP（既定）、Coupa Payバーチャルカード、Coupa Payインボイス支払 no no 任意 はい 文字列（40）
payment-date インボイスの支払日 はい はい 日時
payment-method 支払方法 はい 文字列（10）
payment-notes インボイスの支払に含まれるメモ はい はい テキスト
payment-order-reference 支払指図照会 はい はい 文字列（255）
payment-term インボイスの支払条件コード はい はい 支払条件
支払 支払 はい はい 支払
pre-payment-date 前払い日 はい はい 日時
調整品目 調整品目 はい 請求書/調整品目
支払先住所 支払先住所 はい はい はい 住所へ送金する
申請者 請求書の申請者 はい ユーザー
reverse-charge-reference 逆請求参照 はい はい 文字列（255）
署名済みqrコード 署名済みQRコード はい テキスト
self-billing-reference 請求書の自己請求参照 はい はい 文字列(191)
sender-email 送信者メール はい 文字列（255）
series シリーズ はい 文字列（30）
発送元住所 発送元住所 はい はい サプライヤー支払先
発送先住所 出荷先住所 はい はい 住所
shipping-amount 発送料金額 はい はい 小数（32,4）
配送条件 インボイスの配送条件コード はい 配送条件
show-tax-information インボイスに税金情報を表示 はい ブール値
status 請求書のステータス はい 文字列（50）
supplier サプライヤー名または番号 はい はい サプライヤー
サプライヤーが作成した インボイスのサプライヤー作成インジケーター はい ブール値
supplier-note サプライヤーから提供されたメモ はい はい テキスト
サプライヤー支払先 サプライヤーから提供された支払先住所 はい はい はい サプライヤー支払先
サプライヤーの税務登録情報 サプライヤーの税務登録情報 はい* はい 税務登録情報
サプライヤー合計 サプライヤー合計 はい decimal型
taggings タグ付け はい はい タグ付け
タグ タグ（廃止済み。タグの関連付けを使用してタグをInvoiceHeaderに追加してください） はい はい タグ
tax-amount 税額（税金が品目レベルで提供される場合は使用されません） はい はい decimal型
税金額エンジン 設定に基づいてCoupa固有または外部税金エンジンによって計算された税金額 はい decimal型
tax-code 税金コード（税金が品目レベルで提供される場合は使用されません） はい はい 文字列（255）
税金コードエンジン 設定に基づいて外部税金エンジンによって返される税金コード はい
tax-due-to-supplier サプライヤーに支払うべき税金 はい 小数（32,4）
税項目 品目税金コード（税金がヘッダーレベルで提供される場合は使用されません） はい はい 税金行
tax-rate 税率（税金が品目レベルで提供される場合は使用されません） はい はい 浮動小数
税率エンジン 設定に基づいて外部税金エンジンによって返される税率 はい
taxes-in-origin-country-currency 現地通貨建て税額 はい* はい 小数（32,4）
許容誤差失敗 許容誤差エラー はい 文字列(512)
税込み合計 税込み合計 はい decimal型
total-taxes-less-discount 割引適用後の税金合計 任意 はい decimal型
type-of-receipt レシートのタイプ はい 文字列（10）
type-of-relationship 関係内容 はい 文字列（10）
updated-at 「YYYY-MM-DDTHH:MM:SS+HH:MMZ」の形式で、Coupaによって自動的に作成されます はい 日時
更新者 更新したユーザー はい ユーザー
use-of-invoice インボイスの使用 はい 文字列（10）
源泉徴収税項目 源泉徴収税項目 はい はい 源泉徴収税項目
withholding-tax-override 源泉徴収税（手数料） はい 小数（30,3）
invoice-reference-number インボイス参照番号（IRN） はい はい 文字列（255）
supplier-invoice-issuer-name サプライヤーのインボイス発行者名 はい はい 文字列（255）
サプライヤー – インボイス – レビュー担当者 – 名前 サプライヤーのインボイスレビュアー名 はい はい 文字列（255）
supplier-payment-collector-name サプライヤーの支払集金者名 はい はい 文字列（255）
endorsement-on-invoices インボイス上の裏書 はい 文字列（10）
new-means-of-transport 新規輸送手段 はい 文字列（10）
place-of-issuance 発行地 はい 文字列（100）
amount-of-advance-payment 前払金の金額 はい はい 小数（46,20）
transaction-uuid 取引UUID はい 文字列（50）
transaction-notification-date 取引通知日 はい 日時
コンテンツ検証 請求書内容検証インジケーター はい ブール値
invoice-reference-number インボイス参照番号（IRN） はい はい
supplier-invoice-issuer-name サプライヤーのインボイス発行者名 はい はい 文字列（255）
サプライヤー – インボイス – レビュー担当者 – 名前 サプライヤーのインボイスレビュアー名 はい はい 文字列（255）
supplier-payment-collector-name サプライヤーの支払集金者名 はい はい 文字列（255）
貸方票 文書タイプのクレジットメモ はい ブール値
申請者のメールアドレス 申請者のメールアドレス はい string型
申請者名 申請者の氏名 はい string型
申請者の検索名 申請者検索名 はい string型
発送番号 配送番号 はい 文字列（255）
delivery-date 納品日 はい 日時
元の供給値 元の供給値 はい 小数（46,20）
正しい供給値 供給値を訂正 はい 小数（46,20）
original-invoice-date クレジットメモの場合に使用される元の請求日 はい はい 日時
type-of-relationship 関係内容 はい 文字列（10）
original-invoice-number クレジットメモの場合に使用される元のインボイス番号 はい はい 文字列（40）
仕入地 支給場所 はい 文字列（255）
分割支払メカニズム 分割支払メカニズム はい ブール値
endorsement-on-invoices インボイス上の裏書 はい 文字列（10）
new-means-of-transport 新規輸送手段 はい 文字列（10）
place-of-issuance 発行地 はい 文字列（100）
署名済みqrコード 署名済みQRコード はい テキスト
配送条件 インボイスの配送条件コード はい
サプライヤーの税務登録情報 はい はい
購入者の税務登録情報 はい はい
支払注文番号 支払注文番号

はい

文字列
請求書発行時刻 インボイス発行時間 はい 文字列（255）
現金登録業者 現金登録オペレーター はい 文字列（255）
支払手段 支払手段 はい 文字列（255）
現金受領書の一意の識別コード 現金受領の一意のIDコード はい 文字列（255）
発行元のセキュリティコード 発行元のセキュリティコード はい 文字列（255）
州税番号 州税金ID番号 はい 文字列（255）
代替納税義務者の州税番号 代理納税者の州税金ID番号 はい 文字列（255）
地方税番号 地方自治体税金ID番号 はい 文字列（255）
財務会計コードのシリアルインボイス 税務インボイスのシリアルコード はい 文字列（255）
認証コード 認証コード はい 文字列（255）
文書のタイプ 文書のタイプ はい 文字列（255）
プロトコル番号 プロトコル番号 はい 文字列（255）
オペレーションの特性 業務の特性 はい 文字列（255）
オペレーションタイプ 業務のタイプ はい 文字列（255）
運送タイプ 運送タイプ はい 文字列（255）
車両ナンバープレート 車両ナンバープレート はい 文字列（255）
輸送業者の国家登録 運搬業者の国家登録 はい 文字列（255）
量 – 金額 販売量の金額 はい 文字列（255）
量・総重量 販売量の総重量 はい 文字列（255）
量・液量 販売量の液体重量 はい 文字列（255）
量ブランド 販売量のブランド はい 文字列（255）
量タイプ 販売量のタイプ はい 文字列（255）
ボリューム番号 販売量の自動番号付け はい 文字列（255）
支払契約メモ 支払契約メモ 前払い契約による全額支払い、前払い契約による一部支払い、定期契約に対してすでに支払い、契約ごとの支払いを保持 はい 文字列（255）
tcs – 税項目 はい -
請求元住所 はい はい 住所
発送元住所 はい はい 住所
メモ

アスタリスク*が付いた必須フィールドは、税法準拠請求書の追加必須フィールドです。  2つのアスタリスクが付いた必須フィールドは**以下の場合にのみ必須です。 is-credit-note=true 。

準拠国リスト

このリストは、どの国で税法準拠請求書の発行が許可されているかを示しています。Coupaが現在サポートしている準拠国のリストではありません。

#id コード 名前
14 AU オーストラリア
15 AT オーストリア
22 BE ベルギー
31 BR ブラジル
34 BG ブルガリア
39 CA カナダ
53 HR クロアチア
55 CY キプロス
56 CZ チェコ共和国
58 DK デンマーク
67 EE エストニア
72 FI フィンランド
73 FR フランス
79 DE ドイツ
82 GB 英国
83 GR ギリシャ
96 HK 香港
97 HU ハンガリー
98 IS アイスランド
103 IE アイルランド
104 IL イスラエル
105 IT イタリア
108 JP 日本
118 LV ラトビア
123 LI リヒテンシュタイン
124 LT リトアニア
125 LU ルクセンブルク
133 MT マルタ
138 MX メキシコ
141 MC モナコ
144 MA モロッコ
151 NL オランダ
154 NZ ニュージーランド
161 いいえ ノルウェー
171 PL ポーランド
173 PT ポルトガル
175 QA カタール
177 RO ルーマニア
183 SA サウジアラビア
187 SG シンガポール
188 SK スロバキア
189 SI スロベニア
192 ZA 南アフリカ
193 ES スペイン
204 SE スウェーデン
205 CH スイス
222 AE

アラブ首長国連邦

223 US 米国
250 インスタントメッセージ マン島

このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。

関連アイテム

Coupa Core API

CoupaのRESTful APIは、お客様のデータをCoupaプラットフォームで読み取り、編集し、統合するための堅牢なアクセスを提供します。

詳細情報

APIの開始

Coupa APIの使用に関する一般情報、およびCSVの使用を検討するタイミング。

詳細情報

OAuth 2.0およびOIDCへの移行

Coupaは従来のAPIキーを廃止し、OAuth 2.0 / OIDCの使用を必要としています。R34以降、新しいAPIキーは発行されず、R35ではAPIキーはサポートされなくなります。

詳細情報

リソース

参照データ、トランザクションデータ、共有リソースなど、オブジェクトのタイプ別にAPIエンドポイントを整理しました。

詳細情報