agency-time

POST `/v1/agency/time/billing-runs`

Bill now — turn unbilled time into a draft invoice.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ JSON باڈی میں ایک فیلڈ کے طور پر org_id لیتا ہے۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X POST https://api.zinndigital.com/v1/agency/time/billing-runs \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "client_id": <string>, "currency": <string> }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

The owner's *"as well as sending on demand invoices"*. Claims the client's unbilled, priced work, hands it to the agency invoicing suite as a **draft**, and records what came back. ⛔ The entries are claimed in a committed transaction **before** the invoicing suite is called, so no other trigger can select them while the call is in flight. The idempotency key handed to the suite is derived from the sorted entry ids rather than minted, so a retry after a crash is given back the invoice that already exists instead of raising a second one for the same hours. `reconcile_state` is `ok` only when the invoice's total for these lines equals our own exact arithmetic. `mismatch` means do not send it.

درخواست کا باڈی

نام	قسم	لازمی	یہ کیا ہے
`client_id`	`string`	ہاں	—
`currency`	`string`	ہاں	—
`until`	`string`	نہیں	Bill work up to and including this date — "everything to the end of last month".
`notes`	`string`	نہیں	—
`org_id`	`string`	نہیں	—

جواب

نام	قسم	لازمی	یہ کیا ہے
`id`	`string`	ہاں	—
`client_id`	`string`	نہیں	—
`currency`	`string`	ہاں	—
`period_start`	`string`	نہیں	—
`period_end`	`string`	نہیں	—
`trigger`	`string<manual, on_log, day_of_month, threshold>`	ہاں	—
`status`	`string<claimed, invoiced, failed, released>`	ہاں	`claimed` is the state between claiming the time and the invoicing suite's reply — a process that dies there leaves one, and the recovery pass finishes it with the same derived…
`subtotal_minor`	`integer`	ہاں	Our own exact arithmetic, before tax. What the invoice is reconciled against.
`minutes_total`	`integer`	ہاں	—
`duration_label`	`string`	نہیں	—
`entry_count`	`integer`	نہیں	—
`fixed_line_count`	`integer`	نہیں	—
`invoice_id`	`string`	نہیں	—
`invoice_number`	`string`	نہیں	—
`invoice_created`	`boolean`	نہیں	FALSE means the invoicing suite's idempotency key fired and handed back an invoice an earlier attempt had already raised. Surfaced rather than hidden: it is the observable that…
`reconcile_state`	`string<pending, ok, mismatch, unavailable>`	نہیں	Whether the invoice's total for these lines equals our own arithmetic exactly. There is no "close enough": both sides compute from the same two integers, so any difference i…
`reconcile_detail`	`string`	نہیں	—
`invoiced_at`	`string`	نہیں	—
`released_at`	`string`	نہیں	—
`last_error`	`string`	نہیں	—
`created_at`	`string`	ہاں	—
`actual`	`object`	نہیں	What this run actually consumed, derived from the time entries rather than read off the run's stored columns — so a divergence is visible on the screen.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 422