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 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ესენდპოინტი იღებს org_id-ს JSON ტანის ველად.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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