agency-invoicing
POST /v1/agency-invoicing/preview
Total a set of lines without saving anything.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 agency.invoicing.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/preview \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "lines": <AgencyInvoiceLineWrite[]> }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Backs the live preview in the invoice builder. ⭐ It calls the SAME arithmetic the save path uses — a preview computed by a second implementation is one that can disagree with the invoice, and you would find out after you had sent it. Requires `agency.invoicing.view`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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… |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
lines | AgencyInvoiceLineWrite[] | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
line_totals_minor | integer[] | 否 | — |
subtotal_minor | integer | 是 | — |
discount_minor | integer | 否 | — |
tax_minor | integer | 是 | — |
total_minor | integer | 是 | — |
tax_groups | AgencyInvoiceTaxGroup[] | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429