Comptasse
v1.4.7

Référence API

Conventions, codes d'erreur et catalogue des endpoints de l'API Comptasse

Conventions

L'API de Comptasse suit les conventions REST standard :

  • GET pour la lecture, POST pour la création, PATCH pour la modification, DELETE pour la suppression
  • Le corps de la requête et la réponse sont en JSON
  • Les dates suivent le format ISO 8601
  • Les montants (débit, crédit) sont des chaînes numériques (ex : "100.00")
Information
Les identifiants d'entités (idYear, idEntry, idAccount, etc.) sont passés dans les paramètres d'URL (ex : :idOrganization, :idYear). L'organisation est identifiée via le token d'authentification ou l'en-tête X-Organization-Id, et non dans le corps de la requête.

Un catalogue machine-readable de toutes les routes est exposé publiquement sur GET /routes : méthode, chemin, nom et champs attendus (corps et réponse) pour chaque endpoint, dérivés automatiquement des schémas Valibot.

Authentification

Toutes les routes sont protégées et nécessitent une authentification. Consultez la page Authentification pour les méthodes disponibles.

Gestion des erreurs

Toutes les erreurs sont retournées avec un message en français :

CodeSignification
400Requête invalide - erreur de validation, règle métier non respectée
401Non autorisé - session manquante/invalide, permissions insuffisantes
404Non trouvé - la route n'existe pas
500Erreur interne du serveur

Les messages d'erreur courants incluent :

MessageSignification
Vous n'êtes pas administrateur de l'organisationAccès administrateur requis
Données invalidesLa validation du corps de la requête a échoué
Fichier trop volumineuxLe fichier dépasse la limite de 50 Mo
Limite de stockage atteinteLimite de stockage de l'organisation atteinte

Catégories de routes

L'API expose 120 routes métier réparties en 22 catégories, plus le catalogue GET /routes. Le tableau ci-dessous résume chaque catégorie :

#CatégorieRoutesScope
1Authentification4Public
2Utilisateur5Utilisateur
3Organisations6Utilisateur
4Paramètres d'organisation1Organisation
5Membres5Organisation
6Exercices9Organisation / Exercice
7Scénarios3Exercice
8Comptes6Exercice
9Journaux6Exercice
10Bilans7Exercice
11Comptes de résultat7Exercice
12Calculs7Exercice
13Calculs - comptes de résultat4Exercice
14Écritures11Exercice
15Lignes d'écriture6Exercice
16Tags d'écriture5Exercice
17Étiquettes d'écriture3Exercice
18Fichiers7Exercice
19Dossiers5Exercice
20Exports3Exercice
21Articles d'inventaire5Exercice
22Mouvements d'inventaire5Exercice
Information
Les endpoints d'audit POST .../entries/audit/missing-attachments et POST .../entries/audit/non-balanced listent respectivement les écritures sans pièce justificative et les écritures déséquilibrées. Les scénarios comptables (catégorie 7) génèrent des écritures prêtes à l'emploi : consultez la page Scénarios.