agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}/pdf
A short-lived download URL for the invoice PDF.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung agency.invoicing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Hier kommt Ihre Organisations-ID hin
Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.
Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/pdf \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
invoiceId (path) | Uuid | Ja | — |
org_id (query) | Uuid | Nein | 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 | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
url | string | Ja | ⛔ 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 | Ja | 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… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429 · 503