認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/reseller/tax-registrations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "jurisdiction": <string>, "number": <string>, "effective_from": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
**This starts charging VAT immediately.** There is no "record the number but do not charge yet" state: the registration row *is* the switch, so from `effective_from` your clients are charged at the rate for the supply and your number is printed on their invoices. The number is yours and the liability is yours — we do not hold it for approval. We check only that the value could be a VAT number at all; we do not verify it exists. Two registrations in force for one jurisdiction at once is a 422, because the rate charged would then depend on row order rather than on a decision — end the old one first. Requires `reseller.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | いいえ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
jurisdiction | string | はい | ISO country code of the registration — or `EU` for the Union one-stop-shop, which is a scheme rather than a member state. |
scheme | string<standard, flat_rate, oss, non_union_oss> | いいえ | — |
number | string | はい | Your VAT registration number, as it must appear on an invoice. Checked for shape only — we do not verify that it exists, and a number that does not will still charge your client… |
effective_from | string | はい | The date the registration takes effect. Required and never defaulted to today: the date your tax authority gave you is usually not the day you enter it here, and guessing it eit… |
effective_to | object | いいえ | The date it ended, or `null` while still in force. |
in_force | boolean | いいえ | Whether this registration is in force today. |
created_at | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | ResellerTaxRegistration | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429