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