Finance data reading API
The APIs offered on the platform are available free of charge until 10/31/2024 inclusive.
Please contact Customer Success if you wish to subscribe to it on a long-term basis.
Preamble
This article describes the API routes that allow you to retrieve Finance data from Abraxio for integration into a data warehouse or BI tool. To learn more about how APIs generally work, click here .
Budget data
List of budgetary years
GET /v1/datasets/budgets
This route returns the list of budget years:
Field | Technical name | Kind | Comments |
Identifier | id | Exercise identifier : "2024", "2023-2024" | |
Name | name | Text | |
State | status | Object | |
Beginning | start | Date | ISO 8601 standard: yyyy-MM-dd |
END | end | Date |
List of projects
GET /v1/datasets/projects
This route returns the list of projects with their signage:
Field | Technical name | Kind | Comment |
Identifier | id | Ulid | |
Ref | ref | Text | |
Name | label | Text | |
Nature | nature | Object | |
Wallet | portfolio | Obj And | |
Stage | internship | Object | |
State | stat us | Object | |
Resp | manager | Person | |
Business manager | businessManager | Person | |
Analytical axes | dimensions | List of values | Type described below |
List of budget lines for a financial year
GET /v1/datasets/budgets/{budgetId}
This route returns the details of the budget lines of a financial year.
Setting :
- budgetId (required): Identifier of the budget year
This method returns a list of budget lines:
Field | Technical name | Kind | Comment |
Identifier | id | Ulid | |
Source ID | sourceId | Ulid | fed on the archive/arrest lines |
Ref | ref | Text | |
Wording | label | Text | |
State | status | Object | |
Project | project | Project | |
Sub-budget | subBudget | Sub-budget | |
Supplier | to beg | Supplier | |
Category | category | Object | |
Sub-category | subCategory | Object | |
Resource | resource | Object | |
Assignments | assignments | Yes No | |
Time entry | timeEntry | Object | |
Nature of purchase | purchaseNature | Object | |
Activity | activity | Object | |
Accounting ref | accountingRef | Object | |
Analytical axes | dimensions | List of analytical axes | Type described below |
Real estate characteristics | capitalization | Object (Immobilizable/Date /%/duration) | |
CCA Features | prepaidExpenses | Purpose (CCA yes/No / duration/ from) | |
Amounts | aggregates | Object which contains all the amounts for the financial year (Budget, Opex, Capex, Orders, Consumption, etc.) | |
Estimate | estimate | Object | |
Precision | precision | Object | |
Unit | unit | Object | |
Description and Hypotheses | description | Text | |
Evolution explanation | explanation | Text | |
Timeline | schedule | Deadline list | Type described below |
Employee budget
If the collaborators budget is enabled, this route will only return aggregate rows.
For interns:
- A line which aggregates all the internal profile lines called "Employee budget - Internal"
- Calculated reserved budget line in projects/activities
- Calculated internal overflow line
For externals:
- A line which aggregates all the lines of external service providers called "Employee budget - External service providers"
- Calculated reserved budget line in projects/activities
- Calculated line for excess capacity of external service providers
Description of the analytical axes of the Portfolio module
GET /v1/datasets/projects/dimensions
This route returns the description of the personalized analytical axes of the Portfolio module (name, type)
Description of the analytical axes of the Finance module
GET /v1/datasets/budgets/dimensions
This route returns the description of the personalized analytical axes of the Finance module (name, type).
Data from archives/decrees
List of archives/decrees for a financial year
GET /v1/datasets/budgets/{budgetId}/snapshots
This route returns the list of archives/decrees for a budgetary year.
Setting :
- budgetId (required): Identifier of the budget year
This method returns a list of archives/orders:
Field | Technical name | Kind | Comment |
ID | id | Ulid | |
Kind | kind | Object | Archived/Discontinued |
Name | name | Text | |
Date | date | Date |
List of projects in an archive or order
GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/projects
This route returns the list of existing projects in an archive or an order.
Settings :
- budgetId (required): Identifier of the budget year
- snapshotId (required): Identifier of the archive/stopped
The return type is the same as for the list of projects (see above).
List of budget lines in an archive or order
GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}
This route returns the details (signage, analytical axes, amounts aggregated over the financial year, budget schedules) of the budget lines of an archive or an order.
Settings :
- budgetId (required): Identifier of the budget year
- snapshotId (required): Identifier of the archive/stopped
The return type is the same as for the list of budget lines for a financial year (see above).
Description of the analytical axes Portfolio of an archive or an order
GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/projects/dimensions
This route describes the analytical axes of the Portfolio module used in an archive or an order.
Settings :
- budgetId (required): Identifier of the budget year
- snapshotId (required): Identifier of the archive/stopped
Description of the analytical axes Finance of an archive or an order
GET /v1/datasets/budgets/{budgetId}/snapshots/{snapshotId}/dimensions
This route describes the analytical axes of the Finance module used in an archive or an order.
Settings :
- budgetId (required): Identifier of the budget year
- snapshotId (required): Identifier of the archive/stopped
Description of data types
Due date
Field | Technical name | Kind | Comment |
Year | year | Entire | |
Month | month | Entire | |
Amount € | budget | Amount | Excl. tax and/or incl. tax depending on your configuration |
JxH | mdBudget | Decimal | |
P&L amount | pnlBudget | Amount | Excl. tax and/or incl. tax depending on your configuration |
Opex | opex | Amount | Excl. tax and/or incl. tax depending on your configuration |
Capex | capex | Amount | Excl. tax and/or incl. tax depending on your configuration |
Endowments previous | previousDepreciationCharges | Amount | |
New endowments | newDepreciationCharges | Amount | |
CCA news | newPrepaidExpenses | Amount | |
Previous CCAs | previousPrepaidExpenses | Amount |
Description of an analytical axis
Field | Technical name | Kind | Comment |
Coded | coded | Text | Code reused in the list of axes, example “budget-dimension-1” |
Wording | label | Text | Axis name |
Nomenclature | nomenclature | NomenclatureDescription | Defined on the levels of a nomenclature only, see details below |
Configuration | configuration | DimensionConfiguration | see below |
Levels | levels | Text table | Defined on the axes in nomenclatures with the codes of the different levels. If the axis is budget-dimension-1, the table will be ["budget-dimension-1:1", "budget-dimension-1:2", "budget-dimension-1:3"] |
Description of the configuration of a nomenclature (NomenclatureDescription)
Field | Technical name | Kind | Comment |
Coded | coded | Text | axis code in nomenclature: budget-dimension-1 |
Level | level | Entire | Level index (starting at 1 for the first level of the nomenclature) |
Description of setting an axis (DimensionConfiguration)
Field | Technical name | Kind | Comment |
Codified | codified | Boolean | |
Multiple selection | multiSelection | Boolean |
Analytical axes
Field | Technical name | Kind | Comment |
Axis code | coded | Text | "project-dimension-1" |
List of axis values |
Axis values
Field | Technical name | Kind | Comment |
Wording | label | Text | |
Coded | coded | Text | |
Percentage | weight | Decimal | Present only on the Finance axes in multi-selection |
Related Articles
General presentation of the Finance module
Introduction The Finance module enables you to manage your annual Department budget. You can set up your budget for a given Fiscal year by structuring it and defining budget lines. On this basis, you can monitor your Purchase orders and allocate ...Configuring the Finance module
Organization section Default VAT: enter the most frequently used VAT rate (20% in mainland France, 8.5% in overseas departments). This value is set by default when entering amounts in Abraxio and can be overridden to manage exceptions. Capitalized ...Initialising the annual budget
Creating the Department budget When you first access the Abraxio Finance module, you will be prompted to create your Department budget. Click on Finance in the left menu bar You will be taken to the Department budget creation wizard: Step 1: Initiate ...Abraxio APIs - General
The APIs offered on the platform are available free of charge until 10/31/2024 inclusive. For any additional information, contact your Customer Success Manager or send an email directly to subscription@abraxio.com . Two categories of APIs are made ...Abraxio APIs - PowerBI Tutorial
The APIs offered on the platform are available free of charge until 10/31/2024 inclusive. For any additional information, contact your Customer Success Manager or send an email directly to subscription@abraxio.com . Connect your data to the Abraxio ...