agency-time

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

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) agency.time.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a org_id mezőt várja a JSON törzsben.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

Név	Típus	Kötelező	Mi ez
`billId (path)`	`string`	Igen	—

Kérés törzse

Név	Típus	Kötelező	Mi ez
`reason`	`string`	Igen	—
`org_id`	`string`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`reference`	`string`	Igen	—
`status`	`string<draft, sent, paid, void>`	Igen	—
`currency`	`string`	Igen	—
`subtotal_minor`	`integer`	Igen	—
`tax_minor`	`integer`	Igen	—
`total_minor`	`integer`	Igen	—
`recipient_email`	`string`	Nem	—
`recipient_country`	`string`	Nem	—
`sent_at`	`string`	Nem	—
`paid_at`	`string`	Nem	—
`voided_at`	`string`	Nem	—
`pay_url`	`string`	Igen	The public page the recipient pays this bill on.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422