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 अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

POST /v1/agency/time/checkout-bills/{billId}/void