agency-time
POST /v1/agency/time/checkout-bills/{billId}/void
Withdraw an unpaid checkout bill; its hours return to the unbilled pool.
Doğrulama
API açarını bearer token kimi göndərin. Açar agency.time.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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).
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
billId (path) | string | Bəli | — |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
reason | string | Bəli | — |
org_id | string | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
id | string | Bəli | — |
reference | string | Bəli | — |
status | string<draft, sent, paid, void> | Bəli | — |
currency | string | Bəli | — |
subtotal_minor | integer | Bəli | — |
tax_minor | integer | Bəli | — |
total_minor | integer | Bəli | — |
recipient_email | string | Xeyr | — |
recipient_country | string | Xeyr | — |
sent_at | string | Xeyr | — |
paid_at | string | Xeyr | — |
voided_at | string | Xeyr | — |
pay_url | string | Bəli | The public page the recipient pays this bill on. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422