agency-time

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

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

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα agency.time.manage· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Πού μπαίνει το αναγνωριστικό του οργανισμού σας

Αυτό το endpoint δέχεται το πεδίο org_id στο σώμα JSON.

Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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

Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό API, ώστε να μπορείτε να δείτε την πραγματική απόκριση. Ανοίξτε αυτό το τελικό σημείο στην κονσόλα API

Λεπτομέρειες

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

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`billId (path)`	`string`	Ναι	—

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`reason`	`string`	Ναι	—
`org_id`	`string`	Όχι	—

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`id`	`string`	Ναι	—
`reference`	`string`	Ναι	—
`status`	`string<draft, sent, paid, void>`	Ναι	—
`currency`	`string`	Ναι	—
`subtotal_minor`	`integer`	Ναι	—
`tax_minor`	`integer`	Ναι	—
`total_minor`	`integer`	Ναι	—
`recipient_email`	`string`	Όχι	—
`recipient_country`	`string`	Όχι	—
`sent_at`	`string`	Όχι	—
`paid_at`	`string`	Όχι	—
`voided_at`	`string`	Όχι	—
`pay_url`	`string`	Ναι	The public page the recipient pays this bill on.

Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο

401 · 403 · 404 · 422

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