agency-invoicing
PATCH /v1/agency-invoicing/invoices/{invoiceId}
Edit a draft invoice.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 agency.invoicing.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
⛔ A `409` means the invoice has been issued and its figures are frozen. A sent invoice is a document your client is holding — void it and issue a replacement rather than restating it. Requires `agency.invoicing.manage`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
invoiceId (path) | Uuid | 是 | — |
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… |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
currency | string | 否 | — |
issue_date | string | 否 | — |
due_date | string | 否 | — |
reference | string | 否 | — |
notes | string | 否 | — |
footer | string | 否 | — |
lines | AgencyInvoiceLineWrite[] | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
number | string | 否 | The agency's own number. ⛔ Empty until issue: a number allocated to something that may never be sent leaves a hole in a sequence. |
status | string<draft, sent, partially_paid, paid, void> | 是 | — |
is_overdue | boolean | 否 | ⭐ DERIVED from the due date and the status, never stored — so there is no sweep to maintain a flag and nothing to go stale. A draft is never overdue however old it is: nobody ha… |
client_id | Uuid | 否 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_name | string | 否 | — |
currency | string | 是 | — |
issue_date | string | 是 | — |
due_date | string | 否 | — |
reference | string | 否 | — |
notes | string | 否 | — |
footer | string | 否 | — |
subtotal_minor | integer | 否 | — |
discount_minor | integer | 否 | — |
tax_minor | integer | 否 | — |
total_minor | integer | 是 | — |
amount_paid_minor | integer | 否 | — |
amount_due_minor | integer | 否 | — |
tax_breakdown | AgencyInvoiceTaxGroup[] | 否 | — |
source | string | 否 | Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it. |
sent_at | string | 否 | — |
last_sent_to | string | 否 | — |
paid_at | string | 否 | — |
void_reason | string | 否 | — |
created_at | string | 否 | — |
lines | AgencyInvoiceLine[] | 否 | — |
payments | AgencyInvoicePayment[] | 否 | — |
portal_url | string | 否 | The payment link to send to the client. ⛔ Returned on a SINGLE-invoice read only, never in a list: a list is the thing that gets logged, cached and pasted into a support ticket,… |
此端点可能返回的错误
401 · 403 · 404 · 409 · 422 · 429