agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 agency.invoicing.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
⭐ Every invoice you have raised against them, what they still owe and what they have been billed in total — the "all client history" screen in one request rather than a filtered list. Requires `agency.invoicing.view`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
clientId (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… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | 是 | — |
contact_name | string | 否 | — |
email | string | 否 | — |
phone | string | 否 | — |
address | string | 否 | — |
tax_number_label | string | 否 | — |
tax_number | string | 否 | — |
currency | string | 是 | — |
locale | string | 否 | Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice. |
notes | string | 否 | — |
archived | boolean | 否 | — |
created_at | string | 否 | — |
invoices | AgencyInvoice[] | 否 | — |
outstanding_minor | integer | 否 | What this client still owes, in minor units. |
invoiced_total_minor | integer | 否 | Everything ever billed to them, void invoices excluded. |
此端点可能返回的错误
401 · 403 · 404 · 429