請求書API (/invoices)
このページは機械翻訳を使用して翻訳されています。
概要
アクセス請求書へのURLは次のとおりです。https://{your_instance_name}/api/invoices
現在、CoupaはAPIを使用した請求書のPOSTをサポートしていません。 Coupaにインボイスをロードする必要がある場合は、当社のインボイスフラットファイル統合の使用を検討してください。金融システムからCoupaに請求書支払情報を転記する方法の詳細については、請求書支払APIを参照してください。
詳細については、 統合のベストプラクティス を参照してください。
Invoice APIオブジェクト
これは、UIを介して利用できる請求書オブジェクトの完全なリストです。ただし、ここにリストされているすべてのオブジェクトにエンドポイントがあるわけではありません。オブジェクトによってのみ参照されるものもあり、直接更新することはできません。
アクション
Invoices APIを使用すると、次のことができます。
動詞 | パス | アクション | 説明 |
---|---|---|---|
置く | /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</ これには、INCORRECT_QUANTITYが有効かつ有効な異議申し立て理由である必要があります。 |
置く | /api/invoices/:id/flip_to_advance_ship_notice |
フリップして出荷通知を送ります |
請求書を前倒し通知にフリップ
|
置く | /api/invoices/:id/image_scan |
画像スキャン | 画像スキャン添付ファイルを更新 |
GET | /api/invoices |
インデックス | 請求書のクエリ |
置く | /api/invoices/:id/remove_approval |
承認の削除 | 手動で追加された承認者を削除する |
置く | /api/invoices/:id/restart_approvals |
承認の再開 |
承認の再開 顧客側のサードパーティシステムが現在の承認チェーンをクリアし、変更があった請求書の新しい承認チェーンを再生成できるようにします。
|
GET | /api/invoices/:id/retrieve_clearance_document |
retrieve_clearance_document | 通関書類を取得/ダウンロード |
GET | /api/invoices/:id/retrieve_image_scan |
画像スキャンの取得 | 画像スキャンの取得/ダウンロード |
置く | /api/invoices/:id/revalidate_tolerances |
許容誤差を再検証 |
許容誤差を再検証 顧客側のサードパーティシステムが問題のあった請求書を再送信できるようにします。 |
GET | /api/invoices/:id |
表示 | 請求書を表示 |
置く | /api/invoices/:id/submit |
提出 | 承認を得るために請求書ドラフトを送信 |
パッチ | /api/invoices/:id |
更新 |
請求書を更新 |
置く | /api/invoices/:id |
更新 |
請求書を更新 APIを使用してインボイスの情報を更新するために使用されます |
置く | /api/invoices/:id/update_line_accounts |
勘定科目を更新 |
勘定科目を更新 モバイルユーザーが請求書を更新するために使用します |
置く | /api/invoices/:id/void |
無効 |
承認済みの請求書を無効にする これは、承認済みおよび保留中の受領書に関するインボイスでのみ使用できます。
|
置く | /api/invoices/:id/withdraw_dispute |
論争の取消 |
論争の取消 サプライヤーの不作為または購入者側のミスにより、論争中のインボイスは承認プロセスに戻されます。 |
GET | / api / invoices /:id / retrieve_legal_invoice_pdf | retrieve_legal_invoice_pdf | 法定インボイスのPDFをダウンロード/取得します。このアクションでは、PDF添付ファイルをAPI呼び出しでエクスポートできます。 |
要素
要素 | 説明 | 必須 | 一意 | 許容値 | で | アウト | データタイプ |
---|---|---|---|---|---|---|---|
放棄理由 | 放棄理由 | no | no | 任意 | はい | 理由インサイト | |
account-type | 勘定科目表参照 | はい | はい | はい | 勘定科目のタイプ | ||
advance-payment-received-amount | 受領された前受金/前払金の金額 | はい | はい | 小数(30,4) | |||
amount-due-less-discount | 割引適用後の未払い額 | 任意 | はい | decimal型 | |||
approvals | 承認 | はい | 承認 | ||||
attachments | はい | 添付ファイル | |||||
archive-entity-id | エンティティIDをアーカイブ | はい | 整数 | ||||
bill_to_address | 請求先住所 | はい | はい | はい | 住所 | ||
購入者税登録 | 購入者税登録 | はい* | はい | 税務登録情報 | |||
キャンセル済み | 取引がキャンセルされたかどうかを示します | はい | ブール値 | ||||
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によって自動的に作成されます | はい | 日時 | ||||
created_by | 作成したユーザー | はい | ユーザー | ||||
credit-note-differences-with-original-invoice | 元のインボイスとクレジットメモの差額 | はい | はい | 小数(30,4) | |||
credit-reason | クレジットを作成する理由 | はい | はい | 文字列(255) | |||
currency | 通貨コード | はい | はい | 通貨 | |||
現在の統合履歴レコード | 現在の統合履歴レコード | はい | インテグレーション履歴記録 | ||||
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_due_date | 割引支払条件に基づいて計算された割引期日 | はい | 日時 | ||||
discount-percent | 割引 % | はい | はい | 浮動小数 | |||
dispute-method | クレーム方法 | no | no | 任意 | はい | 文字列(10) | |
dispute_reasons | クレーム理由 | no | no | 任意 | はい | クレーム理由 | |
document-type | 請求書または貸方票 | 請求書、貸方票 | はい | 文字列(255) | |||
early_payment_provisions | 早期支払インセンティブ | はい | はい | 文字列(255) | |||
exchange-rate | 為替レート | はい | はい | 小数(30,9) | |||
exported | トランザクションがエクスポートされたかどうかを示します | はい | ブール値 | ||||
許容誤差 | 許容誤差の失敗 | はい | はい | Invoice :: FailedTolerance | |||
folio-number | フォリオ番号 | はい | 文字列(20) | ||||
form-of-payment | 支払フォーム | はい | 文字列(10) | ||||
gross-total | 総計 | はい | decimal型 | ||||
gross-total-less-discount | 割引適用後の請求合計 | 任意 | はい | decimal型 | |||
handling-amount | 取扱手数料額 | はい | はい | 小数(32,4) | |||
id | Coupaの一意の識別子 | はい | 整数 | ||||
画像スキャン | 請求書イメージスキャン添付ファイル名 | はい | 文字列(255) | ||||
image-scan-url | 請求書画像スキャンURL。「http://」または「https://」で始まる必要があります。 | はい | 文字列(255) | ||||
InboundInvoice | インバウンド請求書参照 | はい | 送られてくる請求書 | ||||
inbox-name | 受信トレイ名 | はい | string型 | ||||
internal-note | 内部メモ | はい | はい | テキスト | |||
請求書手数料 | 請求書手数料 | はい | はい | インボイス料金 | |||
invoice-date | 請求日 | はい | はい | はい | 日時 | ||
請求元住所 | 請求元住所 | はい* | はい | サプライヤー支払先 | |||
invoice_lines | レコード識別子 | はい | はい | インボイス品目 | |||
invoice-number | 請求書番号 | はい | はい | はい | 文字列(40) | ||
請求書支払領収書 | インボイスに関連する支払レシート情報 | はい | インボイス支払レシート | ||||
invoice-reference-number | 請求書参照番号(IRN) | はい | はい | ||||
issuance-place | 発行地 | はい | 文字列(50) | ||||
最終エクスポート日時 | トランザクションが最後に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) | ||||
発送元住所 | 発送元住所 | はい | はい | サプライヤー支払先 | |||
ship_to_address | 出荷先住所 | はい | はい | 住所 | |||
shipping-amount | 発送料金額 | はい | はい | 小数(32,4) | |||
発送期限 | 請求書の発送条件コード | はい | 配送条件 | ||||
税務情報を表示 | 請求書に税情報を表示 | はい | ブール値 | ||||
status | 請求書のステータス | はい | 文字列(50) | ||||
supplier | サプライヤー名または番号 | はい | はい | サプライヤー | |||
サプライヤー作成 | サプライヤーが作成したインボイスのインジケーター | はい | ブール値 | ||||
supplier-note | サプライヤーから提供されていません | はい | はい | テキスト | |||
SupplierRemitTo | サプライヤーが提出した支払先住所 | はい | はい | はい | サプライヤー支払先 | ||
サプライヤー税登録 | サプライヤー税登録 | はい* | はい | 税務登録情報 | |||
サプライヤー合計 | サプライヤー合計 | はい | decimal型 | ||||
taggings | タグ付け | はい | はい | tagging | |||
tags | タグ(廃止、タグ付け関連付けを使用してタグをInvoiceHeaderに追加してください) | はい | はい | タグ | |||
tax-amount | 税額(税が品目レベルで提供されている場合は使用されません) | はい | はい | decimal型 | |||
税額エンジン | 構成に基づいてCoupa NativeまたはExternal Tax Engineによって計算された税額 | はい | 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によって自動的に作成されます | はい | 日時 | ||||
updated_by | 更新したユーザー | はい | ユーザー | ||||
use-of-invoice | インボイスの使用 | はい | 文字列(10) | ||||
源泉徴収税項目 | 源泉徴収税項目 | はい | はい | 源泉徴収税項目 | |||
withholding-tax-override | 源泉徴収税(手数料) | はい | 小数(30,3) | ||||
invoice-reference-number | 請求書参照番号(IRN) | はい | はい | 文字列(255) | |||
supplier-invoice-issuer-name | サプライヤーのインボイス発行者名 | はい | はい | 文字列(255) | |||
supplier-invoice_reviewer-name | サプライヤーのインボイスレビュアー名 | はい | はい | 文字列(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) | |||
supplier-invoice_reviewer-name | サプライヤーのインボイスレビュアー名 | はい | はい | 文字列(255) | |||
supplier-payment-collector-name | サプライヤーの支払集金者名 | はい | はい | 文字列(255) | |||
is-credit-note | 文書タイプ貸方票 | はい | ブール値 | ||||
requester-email | 申請者のメールアドレス | はい | 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コード | はい | テキスト | ||||
発送期限 | 請求書の発送条件コード | はい | |||||
サプライヤー税登録 | はい | はい | |||||
購入者税登録 | はい | はい |
アスタリスク*が付いている必須フィールドは、準拠する請求書の追加必須フィールドです。2つのアスタリスク**でマークされた必須フィールドは、 is-credit-note=true の
場合のみ必須です。
準拠国リスト
このリストは、準拠する請求が可能な国を示しています。Coupaが現在サポートしている準拠国のリストではありません。
id | コード | 名前 |
---|---|---|
14 | au | オーストラリア |
15 | AT | オーストリア |
22 | する | ベルギー |
31 | BR | ブラジル |
34 | bg | ブルガリア |
39 | CA | カナダ |
53 | HR | クロアチア |
55 | CY | キプロス |
56 | cz | チェコ共和国 |
58 | DKsk | デンマーク |
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 | 土 | サウジアラビア |
187 | sg | シンガポール |
188 | sk | スロバキア |
189 | 「Si」 | スロベニア |
192 | za | 南アフリカ |
193 | es | スペイン |
204 | se | スウェーデン |
205 | ch | スイス |
222 | ae |
アラブ首長国連邦 |
223 | US | 米国 |
250 | インスタントメッセージ | マン島 |