agency-invoicing
POST /v1/agency-invoicing/logo
Upload the logo your invoices carry.
認証
ベアラー トークンとして API キーを送信します。キーには agency.invoicing.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/logo \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔ Its own door, and `POST /v1/branding/logo` cannot serve it: that one stores the mark for a white-labelled **panel**, demands `reseller.manage`, and refuses unless white-label is on the plan — with the message *"a logo here would appear nowhere"*. On a panel that is right. On an invoice it is false: the document is your own paper and carries your mark whatever your plan says. ⭐ The image is vetted and stored content-addressed; the digest returned is what the PDF inlines as a `data:` URI, which is what keeps the render offline. 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… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
logo_sha256 | string | はい | The content digest. ⛔ Not a URL — the invoice renderer inlines the bytes as a `data:` URI and follows no external reference at render time. |
width | integer | いいえ | — |
height | integer | いいえ | — |
byte_size | integer | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429