agency-time
POST /v1/agency/time/billing-runs
Bill now — turn unbilled time into a draft invoice.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את 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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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