agency-time

POST `/v1/agency/time/schedules`

Set a client's billing trigger.

प्रमाणीकरण

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

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

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

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

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

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

curl -X POST https://api.zinndigital.com/v1/agency/time/schedules \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "trigger": <string<manual, on_log, day_of_month, threshold>> }'

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

Idempotent by `(org, client)` — a second POST updates rather than creating a second row, because two schedules for one client is the arrangement that bills them twice. Four triggers: `manual` (on demand only), `on_log` (immediately, as time is logged), `day_of_month`, and `threshold` (when unbilled work reaches an amount). ⛔ `day_of_month` is 1–28, and that is not a limitation of the storage. A schedule set to the 31st would silently skip February, April, June, September and November — seven months a year in which the agency is not paid and nothing is red. "The end of the month" is expressed as 28.

अनुरोध बडी

नाम	प्रकार	आवश्यक	यो के हो
`client_id`	`string`	हैन	—
`trigger`	`string<manual, on_log, day_of_month, threshold>`	हुन्छ	—
`day_of_month`	`integer`	हैन	—
`threshold_minor`	`integer`	हैन	—
`currency`	`string`	हैन	—
`active`	`boolean`	हैन	—
`org_id`	`string`	हैन	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यो के हो
`id`	`string`	हुन्छ	—
`client_id`	`string`	हैन	`null` is the organisation-wide DEFAULT, covering every client without a row of its own. A per-client row replaces it rather than layering on it.
`trigger`	`string<manual, on_log, day_of_month, threshold>`	हुन्छ	—
`day_of_month`	`integer`	हैन	⛔ 1–28. The 29th to the 31st do not exist in every month, so a schedule set to the 31st would silently skip five of them a year.
`threshold_minor`	`integer`	हैन	—
`currency`	`string`	हुन्छ	—
`active`	`boolean`	हुन्छ	—
`next_run_at`	`string`	हैन	—
`last_attempted_at`	`string`	हैन	Stamped for every schedule the sweep REACHES, before its result is read — so a client whose invoice fails still leaves the front of the queue.
`last_succeeded_at`	`string`	हैन	A SECOND column, deliberately: one column cannot serve as both the cursor the sweep advances and the signal a staleness alarm reads.
`last_error`	`string`	हैन	—

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 422

POST /v1/agency/time/schedules