La récupération des entrées de temps d'une tâche filtrées par type de facturation dans Zoho Desk nécessite une seule requête GET authentifiée vers l'endpoint des entrées de temps propre à la tâche, en transmettant l'identifiant de la tâche comme paramètre de chemin.
Pourquoi c'est important
Lors de la gestion des opérations de support, vous devez souvent distinguer le temps facturable du temps non facturable enregistré pour des tâches — à des fins de facturation, de reporting ou de transparence vis-à-vis des clients. L'API de Zoho Desk expose un endpoint de filtre par type de facturation dédié aux tâches, ce qui permet de récupérer facilement uniquement les entrées de temps correspondant à une catégorie de facturation spécifique, sans avoir à post-traiter une liste complète d'entrées de temps.
Étape par étape
Étape 1. Identifiez le taskId de la tâche dont vous souhaitez récupérer les entrées de temps. Il s'agit de l'identifiant unique que Zoho Desk attribue à l'enregistrement de la tâche — vous pouvez l'obtenir à partir d'un appel API préalable à la liste des tâches ou directement depuis l'URL de l'interface Zoho Desk lors de la consultation de la tâche. [1]
Étape 2. Construisez votre requête GET vers l'endpoint de type de facturation. Le chemin suit ce modèle : [1]
GET /api/v1/tasks/{taskId}/timeEntries/billingType
Remplacez {taskId} par la chaîne d'identification réelle de la tâche.
Étape 3. Incluez les paramètres de requête optionnels en les transmettant sous forme de dictionnaire (désigné par p dans le SDK). Ces paramètres vous permettent de paginer ou de filtrer les résultats renvoyés par l'endpoint. [1]
Étape 4. Envoyez la requête authentifiée. En utilisant le wrapper Python SDK, l'appel se présente comme suit : [1]
result = client.get_task_time_entries_by(taskId="your_task_id_here", p={"billingType": "Billable"})
La méthode émet une requête GET vers /api/v1/tasks/{taskId}/timeEntries/billingType, transmet vos paramètres de requête et renvoie les entrées de temps correspondantes regroupées ou filtrées par type de facturation. [1]
Étape 5. Analysez la réponse. Le contenu renvoyé contiendra les entrées de temps associées à cette tâche, segmentées par leur classification de facturation, que vous pourrez ensuite intégrer à votre pipeline de reporting ou à votre flux de travail de facturation. [1]
---
> Note de Beam Help : Nous sommes un support expert indépendant pour Zoho — et non le support officiel de Zoho. Les étapes ci-dessus reflètent notre analyse de la surface de l'API Zoho Desk.
---
Endpoints associés à connaître
Le filtrage par type de facturation est disponible pour plusieurs types d'entités Zoho Desk, pas seulement pour les tâches. Selon vos besoins en matière de reporting, vous pouvez également interroger : [2][3][4][6]
- Entrées de temps au niveau du compte par type de facturation :
GET /api/v1/accounts/{accountId}/timeEntries/billingType[2] - Entrées de temps au niveau du contact par type de facturation :
GET /api/v1/contacts/{contactId}/timeEntries/billingType[3] - Entrées de temps au niveau du ticket par type de facturation :
GET /api/v1/tickets/{ticketId}/timeEntries/billingType[4] - Entrées de temps au niveau de l'agent par type de facturation :
GET /api/v1/agents/{agentId}/timeEntries/billingType[6]
Chacun suit le même modèle — remplacez le nom de l'entité et son identifiant correspondant dans le chemin.
Erreurs courantes
- Mauvais endpoint d'entité : Si vous appelez accidentellement l'endpoint des tickets (
/tickets/{ticketId}/timeEntries/billingType) alors que vous souhaitez interroger une tâche, vous recevrez des données au niveau du ticket plutôt qu'au niveau de la tâche. Vérifiez toujours si votre enregistrement est une *tâche* ou un *ticket* avant de choisir l'endpoint. [1][4] taskIdmanquant ou mal formé : Transmettre un identifiant de tâche incorrect ou inexistant entraînera une réponse d'erreur. Vérifiez l'identifiant par rapport à vos enregistrements de tâches avant d'effectuer l'appel. [1]- Paramètre
pnon renseigné : Le dictionnairepest optionnel, mais si votre intégration attend des résultats filtrés ou paginés, son omission renverra le jeu de résultats par défaut. Transmettez vos clés de filtre explicitement dans le dictionnaire. [1]
Ce qu'il faut vérifier
- Identifiant de tâche correct : Vérifiez que le
taskIddans votre chemin de requête correspond à une tâche existante dans votre organisation Zoho Desk, et non à un identifiant de ticket ou de contact. [1] - Authentification et contexte de l'organisation : Confirmez que vos identifiants API sont valides et que l'identifiant correct de l'organisation Desk est configuré dans votre client avant d'effectuer l'appel. [7]
- Structure de la réponse : Inspectez le contenu renvoyé pour vous assurer que les entrées de temps sont présentes et que la segmentation par type de facturation correspond à vos attentes — un résultat vide peut indiquer qu'aucune entrée de ce type de facturation n'existe pour la tâche, plutôt qu'une erreur. [1]