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 ని తీసుకుంటుంది.

మీ సంస్థ ఐడి (organisation 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> }'

సైన్ ఇన్ చేశారా? మీ డ్యాష్‌బోర్డ్‌లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ 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