agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}/pdf
A short-lived download URL for the invoice PDF.
Authentication
Send an API key as a bearer token. The key must carry the agency.invoicing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/pdf \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Rendered from the frozen snapshot, so the same invoice re-rendered years from now is the same document. ⛔ The renderer follows no external reference of any kind: your logo is inlined from bytes we hold. Requires `agency.invoicing.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
invoiceId (path) | Uuid | Yes | — |
org_id (query) | Uuid | No | 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… |
locale (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
url | string | Yes | ⛔ A signed URL, and therefore a **credential** until it expires. Do not log it, persist it or put it in a query string of your own — hand it to the thing that will fetch it and… |
expires_at | string | Yes | When the signature stops verifying. ⛔ An absolute instant, not a duration — the spec said `expires_in` for one commit and the handler read a field that does not exist, which was… |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503