agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
認証
ベアラー トークンとして API キーを送信します。キーには agency.invoicing.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
business_name | string | いいえ | — |
address | string | いいえ | — |
email | string | いいえ | — |
phone | string | いいえ | — |
website | string | いいえ | — |
tax_number_label | string | いいえ | — |
tax_number | string | いいえ | — |
payment_instructions | string | いいえ | — |
logo_sha256 | string | いいえ | — |
accent_colour | string | いいえ | — |
default_currency | string | いいえ | — |
default_payment_terms_days | integer | いいえ | — |
default_footer | string | いいえ | — |
default_notes | string | いいえ | — |
number_prefix | string | いいえ | — |
number_padding | integer | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
business_name | string | いいえ | — |
address | string | いいえ | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | いいえ | — |
phone | string | いいえ | — |
website | string | いいえ | — |
tax_number_label | string | いいえ | What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number… |
tax_number | string | いいえ | — |
payment_instructions | string | いいえ | Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act. |
logo_sha256 | string | いいえ | A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time. |
accent_colour | string | いいえ | — |
default_currency | string | はい | — |
default_payment_terms_days | integer | いいえ | — |
default_footer | string | いいえ | — |
default_notes | string | いいえ | — |
number_prefix | string | はい | — |
number_padding | integer | いいえ | — |
next_number | integer | はい | The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands. |
next_number_preview | string | いいえ | What the next invoice will be called, e.g. `INV-0042`. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429