agency-time

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

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

Tous les points de terminaison agency-time

Toute la documentation pour développeurs →

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation agency.time.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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ètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`billId (path)`	`string`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`reason`	`string`	Oui	—
`org_id`	`string`	Non	—

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`reference`	`string`	Oui	—
`status`	`string<draft, sent, paid, void>`	Oui	—
`currency`	`string`	Oui	—
`subtotal_minor`	`integer`	Oui	—
`tax_minor`	`integer`	Oui	—
`total_minor`	`integer`	Oui	—
`recipient_email`	`string`	Non	—
`recipient_country`	`string`	Non	—
`sent_at`	`string`	Non	—
`paid_at`	`string`	Non	—
`voided_at`	`string`	Non	—
`pay_url`	`string`	Oui	The public page the recipient pays this bill on.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422