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 ಅನ್ನು ತೆಗೆದುಕೊಳ್ಳುತ್ತದೆ.

ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿಯು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ API ಕೀಗಳ ಪರದೆಯ ಮೇಲೆ, ಕೀ ಯ ಪಕ್ಕದಲ್ಲೇ ಇರುತ್ತದೆ. ನೀವು ಮಾಡುವ ಪ್ರತಿಯೊಂದು ಕರೆ(call)ಯಲ್ಲೂ ಇದು ಒಂದೇ ಐಡಿ ಆಗಿರುತ್ತದೆ.

ಪ್ರಯತ್ನಿಸಿ

ಕೋನೀಯ ಬ್ರಾಕೆಟ್‌ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್‌ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.

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