# Budgea Development Guides Welcome to **Budgea**'s documentation. This documentation is intended to get you up-and-running with our APIs and advise on the implementation of some regulatory aspects of your application, following the DSP2's guidelines. ## Getting Started **IMPORTANT** Depending on your status with regard of the DSP2 regulation, **agent** or **partner**, you may call our APIs or simply use our Webview and callbacks to get the financial data of your users. As an **agent**, you are allowed to call directly our APIs and implement your own form to get the user's credentials. As a **partner**, you cannot manipulate the credentials, and have to delegate this step to us through our webview. The sections below will document how to use our APIs, make sure you have the **agent** status to do so. For the **partner**, please refer to the section *Webview* and *Callbacks* of this documentation. ### Overview Your API is a REST API which requires a communication through https to s
//budgea.biapi.pro/2.0167 endpoints available
/logsGet connection logs
/banksGet list of connectors
/usersGet users
/configGet configuration of the API.
/configInsert/update configuration key(s)/value(s) on the API.
/clientsList clients
/clientsCreate a client
/webauthFirst step to establish an oAuth2 connection.
/auth/jwtGenerate a user jwt token
/webhooksGet webhooks
/webhooksAdds a new webhook
/webhooksDeletes all webhooks
/admin/jwtGenerate a jwt manage token
/auth/initCreate a new anonymous user
/incidentsGet incidents logs.
/invoicingGet invoicing data for a given period (default is the current month).
/providersGet list of connectors
/publickeyGet public encryption key of the API.
/test/syncTest synchronization on a random connection.
/auth/renewGet a new access token given an user id and client credentials
/auth/tokenLogin to API with credentials
/auth/tokenRemove user access
/categoriesGet all categories
/categorizecategorize transactions without storing them
/connectorsGet list of connectors
/connectorsEnable/disable several connectors
/connectorsRequest a new connector
/monitoringget performances stats on this instance
/config/logsGet configuration change history of the API.
/connectionsGet connections without a user
/account_typesGet account types
/test/webhooksTest synchronization on a random connection.
/webhooks/authGet webhooks authentication types
/webhooks/authAdds a new webhook authentication type
/webhooks/authDeletes all webhook authentication types
/auth/token/codeGenerate a user temporary token
/banks/{id_bank}Get a connector
/users/{id_user}Get a user
/users/{id_user}Delete the user
/banks/categoriesCreate bank categories
/auth/token/accessTransform a temporary code to a access_token
/certificate/{type}Get the latest certificate of a type
/psd2-registrationsGet details on all psd2 registrations
/categories/keywordsAdd a new keyword associated with a category in the database.
/clients/{id_client}Get information about a client
/clients/{id_client}Update a client
/clients/{id_client}Delete a client
/users/{id_user}/logsGet connection logs
/users/{id_user}/tokenCreate a token
/webhooks/{id_webhook}Updates a webhook
/webhooks/{id_webhook}Updates a webhook
/webhooks/{id_webhook}Deletes a webhook
/users/{id_user}/alertsGet alerts
/users/{id_user}/configGet configuration of a user.
/users/{id_user}/configChange configuration of a user. modifications on keys prefixed by 'biapi.' (except callback_url) are ignored
/users/{id_user}/configDelete the given user configurations. deletions on keys prefixed by 'biapi.' (except callback_url) are ignored
/providers/{id_provider}Get a connector
/webhooks/auth/{id_auth}Updates the webhook authentication type
/webhooks/auth/{id_auth}Updates the webhook authentication type
/webhooks/auth/{id_auth}Deletes the webhook authentication type
/clients/{id_client}/logoUpdate the client logo
/clients/{id_client}/logoDelete the client logo
/users/{id_user}/forecastGet forecast
/users/{id_user}/profilesGet profiles
/connectors/{id_connector}Get a connector
/connectors/{id_connector}Edit the provided connector
/banks/{id_connector}/logosGet all links to the files associated with this connector.
/users/{id_user}/categoriesGet the category
/webhooks/{id_webhook}/logsGet webhooks logs.
/users/{id_user}/connectionsGet connections
/users/{id_user}/connectionsAdd a new connection.
/users/{id_user}/connectionsDelete all connections
/banks/{id_connector}/sourcesGet list of connector sources
/users/{id_user}/account_typesGet account types
/users/{id_user}/profiles/mainGet the main profile
/banks/categories/{id_category}Edit a bank categories
/banks/categories/{id_category}Delete the supplied category
/providers/{id_connector}/logosGet all links to the files associated with this connector.
/account_types/{id_account_type}Get an account type
/banks/{id_connector}/logos/mainGet all links to the files associated with this connector.
/connectors/{id_connector}/logosGet all links to the files associated with this connector.
/connectors/{id_connector}/logosCreate or Update a connector Logo
/connectors/{id_connector}/logosCreate a connector Logo
/users/{id_user}/categories/fullGet the category
/users/{id_user}/categories/fullCreate a new transaction category
/banks/{id_connector}/connectionsGet a subset of id_connection for a given bank. Different selection methode are possible
/categories/keywords/{id_keyword}Delete a particular key-value pair on a transaction.
/connections/{id_connection}/logsGet connection logs
/providers/{id_connector}/sourcesGet list of connector sources
/connectors/{id_connector}/sourcesGet list of connector sources
/connectors/{id_connector}/sourcesEdit several connector sources
/webhooks/{id_webhook}/add_to_dataretrieve the list of the value to add in webhooks when sending the requested webhook
/webhooks/{id_webhook}/add_to_dataSetup a field to store in user config when calling the endpoint
/webhooks/{id_webhook}/add_to_datadelete all entries
/connections/{id_connection}/sourcesGet connection sources
/providers/{id_connector}/logos/mainGet all links to the files associated with this connector.
/banks/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/mainGet all links to the files associated with this connector.
/providers/{id_connector}/connectionsGet a random subset of provider's id_connection
/users/{id_user}/transactionsclustersGet clustered transactions
/users/{id_user}/transactionsclustersCreate clustered transaction
/users/{id_user}/profiles/{id_profile}Get a profile
/webhooks/{id_webhook}/add_to_data/{key}retrieve the value to add in the requested webhook for the requested name
/webhooks/{id_webhook}/add_to_data/{key}upate the requested field to store in user config when calling the endpoint
/webhooks/{id_webhook}/add_to_data/{key}delete the requested entry
/banks/{id_connector}/sources/{id_source}Get the connector source
/providers/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/{id_logo}Create or Update a connector Logo.
/connectors/{id_connector}/logos/{id_logo}Delete a single Logo object.
/psd2-registrations/{id_psd2-registration}Get details for a given psd2 registration
/users/{id_user}/categories/full/{id_full}Modify a user-created category
/users/{id_user}/categories/full/{id_full}Delete a user-created transaction category
/users/{id_user}/connections/{id_connection}Force synchronisation of a connection.
/users/{id_user}/connections/{id_connection}Update a connection.
/users/{id_user}/connections/{id_connection}Delete a connection.
/providers/{id_connector}/sources/{id_source}Get the connector source
/connectors/{id_connector}/sources/{id_source}Get the connector source
/connectors/{id_connector}/sources/{id_source}Edit the provided connector source
/psd2-registrations/{id_psd2registration}/logsGet psd2 registration logs.
/connections/{id_connection}/sources/{id_source}Update connection source
/connections/{id_connection}/sources/{id_source}"
/connections/{id_connection}/sources/{id_source}Disable a connection source
/users/{id_user}/account_types/{id_account_type}Get an account type
/users/{id_user}/accounts/{id_account}/categoriesGet the category
/users/{id_user}/connections/{id_connection}/logsGet connection logs
/users/{id_user}/connections/{id_connection}/sourcesGet connection sources
/users/{id_user}/connections/{id_connection}/accountsGet accounts list.
/users/{id_user}/connections/{id_connection}/accountsUpdate many accounts at once
/users/{id_user}/connections/{id_connection}/accountsCreate an account
/users/{id_user}/connections/{id_connection}/accountsDelete all accounts
/users/{id_user}/connections/{id_connection}/informationsGet connection additionnal informations
/banks/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/accounts/{id_account}/transactionsclustersGet clustered transactions
/users/{id_user}/accounts/{id_account}/transactionsclustersCreate clustered transaction
/providers/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/connectors/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/connections/{id_connection}/sources/{id_source}Update connection source
/users/{id_user}/connections/{id_connection}/sources/{id_source}"
/users/{id_user}/connections/{id_connection}/sources/{id_source}Disable a connection source
/users/{id_user}/connections/{id_connection}/transactionsclustersGet clustered transactions
/users/{id_user}/connections/{id_connection}/transactionsclustersCreate clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}Update an account
/users/{id_user}/connections/{id_connection}/accounts/{id_account}Delete an account.
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/logsGet accounts logs.
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/deltaGet deltas of accounts
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/sourcesGet account sources
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/categoriesGet the category
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsGet transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsCreate transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsDelete transactions
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclustersGet clustered transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclustersCreate clustered transaction
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}Edit a transaction meta-data
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsList all arbitrary key-value pairs on a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsAdd or edit transaction arbitrary key-value pairs
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsDelete all arbitrary key-value pairs of a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}Get a particular arbitrary key-value pair on a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}Delete a particular key-value pair on a transaction.
# Budgea Development Guides Welcome to **Budgea**'s documentation. This documentation is intended to get you up-and-running with our APIs and advise on the implementation of some regulatory aspects of your application, following the DSP2's guidelines. ## Getting Started **IMPORTANT** Depending on your status with regard of the DSP2 regulation, **agent** or **partner**, you may call our APIs or simply use our Webview and callbacks to get the financial data of your users. As an **agent**, you are allowed to call directly our APIs and implement your own form to get the user's credentials. As a **partner**, you cannot manipulate the credentials, and have to delegate this step to us through our webview. The sections below will document how to use our APIs, make sure you have the **agent** status to do so. For the **partner**, please refer to the section *Webview* and *Callbacks* of this documentation. ### Overview Your API is a REST API which requires a communication through https to s
//budgea.biapi.pro/2.0167 endpoints available
/logsGet connection logs
/banksGet list of connectors
/usersGet users
/configGet configuration of the API.
/configInsert/update configuration key(s)/value(s) on the API.
/clientsList clients
/clientsCreate a client
/webauthFirst step to establish an oAuth2 connection.
/auth/jwtGenerate a user jwt token
/webhooksGet webhooks
/webhooksAdds a new webhook
/webhooksDeletes all webhooks
/admin/jwtGenerate a jwt manage token
/auth/initCreate a new anonymous user
/incidentsGet incidents logs.
/invoicingGet invoicing data for a given period (default is the current month).
/providersGet list of connectors
/publickeyGet public encryption key of the API.
/test/syncTest synchronization on a random connection.
/auth/renewGet a new access token given an user id and client credentials
/auth/tokenLogin to API with credentials
/auth/tokenRemove user access
/categoriesGet all categories
/categorizecategorize transactions without storing them
/connectorsGet list of connectors
/connectorsEnable/disable several connectors
/connectorsRequest a new connector
/monitoringget performances stats on this instance
/config/logsGet configuration change history of the API.
/connectionsGet connections without a user
/account_typesGet account types
/test/webhooksTest synchronization on a random connection.
/webhooks/authGet webhooks authentication types
/webhooks/authAdds a new webhook authentication type
/webhooks/authDeletes all webhook authentication types
/auth/token/codeGenerate a user temporary token
/banks/{id_bank}Get a connector
/users/{id_user}Get a user
/users/{id_user}Delete the user
/banks/categoriesCreate bank categories
/auth/token/accessTransform a temporary code to a access_token
/certificate/{type}Get the latest certificate of a type
/psd2-registrationsGet details on all psd2 registrations
/categories/keywordsAdd a new keyword associated with a category in the database.
/clients/{id_client}Get information about a client
/clients/{id_client}Update a client
/clients/{id_client}Delete a client
/users/{id_user}/logsGet connection logs
/users/{id_user}/tokenCreate a token
/webhooks/{id_webhook}Updates a webhook
/webhooks/{id_webhook}Updates a webhook
/webhooks/{id_webhook}Deletes a webhook
/users/{id_user}/alertsGet alerts
/users/{id_user}/configGet configuration of a user.
/users/{id_user}/configChange configuration of a user. modifications on keys prefixed by 'biapi.' (except callback_url) are ignored
/users/{id_user}/configDelete the given user configurations. deletions on keys prefixed by 'biapi.' (except callback_url) are ignored
/providers/{id_provider}Get a connector
/webhooks/auth/{id_auth}Updates the webhook authentication type
/webhooks/auth/{id_auth}Updates the webhook authentication type
/webhooks/auth/{id_auth}Deletes the webhook authentication type
/clients/{id_client}/logoUpdate the client logo
/clients/{id_client}/logoDelete the client logo
/users/{id_user}/forecastGet forecast
/users/{id_user}/profilesGet profiles
/connectors/{id_connector}Get a connector
/connectors/{id_connector}Edit the provided connector
/banks/{id_connector}/logosGet all links to the files associated with this connector.
/users/{id_user}/categoriesGet the category
/webhooks/{id_webhook}/logsGet webhooks logs.
/users/{id_user}/connectionsGet connections
/users/{id_user}/connectionsAdd a new connection.
/users/{id_user}/connectionsDelete all connections
/banks/{id_connector}/sourcesGet list of connector sources
/users/{id_user}/account_typesGet account types
/users/{id_user}/profiles/mainGet the main profile
/banks/categories/{id_category}Edit a bank categories
/banks/categories/{id_category}Delete the supplied category
/providers/{id_connector}/logosGet all links to the files associated with this connector.
/account_types/{id_account_type}Get an account type
/banks/{id_connector}/logos/mainGet all links to the files associated with this connector.
/connectors/{id_connector}/logosGet all links to the files associated with this connector.
/connectors/{id_connector}/logosCreate or Update a connector Logo
/connectors/{id_connector}/logosCreate a connector Logo
/users/{id_user}/categories/fullGet the category
/users/{id_user}/categories/fullCreate a new transaction category
/banks/{id_connector}/connectionsGet a subset of id_connection for a given bank. Different selection methode are possible
/categories/keywords/{id_keyword}Delete a particular key-value pair on a transaction.
/connections/{id_connection}/logsGet connection logs
/providers/{id_connector}/sourcesGet list of connector sources
/connectors/{id_connector}/sourcesGet list of connector sources
/connectors/{id_connector}/sourcesEdit several connector sources
/webhooks/{id_webhook}/add_to_dataretrieve the list of the value to add in webhooks when sending the requested webhook
/webhooks/{id_webhook}/add_to_dataSetup a field to store in user config when calling the endpoint
/webhooks/{id_webhook}/add_to_datadelete all entries
/connections/{id_connection}/sourcesGet connection sources
/providers/{id_connector}/logos/mainGet all links to the files associated with this connector.
/banks/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/mainGet all links to the files associated with this connector.
/providers/{id_connector}/connectionsGet a random subset of provider's id_connection
/users/{id_user}/transactionsclustersGet clustered transactions
/users/{id_user}/transactionsclustersCreate clustered transaction
/users/{id_user}/profiles/{id_profile}Get a profile
/webhooks/{id_webhook}/add_to_data/{key}retrieve the value to add in the requested webhook for the requested name
/webhooks/{id_webhook}/add_to_data/{key}upate the requested field to store in user config when calling the endpoint
/webhooks/{id_webhook}/add_to_data/{key}delete the requested entry
/banks/{id_connector}/sources/{id_source}Get the connector source
/providers/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/thumbnailGet all links to the files associated with this connector.
/connectors/{id_connector}/logos/{id_logo}Create or Update a connector Logo.
/connectors/{id_connector}/logos/{id_logo}Delete a single Logo object.
/psd2-registrations/{id_psd2-registration}Get details for a given psd2 registration
/users/{id_user}/categories/full/{id_full}Modify a user-created category
/users/{id_user}/categories/full/{id_full}Delete a user-created transaction category
/users/{id_user}/connections/{id_connection}Force synchronisation of a connection.
/users/{id_user}/connections/{id_connection}Update a connection.
/users/{id_user}/connections/{id_connection}Delete a connection.
/providers/{id_connector}/sources/{id_source}Get the connector source
/connectors/{id_connector}/sources/{id_source}Get the connector source
/connectors/{id_connector}/sources/{id_source}Edit the provided connector source
/psd2-registrations/{id_psd2registration}/logsGet psd2 registration logs.
/connections/{id_connection}/sources/{id_source}Update connection source
/connections/{id_connection}/sources/{id_source}"
/connections/{id_connection}/sources/{id_source}Disable a connection source
/users/{id_user}/account_types/{id_account_type}Get an account type
/users/{id_user}/accounts/{id_account}/categoriesGet the category
/users/{id_user}/connections/{id_connection}/logsGet connection logs
/users/{id_user}/connections/{id_connection}/sourcesGet connection sources
/users/{id_user}/connections/{id_connection}/accountsGet accounts list.
/users/{id_user}/connections/{id_connection}/accountsUpdate many accounts at once
/users/{id_user}/connections/{id_connection}/accountsCreate an account
/users/{id_user}/connections/{id_connection}/accountsDelete all accounts
/users/{id_user}/connections/{id_connection}/informationsGet connection additionnal informations
/banks/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/accounts/{id_account}/transactionsclustersGet clustered transactions
/users/{id_user}/accounts/{id_account}/transactionsclustersCreate clustered transaction
/providers/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/connectors/{id_connector}/sources/{id_connector_source}/fieldsGet fields specific to a domain and a source
/users/{id_user}/connections/{id_connection}/sources/{id_source}Update connection source
/users/{id_user}/connections/{id_connection}/sources/{id_source}"
/users/{id_user}/connections/{id_connection}/sources/{id_source}Disable a connection source
/users/{id_user}/connections/{id_connection}/transactionsclustersGet clustered transactions
/users/{id_user}/connections/{id_connection}/transactionsclustersCreate clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}Update an account
/users/{id_user}/connections/{id_connection}/accounts/{id_account}Delete an account.
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/logsGet accounts logs.
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/deltaGet deltas of accounts
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/sourcesGet account sources
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/categoriesGet the category
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsGet transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsCreate transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsDelete transactions
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclustersGet clustered transactions
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclustersCreate clustered transaction
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}Edit a transaction meta-data
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsList all arbitrary key-value pairs on a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsAdd or edit transaction arbitrary key-value pairs
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informationsDelete all arbitrary key-value pairs of a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Edit a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}Delete a clustered transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}Get a particular arbitrary key-value pair on a transaction
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}Delete a particular key-value pair on a transaction.