agency-time

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

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

Бүх agency-time төгсгөлийн цэгүүд

Хөгжүүлэгчийн бүх баримт бичиг

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь agency.time.manage эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Таны байгууллагын дугаар орох газар

Энэ төгсгөлийн цэг нь 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Тийм

Хүсэлтийн бие

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
reasonstringТийм
org_idstringҮгүй

Хариу үйлдэл

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
idstringТийм
referencestringТийм
statusstring<draft, sent, paid, void>Тийм
currencystringТийм
subtotal_minorintegerТийм
tax_minorintegerТийм
total_minorintegerТийм
recipient_emailstringҮгүй
recipient_countrystringҮгүй
sent_atstringҮгүй
paid_atstringҮгүй
voided_atstringҮгүй
pay_urlstringТиймThe public page the recipient pays this bill on.

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 422