agency-time

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

Bill now — turn unbilled time into a draft invoice.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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

POST /v1/agency/time/billing-runs