Abraxio APIs - Restitution de masse ("Datasets")

Préambule

Cet article décrit les routes API qui permettent de récupérer les données Finance d'Abraxio pour intégration dans un entrepôt de données ou un outil BI. Pour en savoir plus sur le fonctionnement général des API, cliquez ici.

Données du budget 

Liste des exercices budgétaires

GET /v1/datasets/budgets

Cette route retourne la liste des exercices budgétaires :

Champ	Nom technique	Type	Commentaires
Identifiant	id		Identifiant d'un exercice : "2024", "2023-2024"
Nom	name	Texte
Etat	status	Objet
Début	start	Date	Norme iso 8601 : yyyy-MM-dd
Fin	end	Date

Liste des projets

GET /v1/datasets/projects

Cette route retourne la liste des projets avec leurs signalétiques :

Champ	Nom technique	Type	Commentaire
Identifiant	id	Ulid
Ref	ref	Texte
Nom	label	Texte
Nature	nature	Objet
Portefeuille	portfolio	Objet
Etape	stage	Objet
Etat	status	Objet
Resp	manager	Person
Resp métier	businessManager	Person
Axes analytiques	dimensions	Liste des valeurs	Type décrit plus bas

Liste des lignes budgétaires d'un exercice

GET /v1/datasets/budgets/{budgetId}

Cette route retourne le détail des lignes budgétaires d'un exercice.

Paramètre :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   

Cette méthode retourne une liste de lignes budgétaires : 

Champ	Nom technique	Type	Commentaire
Identifiant	id	Ulid
Identifiant source	sourceId	Ulid	alimenté sur les lignes d'archives/arrêtés
Ref	ref	Texte
Libellé	label	Texte
Etat	status	Objet
Projet	project	Projet
Sous-budget	subBudget	Sous-budget
Fournisseur	supplier	Fournisseur
Catégorie	category	Objet
Sous-catégorie	subCategory	Objet
Ressource	resource	Objet
Affectations	assignments	Oui/Non
Saisie temps	timeEntry	Objet
Nature d'achat	purchaseNature	Objet
Activité	activity	Objet
Ref comptable	accountingRef	Objet
Axes analytiques	dimensions	Liste d'axes analytiques	Type décrit plus bas
Caractéristiques d'immo	capitalization	Objet (Immobilisable/Date /%/durée )
Caractéristiques CCA	prepaidExpenses	Objet (CCA oui/Non / durée/ à partir du)
Montants	aggregates	Objet qui contient tous les montants sur l'exercice (Budget, Opex, Capex, Commandes, Conso, ...)
Estimation	estimate	Objet
Précision	precision	Objet
Unité	unit	Objet
Description et Hypothèses	description	Texte
Explication Evolution	explanation	Texte
Echéancier	schedule	Liste d'échéances	Type décrit plus bas

Budget collaborateurs

Si le budget collaborateurs est activé, cette route retournera uniquement des lignes d'agrégats.

Pour les internes :

1. Une ligne qui agrège toutes les lignes de profils internes nommée "Budget collaborateurs - Internes"
   
2. Ligne calculée de budget réservé dans les projets/activités
   
3. Ligne calculée de dépassement de capacité des internes
   

Pour les externes :

1. Une ligne qui agrège toutes les lignes de prestataires externes nommée "Budget collaborateurs - Prestataires externes"
   
2. Ligne calculée de budget réservé dans les projets/activités
   
3. Ligne calculée de dépassement de capacité des prestataires externes
   

Liste des commandes d'un exercice

GET /v1/datasets/budgets/{budgetId}/orders

Paramètre :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   

Cette méthode retourne une liste de commandes.

Champ	Nom technique	Type	Commentaire
Identifiant ligne commande	id	Ulid
Entête commande	order	OrderHeader	Type décrit plus bas
Ligne budget	budget	BudgetReference	identifiant, référence et libellé de la ligne budget associée
Libellé	label	Texte
Description	description	Texte
Période sur l'exercice	fiscalYearPeriod	Period
Montant sur l'exercice	fiscalYearAmount	Amount
Solde sur l'exercice	fiscalYearBalance	Amount
Période globale	period	Period
Total	totalAmount	Amount
Solde total	totalBalance	Amount

Liste des factures d'un exercice

GET /v1/datasets/budgets/{budgetId}/consumption

Paramètre :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   

Cette méthode retourne une liste de lignes de factures

Paramètres d'immobilisation

Objet (Immobilisable/Date/Durée/Pourcentage)

Champ	Nom technique	Type	Commentaire
Identifiant ligne facture	id	Ulid
En-tête facture	invoice	InvoiceHeader	Type décrit plus bas
Libellé	label	Texte
Ligne budget	budget	BudgetReference	Identifiant, référence et libellé de la ligne budget associée
Ligne commande	order	OrderReference	Identifiant, référence et libellé de la ligne budget associée
Feuille de temps	timesheetEntry	TimesheetEntryReference	Alimenté uniquement sur les factures Temps issues de feuilles de temps. Cet objet contient les valeurs des axes analytiques des feuilles de temps
Collaborateur	collaborator	CollaboratorReference	Alimenté uniquement si le type de facture est Temps ou Rémunération
Montant fixe	fixedAmound	Amount
Prix unitaire	unitPrice	Amount
Quantité	quantity	Décimal
Unité	unit	Unit
Total	total	Amount
Période	period	Period
Paramètres d'immobilisation	capitalization	Objet (Immobilisation/Date/Durée/Pourcentage)

Description des axes analytiques du module Portefeuille

GET /v1/datasets/projects/dimensions

Cette route retourne la description des axes analytiques personnalisés du module Portefeuille (nom, type) 

Description des axes analytiques du module Finance

GET /v1/datasets/budgets/dimensions

Cette route retourne la description des axes analytiques personnalisés du module Finance (nom, type). 

Description des axes analytiques des feuilles de temps

GET /v1/datasets/timsheets/dimensions

Cette route retourne la description des axes analytiques personnalisés des feuilles de temps.

Données des archives/arrêtés

Liste des archives/arrêtés d'un exercice

GET /v1/datasets/budgets/{budgetId}/snapshots

Cette route retourne la liste des archives/arrêtés d'un exercice budgétaire.

Paramètre :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   

Cette méthode retourne une liste d'archives/arrêtés :

Champ	Nom technique	Type	Commentaire
Id	id	Ulid
Type	type	Objet	Archive/Arrêté
Nom	name	Texte
Date	date	Date

Liste des projets d'une archive ou d'un arrêté

GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/projects

Cette route retourne la liste des projets existants dans une archive ou un arrêté.

Paramètres :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   
2. snapshotId (obligatoire) : Identifiant de l'archive/arrêté
   

Le type de retour est le même que pour la liste des projets (voir plus haut).

Liste des lignes budgétaires d'une archive ou d'un arrêté

GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}

Cette route retourne le détail (signalétique, axes analytiques, montants aggrégés sur l'exerciceéchéanciers de budget) des lignes budgétaires d'une archive ou d'un arrêté.

Paramètres :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   
2. snapshotId (obligatoire) : Identifiant de l'archive/arrêté
   

Le type de retour est le même que pour la liste des lignes budgétaires d'un exercice (voir plus haut).

Description des axes analytiques Portefeuille d'une archive ou d'un arrêté

GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/projects/dimensions

Cette route décrit les axes analytiques du module Portefeuille utilisés dans une archive ou un arrêté.

Paramètres :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   
2. snapshotId (obligatoire) : Identifiant de l'archive/arrêté
   

Description des axes analytiques Finance d'une archive ou d'un arrêté

GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/dimensions

Cette route décrit les axes analytiques du module Finance utilisés dans une archive ou un arrêté.

Paramètres :

1. budgetId (obligatoire) : Identifiant de l'exercice budgétaire
   
2. snapshotId (obligatoire) : Identifiant de l'archive/arrêté

Description des types de données 

Echéance

Champ	Nom technique	Type	Commentaire
Année	year	Entier
Mois	month	Entier
Montant €	budget	Montant	HT et/ou TTC en fonction de votre configuration
JxH	mdBudget	Décimal
Montant P&L	pnlBudget	Montant	HT et/ou TTC en fonction de votre configuration
Opex	opex	Montant	HT et/ou TTC en fonction de votre configuration
Capex	capex	Montant	HT et/ou TTC en fonction de votre configuration
Dotations antérieures	previousDepreciationCharges	Montant
Nouvelles dotations	newDepreciationCharges	Montant
CCA nouvelles	newPrepaidExpenses	Montant
CCA antérieures	previousPrepaidExpenses	Montant

Description d'un axe analytique

Champ	Nom technique	Type	Commentaire
Code	code	Texte	Code réutilisé dans la liste d'axes, exemple "budget-dimension-1"
Libellé	label	Texte	Nom de l'axe
Nomenclature	nomenclature	NomenclatureDescription	Défini sur les niveaux d'une nomenclature uniquement, voir le détail plus bas
Configuration	configuration	DimensionConfiguration	voir plus bas
Niveaux	levels	Tableau de texte	Défini sur les axes en nomenclatures avec les codes des différents niveaux. Si l'axe est budget-dimension-1, le tableau sera ["budget-dimension-1:1", "budget-dimension-1:2", "budget-dimension-1:3"]

Description du paramétrage d'une nomenclature (NomenclatureDescription)

Champ	Nom technique	Type	Commentaire
Code	code	Texte	code de l'axe en nomenclature : budget-dimension-1
Niveau	level	Entier	Index du niveau (début à 1 pour le premier niveau de la nomenclature)

Description du paramétrage d'un axe (DimensionConfiguration)

Champ	Nom technique	Type	Commentaire
Codifié	codified	Booléen
Sélection multiple	multiSelection	Booléen

Axes analytiques

Champ	Nom technique	Type	Commentaire
Code de l'axe	code	Texte	"project-dimension-1"
Liste de valeurs d'axes

Valeurs d'axes

Champ	Nom technique	Type	Commentaire
Libellé	label	Texte
Code	code	Texte
Pourcentage	weight	Décimal	Présent uniquement sur les axes Finance en multi-sélection

• Related Articles

• Abraxio APIs - Généralités

  Deux catégories d'API sont mise à disposition dans Abraxio : 1. Les API transactionnelles (création et mise à jour de données Abraxio depuis vos outils) Objectifs : Intégration fine et temps réel d'informations ou Intégration en masse par lot de ...

• Import en masse des factures et temps passés

  Principes de fonctionnement Abraxio propose un dispositif d'import en masse des factures et des temps internes qui permet d'industrialiser le suivi du consommé de votre budget. Les grandes étapes du process sont : En amont, génération d'un fichier ...

• Import en masse de commandes

  Principes de fonctionnement Ce dispositif fonctionne en 2 étapes : Etape 1 : Import des données commandes à partir d'un fichier .xlsx ou .csv dans un lot de commandes à traiter Etape 2 : Traitement des lignes d'un lot de commandes importées et ...

• Abraxio APIs - Gestion

  Préambule Les API permettent d'interfacer votre SI avec Abraxio pour automatiser des processus, récupérer des données d'Abraxio ou intégrer des données dans Abraxio. Les appels API sont sécurisés selon le protocole OAuth2. Présentation des scopes Au ...

• Comment initialiser le plan de charges de vos équipes et gérer le capacity planning?

  Préambule Le management des collaborateurs dans Abraxio couplé aux dispositifs de gestion budgétaire et de plan de charges vous procurent des outils de pilotage avancés. La planification des charges des collaborateurs permet de piloter précisément ...