agency-time
POST /v1/agency/time/billing-runs
Bill now — turn unbilled time into a draft invoice.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako pole v těle JSON.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
client_id | string | Ano | — |
currency | string | Ano | — |
until | string | Ne | Bill work up to and including this date — "everything to the end of last month". |
notes | string | Ne | — |
org_id | string | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
client_id | string | Ne | — |
currency | string | Ano | — |
period_start | string | Ne | — |
period_end | string | Ne | — |
trigger | string<manual, on_log, day_of_month, threshold> | Ano | — |
status | string<claimed, invoiced, failed, released> | Ano | `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 | Ano | Our own exact arithmetic, before tax. What the invoice is reconciled against. |
minutes_total | integer | Ano | — |
duration_label | string | Ne | — |
entry_count | integer | Ne | — |
fixed_line_count | integer | Ne | — |
invoice_id | string | Ne | — |
invoice_number | string | Ne | — |
invoice_created | boolean | Ne | 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> | Ne | 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 | Ne | — |
invoiced_at | string | Ne | — |
released_at | string | Ne | — |
last_error | string | Ne | — |
created_at | string | Ano | — |
actual | object | Ne | 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. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422