agency-time
POST /v1/agency/time/checkout-bills/{billId}/void
Withdraw an unpaid checkout bill; its hours return to the unbilled pool.
প্রমাণীকরণ
একটি বিয়ারার টোকেন হিসেবে একটি এপিআই কি পাঠান। কি-টির অবশ্যই agency.time.manage অনুমতি থাকতে হবে; এটি ছাড়া কোনো কি ৪০৪ নয়, বরং ৪০৩ ত্রুটি দিয়ে প্রত্যাখ্যাত হবে।
যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে
এই এন্ডপয়েন্টটি JSON বডিতে একটি ক্ষেত্র হিসেবে org_id গ্রহণ করে।
আপনার ড্যাশবোর্ডের 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> }'লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন
বিবরণ
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