税率API

関連付け

このリソースは税明細と源泉徴収税明細APIに関連付けられています。

Elements

要素 Description 必須 一意 許容値 入力 出力 データタイプ
アクティブ 税率が有効か無効か true、false yes
 yes
 boolean
国 税コードが適用される国 yes
 yes
 Country
作成日時 CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します yes
 datetime
created-by 作成したユーザー yes
 ユーザー
customer-accounting 顧客の会計

yes, no

true、false

 yes
 yes
 boolean
effective-date 税率が有効になる日付 yes
 yes
 datetime
exempt 税率が免除されているかどうか yes
 true、false yes
 yes
 boolean
expiration-date 税率が期限切れになる日付 yes
 yes
 datetime
ID Coupaの一意の識別子 yes
 整数
percentage 税率パーセンテージ yes
 yes
 yes
 yes
 decimal(30,6)
reverse-charge 税率がリバースチャージかどうか yes
 true、false yes
 yes
 boolean
tax_description 税率の説明 yes
 string(255)
tax-rate-type 税率タイプ yes
 yes
 Tax Rate Type
updated-at CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します yes
 datetime
updated-by 更新したユーザー yes
 ユーザー
out_of_scope yes
 yes
 boolean

API税率ルックアップは新しい属性を使用します

件の請求書APIを使用して税項目を作成または更新する際に、ビジネス関連の属性を組み合わせて 税率 を検索できるようになりました。 この機能強化により、APIの動作が税率のCSVアップロードロジックと一致します。

Invoices APIは、次のフィールドを使用して税率検索をサポートするようになりました。

  • ID

  • TAX_RATE_TYPE （ IDまたは説明）

  • 国 （ IDまたはコード）

  • パーセンテージ

  • exempt

  • reverse_charge

  • out_of_scope

  • customer_accounting

次の表では、有効な組み合わせルールについて説明します。

ルール

Description

IDが優先され、有効性が必要

ペイロードに id を指定した場合、システムはその idのみに基づいて税率を返します。 id が無効な場合、他のフィールドが正しい場合でもエラーが発生します。

パーセンテージと国を必要とする

少なくとも パーセンテージ と カ国を入力する必要があります。 パーセンテージまたは国のいずれかが含まれていない場合、システムはエラーを返します。

ゼロ以外のパーセンテージは免除またはリバースチャージできません

有効なフィールドの組み合わせを送信すると、システムは一致する税率を検索して返却しようとします。 たとえば、有効な国と一緒にゼロ以外のパーセンテージを送信すると、一致する税率が検索されます。 ただし、0以外のパーセンテージを送信し、 exempt = trueまたは reverse_charge = trueのいずれかを設定した場合、これらのフィールドを同時に使用することはできないため、システムはエラーを返します。

0%パーセンテージは、標準または特別料金を決定します

パーセンテージを0 ％に設定し、免除またはreverse_chargeを設定していない場合、または両方をfalseに設定していない場合、システムは標準の0 ％の税率を返します（存在する場合）。 の免除 = trueまたは のreverse_charge = trueと共にパーセンテージ= 0%を設定した場合、システムは対応する免除税率またはリバースチャージ税率を返します（利用可能な場合）。

複数のタイプに税率タイプを必要とする

複数の税率タイプをサポートしている国では、 TAX_RATE_TYPE を指定すると、そのタイプに一致する税率が返されます。 ご提供いただけない場合、システムはエラーを返します。

追加/サポートされていないフィールドを許可しない

ペイロードにサポートされていない追加フィールドが含まれている場合は、エラーが表示されます。

既定の特別税属性はFALSEです

exempt、 reverse_charge、 out_of_scope、または customer_accountingに値を指定しない場合、デフォルトでfalseとして扱われます。

IDは他のすべてのフィールドよりも優先されます

ID と 国 コードの両方を送信すると、システムはIDを使用して税率を返します。 同様に、 ID と TAX_RATE_TYPE の両方の説明を送信すると、IDが優先されます。 無効な id は、他のフィールドが有効であっても、常にエラーを引き起こします。

受け入れ可能なフォーマットの例：

tax_rate_typeの場合： id または description のいずれか。

"tax_rate_type ": {" id ": ""," description ": ""}

countryの場合： id または code のいずれか

"country ": {" id ": ""," code ": ""}

以下の の例 （ json ）は、ペイロードからの tax_rate セクションを示しています。

"tax - rate ": {" percentage ":" 10 "," country ": {" code ": "MX "}," tax - rate - type ": {" description ":" VAT "}}

以下の の例 （ xml ）は、ペイロードからの tax_rate セクションを示しています。

<tax-rate> <percentage>10</percentage> <exempt type="boolean">FALSE</exempt> <reverse_charge type="boolean">FALSE</reverse_charge> <country> <code>MX</code> </country> <tax_rate_type> <description>VAT</description> </tax_rate_type> </tax-rate>
注:
  • 指定された入力に税率が見つからない場合、APIは次のエラーを返します。 キー{" percentage "=>" 404 "}を持つtax_rateの有効なTaxRateレコードを見つけることができません。 使用可能なキーは、[" id ", "code "," description ", "tax_rate_type "," country ", "percentage "," exempt ", "reverse_charge "," out_of_scope ", "customer_accounting "]です。 XML を確認してください。
  • 123 test または test 123のような無効なパーセンテージ値の場合、 123 test は 123に変換され、 test 123 は 0になります。 CSVでも動作は同じです。