agency-time

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

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

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu agency.time.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

Naziv	Vrsta	Obavezno	Što je to
`billId (path)`	`string`	Da	—

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`reason`	`string`	Da	—
`org_id`	`string`	Ne	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`string`	Da	—
`reference`	`string`	Da	—
`status`	`string<draft, sent, paid, void>`	Da	—
`currency`	`string`	Da	—
`subtotal_minor`	`integer`	Da	—
`tax_minor`	`integer`	Da	—
`total_minor`	`integer`	Da	—
`recipient_email`	`string`	Ne	—
`recipient_country`	`string`	Ne	—
`sent_at`	`string`	Ne	—
`paid_at`	`string`	Ne	—
`voided_at`	`string`	Ne	—
`pay_url`	`string`	Da	The public page the recipient pays this bill on.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422