agency-time
GET /v1/agency/time/unbilled
What is outstanding, per client and currency.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X GET https://api.zinndigital.com/v1/agency/time/unbilled \
-H "Authorization: Bearer zdk_live_…"מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
The same figure a threshold trigger fires on — one function, deliberately, because two implementations of "how much is outstanding" is how a client is shown £900 and invoiced £1,100. unpriced_minutes is reported separately from the money: hours logged against work with no rate card are not worth zero, they are unpriced, and an agency that cannot see them will not fix them. can_bill says whether the invoicing suite is reachable at all, so the console never offers a Bill-now button that can only refuse.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | string | לא | — |
client_id (query) | string | לא | — |
until (query) | string | לא | Only count work up to and including this date. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
data | UnbilledBucket[] | כן | — |
can_bill | boolean | כן | Whether the agency invoicing suite is reachable at all. Told to the console rather than discovered by pressing the button, so it never offers a Bill-now that can only refuse. |
billing_target | string<agency_invoicing, platform_checkout> | לא | Where Bill now sends the work. platform_checkout only for Zinn Digital®'s own organisation, whose client work is billed on Zinn®'s checkout (docs/670 §3). |
can_start_from_quote | boolean | לא | Whether this caller may list quote requests and start projects from them here — the issuer organisation AND the same quotes.manage staff permission the admin queue requires. |
can_manage_checkout_bills | boolean | לא | Whether this caller may send and void checkout bills here — the issuer organisation AND the same billing.entitlement.manage staff permission the admin console requires. |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 422