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 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हा एंडपॉइंट JSON बॉडीमधील फील्ड म्हणून org_id घेतो.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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