• 最終編集日時: 13 May 2022

Invoices API (/ invoices)

請求書APIを使用して、発注書に関連付けられた請求書を作成、更新、または照会します。

概要

請求書にアクセスするためのURLは次のとおりです: https :// {your_instance_name}/api/invoices

リリース29の時点で、Coupaは他の請求書バイヤーチャネルと同等に、請求APIを完全に機能するように強化しました。この更新プログラムの詳細については、「請求書作成のための拡張請求書APIカバレッジ」を参照してください

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



アクション

Invoices 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>のコメント</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 retrieve_clearance_document クリアランスドキュメントを取得/ダウンロード
取得 /api/invoices /: id/retrieve_legal_invoice_pdf retrieve_legal_invoice_pdf 法的請求書のPDFをダウンロード/取得します。このアクションにより、PDF添付ファイルをAPI呼び出しでエクスポートできます。
プット /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 LINEアカウントを更新

LINEアカウントの更新

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

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

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

これは、承認済みおよび保留中の領収書の請求書にのみ使用できます。

  • BUYER_VOIDABLE_STATUSES = [: pending_receipt、: approved、: draft]
  • SUPPLIER_VOIDABLE_STATUSES = [: pending_receipt,: approved]
プット /api/invoices /: id/withdraw_dispute 異議申し立てを取り下げ

異議申し立てを取り下げ

サプライヤーの不作為またはバイヤー側のミスにより、紛争中の請求書を承認プロセスに戻すことができます。

要素

要素 説明 申請済み 一意 許容される値 In アウト データタイプ
abandon - reason 放棄理由 いいえ no 任意の はい Reason Insight
account - type 勘定科目表の参照番号 はい はい はい 勘定科目のタイプ
advance - payment - received - amount 受領された前受金/前払金の金額 はい はい 小数( 30,4 )
amount - due - less - discount 割引適用後の対象金額 any はい 小数
承認 承認 はい 承認
添付ファイル はい 添付
archive - entity - id アーカイブエンティティID はい 整数
請求先住所 請求先住所 はい はい はい 住所
buyer - tax - registration バイヤーの税務登録 はい* はい 税務登録
キャンセル済み 取引がキャンセルされたか示します はい boolean
cash - accounting - scheme - reference 現金会計スキームを使用している場合は注意 はい はい string (255)
clearance - document クリアランスドキュメントの添付ファイル名。/retrieve_clearance_document経由でアクセス可能 はい string
コメント コメント はい はい string (255)
コンプライアンス 請求書コンプライアンス指標 はい boolean
確認 確認 はい string (50)
契約 裏付け契約番号 はい はい 契約番号
coupa - accelerate - status 請求書の固定割引による割引支払条件の有無を示すステータス 加速 はい string (40)
created - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました はい 日時
created - by 作成したユーザー はい ユーザー
credit - note - differences - with - original - invoice 元の請求書とのクレジットメモの差額 はい はい 小数( 30,4 )
credit - reason 旅行クーポンを作成した理由 はい はい string (255)
通貨 通貨コード はい はい 通貨
current - integration - history - records 現在のインテグレーション履歴記録 はい 連携履歴レコード
customer - accounting - tax - less - discount 割引の適用後の顧客の会計の税 任意の はい 小数
custom - declaration - date 税関申告日 はい はい 日時
custom - declaration - number 税関申告番号 はい はい string (60)
customs - office 税関 はい はい テキスト
date - received 受信日の形式YYYY - MM - DDTHH: MM: SS + HH: MMZ はい 日時
delivery - date 納品日 no いいえ 任意の はい 日時
destination - country コンプライアンスのために使用される目的地の国 はい 国/地域
discount - amount サプライヤーから提供された割引額 はい はい 小数( 32,4 )
discount - due - date 割引支払条件に基づいて計算された割引期限日 はい 日時
discount - percent 割引% はい はい float
dispute - method 修正依頼の方法 no いいえ any はい string (10)
dispute - reasons 修正依頼の理由 いいえ no 任意の はい 修正 依頼の理由
document - type 請求書またはクレジットメモ 請求書、クレジットメモ はい string (255)
アーリーペイメント-プロビジョニング 早期支払インセンティブ はい はい string (255)
exchange - rate 為替レート はい はい 小数( 30,9 )
exported 取引がエクスポートされたか示します はい boolean
failed - tolerances 許容誤差の不合格 はい はい 請求書:: FailedTolerance
folio - number フォリオ番号 はい string (255)
支払い方法 支払フォーム はい string (10)
gross - total 総計 はい 小数
gross - total - less - discount 割引適用後の請求書合計 任意の はい 小数
handling - amount 取扱額 はい はい 小数( 32,4 )
iD Coupaの一意の識別子 はい 整数
image - scan 請求書画像スキャン添付ファイル名 はい string (25)
image - scan - content - type 画像スキャンの内容タイプ はい string (191)
image - scan - file - name 画像スキャンのファイル名 はい string (255)
image - scan - file - size 画像スキャンファイルのサイズ( MB単位) はい string (12)
image - scan - url インボイスの画像スキャンURL。'http ://'または' https ://'で始まる必要があります。 はい string (255)
inbound - invoice 送られてくる請求書参照 はい 送られてくる請求書
inbox - name 受信トレイ名 はい string
internal - note 内部メモ はい はい テキスト
invoice - charges 請求料金 はい はい 請求書手数料
invoice - date 請求日付 はい はい はい 日時
invoice - from - address 請求書発行元住所 はい* はい サプライヤー支払先
invoice - lines レコードの識別子 はい はい インボイス項目
invoice - number 請求書番号 はい はい はい string (40)
invoice - payment - receipts 請求書関連の支払レシート情報 はい 請求書支払レシート
invoice - reference - number 請求書参照番号( IRN ) はい はい
issuance - place 発行地 はい string (50)
last - exported - at 取引が最後にエクスポートされた日時はYYYY - MM - DDTHH: MM: SS + HH: MMZの形式になります はい 日時
遅延支払いペナルティ 遅延支払違約金 はい はい string (255)
legal - destination - country コンプライアンスに使用される合法的な目的地国 準拠国リストを参照してください はい 国/地域
line - level - taxation この請求書で税金が明細行レベルで提供されているかどうかを示すフラグ はい はい はい boolean
lock - version - key ロックバージョン はい 整数
margin - scheme マージンスキームを使用する理由 はい はい string (255)
misc - amount その他の金額 はい はい 小数( 32,4 )
net - due - date 正味の支払い条件に基づいて計算された正味の期日 はい 日時
net - total - less - discount 割引適用後の正味合計 任意の はい 小数
origin - country コンプライアンスのために使用される原産国 はい 国/地域
origin - currency - gross 現地通貨の総額 はい* はい 小数( 32,4 )
origin - currency - net 現地通貨の正味額 はい* はい 小数( 32,4 )
original - invoice - date Is - credit - note = trueの場合、元の請求日が必要です はい** はい 日時
original - invoice - number Is - credit - note = trueの場合、元の請求日が必要です はい** はい string (40)
支払われました 支払済み はい はい boolean
pay - invoice 支払請求書 はい
payment - channel 請求書支払いの処理方法- ERP (デフォルト)、Coupa Payバーチャルカード、Coupa Pay請求書支払い いいえ no 任意の はい string (40)
payment - date 請求書の支払日 はい はい 日時
payment - method 支払方法 はい string (10)
payment - notes 請求書の支払いに含まれるメモ はい はい テキスト
payment - order - reference 支払指図照会 はい はい string (255)
payment - term 請求書の支払期限コード はい はい 支払条件
payments 支払 はい はい 支払
pre - payment - date 前払い日 はい はい 日時
reconciliation - lines 突合せ明細 はい 請求書/調整明細
送金先住所 支払先住所 はい はい はい 支払 先住所
rEQUESTED - BY 請求書の依頼者 はい ユーザー
resolution - number 解決番号 はい はい string (255)
reverse - charge - reference 逆請求参照 はい はい
signed - qr - code 署名済みQRコード はい テキスト
self - billing - reference 請求書の自己請求参照 はい はい string (191)
sender - email 送信者メール はい string (255)
シリーズ シリーズ はい string (30)
ship - from - address 発送元住所 はい はい サプライヤー支払先
ship - to - address 発送先住所 はい はい 住所
shipping - amount 発送料金額 はい はい 小数( 32,4 )
shipping - term 請求書の配送条件コード はい 発送条件
show - tax - information 請求書に税務情報を表示 はい boolean
ステータス 請求書のステータス。請求書ステータスの詳細については、「ステータスを通じた請求書の進捗状況」を参照してください 新規、
ap_hold、
ドラフト、on_hold、 
pending_receipt、 
却下済み、 
放棄されています。
論争済み。
pending_approval、
booking_hold、
pending_action、
承認済み、
無効、
処理、
無効、
pending_action、payable_adjustment
はい string (50)
サプライヤー サプライヤー名または番号 はい はい サプライヤー
サプライヤーが作成しました サプライヤーがインボイスのインジケータを作成しました はい boolean
supplier - note サプライヤーから提供されたメモ はい はい テキスト
supplier - remit - to サプライヤーが支払先住所を入力しました はい はい はい サプライヤー支払先
supplier - tax - registration サプライヤー税務登録 はい* はい 税務登録
supplier - total サプライヤー合計 はい 小数
タグ タグ付け はい はい タグ付け
タグ タグ(非推奨。タグの関連付けを使用して、InvoiceHeaderにタグを追加してください) はい はい タグ
tax - amount 税金額(明細レベルで税金が提供されている場合は使用されません) はい はい 小数
tax - amount - engine 構成に基づいてCoupa NativeまたはExternal Tax Engineによって計算された税額 はい 小数
tax - code 税金コード(明細レベルで税金が提供されている場合は使用されません) はい はい string (255)
tax - code - engine 構成に基づいて外部税エンジンによって返される税金コード はい
tax - due - to - supplier サプライヤーが対象の税 はい 小数( 32,4 )
tax - lines 明細税コード(税金がヘッダーレベルで提供されている場合は使用されません) はい はい 税金明細
税率 税率(明細レベルで税金が提供されている場合は使用されません) はい はい float
tax - rate - engine 構成に基づいて外部税エンジンによって返される税率 はい
tax - in - origin - country - currency Local Currency Tax はい* はい 小数( 32,4 )
tolerance - failure 許容限度超過 はい string (512)
total - with - taxes 税込みの合計 はい 小数
total - taxes - less - discount 割引適用後の税金合計 任意の はい 小数
領収書の種類 レシートのタイプ はい string (10)
type - of - relationship 関係内容 はい string (10)
updated - at CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました はい 日時
更新者: 更新したユーザー はい ユーザー
請求書の使用 請求書の使用 はい string (10)
源泉徴収税明細 源泉徴収税明細行 はい はい 源泉徴収税明細
源泉徴収-税金-上書き 源泉徴収税の上書き はい 小数( 30,3 )
invoice - reference - number 請求書参照番号( IRN ) はい はい string (255)
supplier - invoice - issuer - name サプライヤーの請求書発行者名 はい はい string (255)
supplier - invoice - reviewer - name サプライヤーの請求書レビュアー名 はい はい string (255)
supplier - payment - collector - name サプライヤーの支払集金者名 はい はい string (255)
請求書上の裏書 請求書上の裏書 はい string (10)
new - means - of - transport 新規輸送手段 はい string (10)
発行地 発行地 はい string (100)
amount - of - advance - payment 前払金の金額 はい はい 小数( 46,20 )
transaction - uuid 取引UUID はい string (50)
transaction - notification - date 取引通知日 はい 日時
content - validation 請求書コンテンツ検証インジケータ はい boolean
invoice - reference - number 請求書参照番号( IRN ) はい はい
supplier - invoice - issuer - name サプライヤーの請求書発行者名 はい はい string (255)
supplier - invoice - reviewer - name サプライヤーの請求書レビュアー名 はい はい string (255)
supplier - payment - collector - name サプライヤーの支払集金者名 はい はい string (255)
is - credit - note 書類の種類のクレジットメモ はい boolean
requester - email 申請者のメールアドレス はい string
requester - name 申請者の氏名 はい string
requester - lookup - name 申請者検索名 はい string
delivery - number 配送番号 はい string (255)
delivery - date 納品日 はい 日時
original - value - of - supply 元の供給値 はい 小数( 46,20 )
correct - value - of - supply 供給値を訂正 はい 小数( 46,20 )
original - invoice - date クレジットノートの場合に使用される元の請求日 はい はい 日時
type - of - relationship 関係内容 はい string (10)
original - invoice - number クレジットノートの場合に使用される元の請求書番号 はい はい string (40)
place - of - supply 支給場所 はい string (255)
スプリットペイメントメカニズム 分割支払メカニズム はい boolean
請求書上の裏書 請求書上の裏書 はい string (10)
new - means - of - transport 新規輸送手段 はい string (10)
発行地 発行地 はい string (100)
signed - qr - code 署名済みQRコード はい テキスト
shipping - term 請求書の配送条件コード はい
supplier - tax - registration はい はい
buyer - tax - registration はい はい
payment - order - number 支払注文番号

はい

string
invoice - issuance - time 請求書発行時間 はい string (255)
cash - register - operator 現金登録オペレーター はい string (255)
支払い方法 支払手段 はい string (255)
unique - identification - code - of - cash - receipt 現金受領の一意のIDコード はい string (255)
security - code - of - issuer 発行元のセキュリティコード はい string (255)
state - tax - number 州税金ID番号 はい string (255)
state - tax - number - for - substitute - taxpayer 代理納税者の州税金ID番号 はい string (255)
municipal - tax - number 地方自治体税金ID番号 はい string (255)
serial - code - of - fiscal - invoice 税務請求書のシリアルコード はい string (255)
verification - code 認証コード はい string (255)
type - of - document 文書のタイプ はい string (255)
protocol - number プロトコル番号 はい string (255)
nATURE - OF - OPERATION 業務の特性 はい string (255)
type - of - operation 業務のタイプ はい string (255)
貨物タイプ 運送タイプ はい string (255)
vehicle - license - plate 車両ナンバープレート はい string (255)
national - enrollment - of - conveyor 運搬業者の国家登録 はい string (255)
volume - amount 販売量の金額 はい string (255)
ボリューム-総重量 販売量の総重量 はい string (255)
volume - liquid - weight 販売量の液体重量 はい string (255)
volume - brand 販売量のブランド はい string (255)
volume - type 販売量のタイプ はい string (255)
volume - numbering 販売量の自動番号付け はい string (255)
payment - agreement - notes 支払契約メモ 前払い契約を介して全額支払われ、前払い契約を介して部分的に支払われ、定期的な契約に対して既に支払われ、契約ごとに支払いを保持する はい string (255)
tcs - tax - lines はい -
invoice - from - address はい はい 住所
ship - from - address はい はい 住所
メモ

アスタリスク*が付いた必須フィールドは、コンプライアンス請求書の追加必須フィールドです。2つのアスタリスク**が付いた必須フィールドは、is - credit - note = trueの場合にのみ必須です

コンプライアンス国/地域リスト

このリストには、適合な請求が許可されている国が表示されます。Coupaが現在サポートしている準拠国の一覧ではありません。

# ID コード 名前
14 AU オーストラリア
15 AT オーストリア
22 BE ベルギー
31 BR ブラジル
34 BG ブルガリア
39 カナダ カナダ
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 ニュージーランド ニュージーランド
161 NO ノルウェー
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エンドポイントを整理しました。