Budgea API Documentation

"

This endpoint is used to enable a source or force a synchronization on it.<br><br>

"

This endpoint is used to enable a source or force a synchronization on it.<br><br>

Add a new connection.

Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).<br><br>

Add a new keyword associated with a category in the database.

If the keyword already exists the keyword is not added. Used for the categorization of transactions.<br><br>Form params: - id_category (integer): a reference towards the category associated with the keyword - keyword (string): the searched keyword - income (bool): 1 if the associated category represents an income else 0 - priority (integer): sets the priority for the keyword, used when categorizing<br><br>

categorize transactions without storing them

It requires an array of transaction dictionaries. Any fields of transactions that are not required will be kept in the response. The response contains the list of transactions with two more fields: id_category and state (it indicates how the transaction has been categorized)<br><br>

Create a client

Create a connector Logo

This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.<br><br>Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.<br><br>

Create a new anonymous user

This endpoint creates a new temporary token related to a new anonymous user.<br><br>It will expire 30 minutes after.<br><br>Note: if you supply client_id and client_secret, or if you call this endpoint with the manage_token, the token will be permanent.<br><br>

Create a new transaction category

Create an account

This endpoint creates an account related to a connection or not.<br><br>

Create bank categories

It requires the name of the category to be created<br><br>

Create clustered transaction

Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account<br><br>

Create clustered transaction

Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account<br><br>

Create clustered transaction

Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account<br><br>

Create transactions

Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.<br><br><br><br>

Delete a client

Delete a clustered transaction

Delete a clustered transaction

Delete a clustered transaction

Delete a connection.

This endpoint deletes a connection and all related accounts and transactions.<br><br>

Delete a particular key-value pair on a transaction.

Delete a single Logo object.

Delete a user-created transaction category

Delete all accounts

Delete all connections

Delete an account.

It deletes a specific account.<br><br>

Delete the client logo

Delete the supplied category

Delete the user

This endpoint deletes the user.<br><br>

Disable a connection source

This will make it so the specified source will not be synchronized anymore.<br><br>

Disable a connection source

This will make it so the specified source will not be synchronized anymore.<br><br>

Edit a bank categories

Edit the name for the supplied category.<br><br>

Get a connector

Get a connector

Get a connector

Get a profile

Get a random subset of provider's id_connection

By default, it selects a set of 3 connections.<br><br>

Get a subset of id_connection for a given bank. Different selection methode are possible

By default, it selects a set of 3 connections with the 'diversity' method<br><br>

Get a user

Get account types

Get account types

Get accounts list.

Get alerts

Get all categories

Ressource to get all existing categories<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get all links to the files associated with this connector.

This endpoint returns all links to files associated with this connector.<br><br>

Get an account type

Get an account type

Get clustered transactions

Get clustered transactions

Get clustered transactions

Get configuration change history of the API.

<br><br>

Get configuration of a user.

<br><br>

Get configuration of the API.

<br><br>

Get connection additionnal informations

<br><br>

Get connection logs

Get logs about connections.<br><br>

Get connection sources

Get connection sources

Get connections

Get connections without a user

Get details for a given psd2 registration

Get details on all psd2 registrations

Get fields specific to a domain and a source

Get fields specific to a domain and a source

Get fields specific to a domain and a source

Get forecast

Get incidents logs.

By default, provide all incidents. Results are paginated. Some filters can be set via query parameters.<br><br>

Get information about a client

If you use the manage_token or a configuration token, you will get also the client secret.<br><br>

Get invoicing data for a given period (default is the current month).

You can get all the invoicing data or just specific ones by using the available parameters.<br><br>If no parameters are specified, no invoicing data is returned.<br><br>

Get list of connector sources

Get list of connector sources

Get list of connector sources

Get list of connectors

Get list of connectors

Get list of connectors

get performances stats on this instance

Get profiles

Get public encryption key of the API.

Get the category

Ressource to get categories for the user's transactions<br><br>

Get the category

Ressource to get categories for the user's transactions<br><br>

Get the category

Ressource to get categories<br><br>

Get the category

Ressource to get categories for the user's transactions<br><br>

Get the connector source

Get the connector source

Get the connector source

Get the latest certificate of a type

Get the main profile

Get users

Insert/update configuration key(s)/value(s) on the API.

List clients

Request a new connector

Send a request to add a new connector<br><br>

Test synchronization on a random connection.

It can be used to test receiving data on your webhooks.<br><br>

Update the client logo