agency-time
POST /v1/agency/time/checkout-bills/{billId}/void
Withdraw an unpaid checkout bill; its hours return to the unbilled pool.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز agency.time.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت میکند.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/agency/time/checkout-bills/{billId}/void \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "reason": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The pay link stops working at once and the time the bill carried is released immediately, so it can be billed again. A paid bill cannot be voided. Requires agency.time.manage and the billing.entitlement.manage staff permission (docs/670 §3).
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
billId (path) | string | بله | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
reason | string | بله | — |
org_id | string | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | string | بله | — |
reference | string | بله | — |
status | string<draft, sent, paid, void> | بله | — |
currency | string | بله | — |
subtotal_minor | integer | بله | — |
tax_minor | integer | بله | — |
total_minor | integer | بله | — |
recipient_email | string | خیر | — |
recipient_country | string | خیر | — |
sent_at | string | خیر | — |
paid_at | string | خیر | — |
voided_at | string | خیر | — |
pay_url | string | بله | The public page the recipient pays this bill on. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422