agency-invoicing
GET /v1/agency-invoicing/invoices/{invoiceId}/pdf
A short-lived download URL for the invoice PDF.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền agency.invoicing.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Nơi điền id tổ chức của bạn
Điểm cuối này nhận org_id làm tham số truy vấn. Hãy bỏ trống để áp dụng cho toàn bộ cây thuê của bạn; hoặc truyền giá trị vào để thu hẹp phạm vi gọi về một tổ chức duy nhất.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId}/pdf \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
invoiceId (path) | Uuid | Có | — |
org_id (query) | Uuid | Không | 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 | Không | — |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
url | string | Có | ⛔ 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 | Có | 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… |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429 · 503