agency-time

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

Withdraw an unpaid checkout bill; its hours return to the unbilled pool.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar agency.time.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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).

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`billId (path)`	`string`	Evet	—

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`reason`	`string`	Evet	—
`org_id`	`string`	Hayır	—

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`string`	Evet	—
`reference`	`string`	Evet	—
`status`	`string<draft, sent, paid, void>`	Evet	—
`currency`	`string`	Evet	—
`subtotal_minor`	`integer`	Evet	—
`tax_minor`	`integer`	Evet	—
`total_minor`	`integer`	Evet	—
`recipient_email`	`string`	Hayır	—
`recipient_country`	`string`	Hayır	—
`sent_at`	`string`	Hayır	—
`paid_at`	`string`	Hayır	—
`voided_at`	`string`	Hayır	—
`pay_url`	`string`	Evet	The public page the recipient pays this bill on.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422