agency-time

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

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

પ્રમાણીકરણ

એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે agency.time.manage પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.

જ્યાં તમારી સંસ્થા આઈડી જાય છે

આ એન્ડપૉઇન્ટ JSON બોડીમાં એક ફીલ્ડ તરીકે org_id લે છે.

તમારી સંસ્થાની આઈડી તમારા ડેશબોર્ડ પર API કી સ્ક્રીન પર, કી ની બાજુમાં જ છે. તે તમે કરો છો તે દરેક કૉલમાં સમાન આઈડી છે.

આયમાવો

કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.

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

પેરામીટર્સ

નામ	પ્રકાર	જરૂરી	તે શું છે
`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

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