agency-time

POST `/v1/agency/time/schedules`

Set a client's billing trigger.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כשדה בגוף ה-JSON.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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