View Categories

API REST – Comptabilité analytique

3 minutes

L’API permet de consulter les affectations comptabilisées, les états analytiques et leur rapprochement avec la comptabilité générale. Elle permet aussi de configurer les axes, de corriger une ligne enregistrée et de reclasser une part après clôture.

Les opérations ci-dessous utilisent la session de l’API REST. Les droits de l’utilisateur connecté s’appliquent à la société, à la pièce, aux axes et aux valeurs demandés.

Consulter les chiffres #

Opération GET Résultat
analytic_entry Parts enregistrées d’une écriture comptable, avec leurs axes, valeurs et origine. Paramètre : id, identifiant Webservice de l’écriture.
analytic_axis_totals Débit, crédit et net par valeur d’un axe. Paramètres : organizationId, dateFrom, dateTo, axisId, accountPrefix facultatif.
analytic_cross_axis Tableau croisé de deux axes, avec « Non ventilé », totaux et indicateurs de rapprochement. Paramètres : société, dates, rowAxisId, columnAxisId.
analytic_profit_and_loss Compte de résultat analytique et comparaison au total comptable. Paramètres : société, dates, axisId, analyticValueId facultatif.
analytic_general_ledger Lignes du grand livre filtrées par axe, valeur, compte et éventuellement un second axe. Paramètres : société, dates, axisId, analyticValueId, accountPrefix, secondAxisId, secondValueId.
analytic_key_distribution Parts d’une clé fixe et valeurs disponibles. Paramètre : id, identifiant Webservice de la clé.

Dans les opérations de rapport, les identifiants de société et d’axes sont les identifiants numériques des enregistrements ; les identifiants de pièce et de clé utilisent le format Webservice Nx123. Les dates sont au format AAAA-MM-JJ.

Les montants sont exprimés dans la devise comptable de la société. « Non ventilé » est inclus dans les totaux analytiques ; un écart de couverture indique séparément les écritures générales qui n’ont pas encore de parts enregistrées. Pour deux sociétés de devises comptables différentes, demandez deux rapports distincts.

Saisir ou corriger une affectation par ligne #

Utilisez l’opération POST update_analytic_line_choice pour changer un axe sur une ligne déjà enregistrée. L’opération met à jour le choix, régénère les écritures et renvoie l’affectation enregistrée. Elle exige une période comptable ouverte et le droit de modifier la pièce ainsi que l’affectation analytique.

Paramètre Valeur
sourceId Identifiant Webservice de la facture fournisseur ou de la saisie manuelle.
lineKey Clé stable de la ligne, renvoyée avec la ligne enregistrée.
axisId Identifiant Webservice de l’axe.
mode automatic, value, key ou unallocated.
targetId Identifiant Webservice de la valeur pour value, ou de la clé de répartition pour key ; chaîne vide dans les autres cas. 
curl -X POST 'https://apps.kafinea.com/YourKafinea/webservice.php' \
  -d 'operation=update_analytic_line_choice' \
  -d 'sessionName=YOUR_SESSION_ID' \
  -d 'sourceId=81x123' \
  -d 'lineKey=00000000-0000-4000-8000-000000000001' \
  -d 'axisId=82x456' \
  -d 'mode=value' \
  -d 'targetId=83x789'

La clé de ligne doit provenir de la réponse de l’API pour la pièce concernée. Sur une facture fournisseur, elle figure avec les lignes du document ; sur une saisie manuelle, avec ses lignes comptables. Le numéro d’ordre de la ligne et le numéro de compte ne remplacent pas cette clé.

Pour revenir aux règles de la société, envoyez mode=automatic et un targetId vide. Pour garder le montant dans l’analyse sans valeur sur cet axe, envoyez mode=unallocated. Une clé fixe peut partager la même ligne entre plusieurs valeurs ; les parts sont calculées à partir du montant réellement comptabilisé.

Reclasser après clôture #

Pour une période close, l’opération POST reclassify_analytic_allocation enregistre une correction datée du jour dans une période ouverte. Elle crée deux mouvements analytiques de montants opposés : l’affectation de la période close et l’écriture de comptabilité générale restent inchangées.

Paramètre Valeur
allocationId Identifiant Webservice de la part, fourni dans analytic_entry sous portions[].id.
axisId Identifiant Webservice de l’axe à corriger.
targetValueId Identifiant Webservice de la nouvelle valeur ; chaîne vide pour « Non ventilé ».
reason Motif explicite de 5 à 255 caractères.

L’opération exige une période ouverte à la date du jour, des droits comptables complets et la même devise comptable pour les deux périodes. Une part déjà reclassée demande une revue comptable avant une autre correction. Le grand livre analytique présente les deux mouvements à leur date ; les tableaux croisés et le compte de résultat reprennent leur effet net.

Configurer les axes et les clés #

Les axes, valeurs, correspondances, règles et clés sont des paramètres accessibles par les opérations habituelles de lecture et de saisie, selon les droits de l’utilisateur. Vérifiez les champs disponibles et la portée de la société avant d’écrire. L’opération update_analytic_key_distribution remplace toutes les parts d’une clé fixe en une fois ; le total doit être exactement de 100 %.

Le serveur MCP et l’Assistant Kafinea donnent accès à ces mêmes états, aux corrections par ligne et au reclassement daté, sous leurs contrôles de modification des données. Une modification de paramètre ne réécrit pas les montants déjà comptabilisés.

Références associées #