agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}/pdf
A short-lived download URL for the invoice PDF.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) agency.invoicing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/pdf \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
invoiceId (path) | Uuid | Igen | — |
org_id (query) | Uuid | Nem | 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 | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
url | string | Igen | ⛔ 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 | Igen | 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… |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429 · 503