agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}/pdf
A short-lived download URL for the invoice PDF.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението agency.invoicing.view; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/pdf \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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… |
locale (query) | string | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
url | string | Да | ⛔ 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 | Да | 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… |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429 · 503