agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 agency.invoicing.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 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