agency-time

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

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění agency.time.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako pole v těle JSON.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Název	Typ	Požadováno	Co to je
`billId (path)`	`string`	Ano	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`reason`	`string`	Ano	—
`org_id`	`string`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`reference`	`string`	Ano	—
`status`	`string<draft, sent, paid, void>`	Ano	—
`currency`	`string`	Ano	—
`subtotal_minor`	`integer`	Ano	—
`tax_minor`	`integer`	Ano	—
`total_minor`	`integer`	Ano	—
`recipient_email`	`string`	Ne	—
`recipient_country`	`string`	Ne	—
`sent_at`	`string`	Ne	—
`paid_at`	`string`	Ne	—
`voided_at`	`string`	Ne	—
`pay_url`	`string`	Ano	The public page the recipient pays this bill on.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422