agency-time

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

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

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie agency.time.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

Nazwa	Typ	Wymagane	Co to jest
`billId (path)`	`string`	Tak	—

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`reason`	`string`	Tak	—
`org_id`	`string`	Nie	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`string`	Tak	—
`reference`	`string`	Tak	—
`status`	`string<draft, sent, paid, void>`	Tak	—
`currency`	`string`	Tak	—
`subtotal_minor`	`integer`	Tak	—
`tax_minor`	`integer`	Tak	—
`total_minor`	`integer`	Tak	—
`recipient_email`	`string`	Nie	—
`recipient_country`	`string`	Nie	—
`sent_at`	`string`	Nie	—
`paid_at`	`string`	Nie	—
`voided_at`	`string`	Nie	—
`pay_url`	`string`	Tak	The public page the recipient pays this bill on.

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422