agency-time
POST /v1/agency/time/checkout-bills/{billId}/void
Withdraw an unpaid checkout bill; its hours return to the unbilled pool.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա agency.time.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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).
Պարամետրեր
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
billId (path) | string | Այո | — |
Հարցման մարմին
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
reason | string | Այո | — |
org_id | string | Ոչ | — |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
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