agency-time
GET /v1/agency/time/unbilled
What is outstanding, per client and currency.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/agency/time/unbilled \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | string | Non | — |
client_id (query) | string | Non | — |
until (query) | string | Non | Only count work up to and including this date. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
data | UnbilledBucket[] | Oui | — |
can_bill | boolean | Oui | 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> | Non | 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 | Non | 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 | Non | 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. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422