agency-time

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

Bill now — turn unbilled time into a draft invoice.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

حيث يتم إدخال معرف مؤسستك

تقبل هذه نقطة النهاية org_id حقلًا في نص JSON.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (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

التفاصيل

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