Budgea API Documentation
The Budgea API is a RESTful interface for a financial data aggregation platform, enabling management of users, authentication, bank/connectors, connections, accounts, transactions, categories, keywords, and related metadata, as well as supporting webhook configuration, logging, monitoring, and invoicing functionalities.
Admin: update documentationPOST
/auth/init
Create a new anonymous user
GET
/connectors/{id_connector}/sources
Get list of connector sources
id_connector ( path , required ) expand ( query ) GET
/providers/{id_connector}/logos
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/providers/{id_connector}/logos/main
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/providers/{id_connector}/logos/thumbnail
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/providers/{id_connector}/sources
Get list of connector sources
id_connector ( path , required ) expand ( query ) PUT
/webhooks/auth/{id_auth}
Updates the webhook authentication type
id_auth ( path , required ) expand ( query ) DELETE
/categories/keywords/{id_keyword}
Delete a particular key-value pair on a transaction.
id_keyword ( path , required ) expand ( query ) POST
/categorize
categorize transactions without storing them
GET
/certificate/{type}
Get the latest certificate of a type
type ( path , required ) expand ( query ) DELETE
/clients/{id_client}
Delete a client
id_client ( path , required ) expand ( query ) GET
/clients/{id_client}
Get information about a client
id_client ( path , required ) expand ( query ) PUT
/clients/{id_client}
Update a client
id_client ( path , required ) expand ( query ) DELETE
/clients/{id_client}/logo
Delete the client logo
id_client ( path , required ) expand ( query ) POST
/clients/{id_client}/logo
Update the client logo
id_client ( path , required ) expand ( query ) GET
/config
Get configuration of the API.
search ( query ) — limit the results to keys matching the given valuePOST
/config
Insert/update configuration key(s)/value(s) on the API.
GET
/connectors/{id_connector}/logos
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) POST
/connectors/{id_connector}/logos
Create a connector Logo
id_connector ( path , required ) expand ( query ) PUT
/connectors/{id_connector}/logos
Create or Update a connector Logo
id_connector ( path , required ) expand ( query ) GET
/connectors/{id_connector}/logos/main
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/connectors/{id_connector}/logos/thumbnail
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/providers/{id_connector}/sources/{id_connector_source}/fields
Get fields specific to a domain and a source
id_connector ( path , required ) id_connector_source ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/categories
Get the category
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) DELETE
/connectors/{id_connector}/logos/{id_logo}
Delete a single Logo object.
id_connector ( path , required ) id_logo ( path , required ) expand ( query ) PUT
/connectors/{id_connector}/logos/{id_logo}
Create or Update a connector Logo.
id_connector ( path , required ) id_logo ( path , required ) expand ( query ) GET
/account_types
Get account types
GET
/account_types/{id_account_type}
Get an account type
id_account_type ( path , required ) expand ( query ) POST
/admin/jwt
Generate a jwt manage token
POST
/auth/jwt
Generate a user jwt token
POST
/auth/renew
Get a new access token given an user id and client credentials
DELETE
/auth/token
Remove user access
POST
/auth/token
Login to API with credentials
POST
/auth/token/access
Transform a temporary code to a access_token
GET
/auth/token/code
Generate a user temporary token
GET
/banks
Get list of connectors
POST
/banks/categories
Create bank categories
DELETE
/banks/categories/{id_category}
Delete the supplied category
id_category ( path , required ) expand ( query ) POST
/banks/categories/{id_category}
Edit a bank categories
id_category ( path , required ) expand ( query ) GET
/banks/{id_bank}
Get a connector
id_bank ( path , required ) expand ( query ) GET
/banks/{id_connector}/connections
Get a subset of id_connection for a given bank. Different selection methode are possible
id_connector ( path , required ) method ( query ) — methode of selection use between 'diversity' (default), 'cover' and 'type_select'n ( query ) — the number of requested connections, if applicable by the methodtype ( query ) — for 'type_select' method. Specific account type id (weboob_type_id) to selectoccurences ( query ) — for 'type_select' method. Each connection requires at least Nsource ( query ) — specify a source name that should have a null stateminutes_without_sync ( query ) — Ensure the connection will not have a sync happening for atexpand ( query ) GET
/banks/{id_connector}/logos
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/banks/{id_connector}/logos/main
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/banks/{id_connector}/logos/thumbnail
Get all links to the files associated with this connector.
id_connector ( path , required ) expand ( query ) GET
/banks/{id_connector}/sources
Get list of connector sources
id_connector ( path , required ) expand ( query ) GET
/banks/{id_connector}/sources/{id_connector_source}/fields
Get fields specific to a domain and a source
id_connector ( path , required ) id_connector_source ( path , required ) expand ( query ) GET
/banks/{id_connector}/sources/{id_source}
Get the connector source
id_connector ( path , required ) id_source ( path , required ) expand ( query ) GET
/categories
Get all categories
POST
/categories/keywords
Add a new keyword associated with a category in the database.
GET
/config/logs
Get configuration change history of the API.
search ( query ) — limit the results to keys matching the given valuetype ( query ) — type of change done on the configurationmin_date ( query ) — minimal date of the changemax_date ( query ) — maximum date of the changeexpand ( query ) GET
/connections
Get connections without a user
GET
/connections/{id_connection}/logs
Get connection logs
id_connection ( path , required ) limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal datemax_date ( query ) — maximum dateperiod ( query ) — period to group logsid_user ( query ) — ID of a userid_connection ( query ) — ID of a connectionid_connector ( query ) — ID of a connectorconnector_uuid ( query ) — UUID of a connectorerror ( query ) — connections log error filterid_source ( query ) — ID of a sourceid_max ( query ) — filter "id" of logs, maximum id to returnexpand ( query ) GET
/connections/{id_connection}/sources
Get connection sources
id_connection ( path , required ) expand ( query ) DELETE
/connections/{id_connection}/sources/{id_source}
Disable a connection source
id_connection ( path , required ) id_source ( path , required ) expand ( query ) POST
/connections/{id_connection}/sources/{id_source}
"
id_connection ( path , required ) id_source ( path , required ) background ( query ) — do the synchronization in background (to use with the sysynchronizenc parameter)expand ( query ) PUT
/connections/{id_connection}/sources/{id_source}
Update connection source
id_connection ( path , required ) id_source ( path , required ) background ( query ) — do the synchronization in background (to use with the synchronize parameter)expand ( query ) GET
/connectors
Get list of connectors
POST
/connectors
Request a new connector
PUT
/connectors
Enable/disable several connectors
GET
/connectors/{id_connector}
Get a connector
id_connector ( path , required ) expand ( query ) PUT
/connectors/{id_connector}
Edit the provided connector
id_connector ( path , required ) expand ( query ) PUT
/connectors/{id_connector}/sources
Edit several connector sources
id_connector ( path , required ) expand ( query ) GET
/connectors/{id_connector}/sources/{id_connector_source}/fields
Get fields specific to a domain and a source
id_connector ( path , required ) id_connector_source ( path , required ) expand ( query ) GET
/connectors/{id_connector}/sources/{id_source}
Get the connector source
id_connector ( path , required ) id_source ( path , required ) expand ( query ) PUT
/connectors/{id_connector}/sources/{id_source}
Edit the provided connector source
id_connector ( path , required ) id_source ( path , required ) expand ( query ) GET
/incidents
Get incidents logs.
state ( query ) — comma separated list, filter incidents in the given states.id ( query ) — give only the current state of the particular incidents.weboob_id ( query ) — comma_separated list, filter the incidents of the given weboob_idstart_date ( query ) — filter last_update date >= start_date. YYYY-MM-DD format.end_date ( query ) — filter last_update date <= start_date. YYYY-MM-DD format.page ( query , page ) — pagination option. Default to 1.size ( query , limit ) — pagination option. Default to 30.GET
/invoicing
Get invoicing data for a given period (default is the current month).
min_date ( query ) — minimal datemax_date ( query ) — maximum dateusers_synced ( query ) — the number of user synchronized during the periodusers_bank ( query ) — the number of user of the Bank API synchronized during the periodusers_bill ( query ) — the number of user of the Bill API synchronized during the periodaccounts_synced ( query ) — the number of accounts synchronized during the periodsubscriptions_synced ( query ) — the number of subscriptions synchronized during the periodconnections_synced ( query ) — the number of connections synchronized during the periodconnections_account ( query ) — the number of Bank API connections synchronized during the periodtransfers_synced ( query ) — the number of transfers done during the periodpayments_synced ( query ) — the number of payments done during the periodall ( query ) — get all the invoicing data at oncedetail ( query ) — get full ids list instead of numbersGET
/logs
Get connection logs
limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal datemax_date ( query ) — maximum dateperiod ( query ) — period to group logsid_user ( query ) — ID of a userid_connection ( query ) — ID of a connectionid_connector ( query ) — ID of a connectorconnector_uuid ( query ) — UUID of a connectorerror ( query ) — connections log error filterid_source ( query ) — ID of a sourceid_max ( query ) — filter "id" of logs, maximum id to returnexpand ( query ) GET
/monitoring
get performances stats on this instance
period ( query ) — number on days on which stats on synchronization have to be done per worker (Default: 1)GET
/providers
Get list of connectors
GET
/providers/{id_connector}/connections
Get a random subset of provider's id_connection
id_connector ( path , required ) range ( query ) — the length of the connection subsetexpand ( query ) GET
/providers/{id_connector}/sources/{id_source}
Get the connector source
id_connector ( path , required ) id_source ( path , required ) expand ( query ) GET
/providers/{id_provider}
Get a connector
id_provider ( path , required ) expand ( query ) GET
/psd2-registrations
Get details on all psd2 registrations
GET
/psd2-registrations/{id_psd2-registration}
Get details for a given psd2 registration
id_psd2-registration ( path , required ) expand ( query ) GET
/psd2-registrations/{id_psd2registration}/logs
Get psd2 registration logs.
id_psd2registration ( path , required ) limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal (inclusive) datemax_date ( query ) — maximum (inclusive) dateexpand ( query ) GET
/publickey
Get public encryption key of the API.
POST
/test/sync
Test synchronization on a random connection.
POST
/test/webhooks
Test synchronization on a random connection.
GET
/users
Get users
search ( query ) — searches a user by mail (if it contains no '@', '@biapi.pro' will be added at the end)expand ( query ) DELETE
/users/{id_user}
Delete the user
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}
Get a user
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/account_types
Get account types
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/account_types/{id_account_type}
Get an account type
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account_type ( path , required ) expand ( query ) GET
/users/{id_user}/accounts/{id_account}/categories
Get the category
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account ( path , required ) GET
/users/{id_user}/accounts/{id_account}/transactionsclusters
Get clustered transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account ( path , required ) expand ( query ) POST
/users/{id_user}/accounts/{id_account}/transactionsclusters
Create clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account ( path , required ) expand ( query ) DELETE
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}
Delete a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account ( path , required ) id_transactionscluster ( path , required ) expand ( query ) PUT
/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}
Edit a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_account ( path , required ) id_transactionscluster ( path , required ) expand ( query ) GET
/users/{id_user}/alerts
Get alerts
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/categories
Get the category
id_user ( path , required ) — Hint: you can use 'me' or 'all'GET
/users/{id_user}/categories/full
Get the category
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) POST
/users/{id_user}/categories/full
Create a new transaction category
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) DELETE
/users/{id_user}/categories/full/{id_full}
Delete a user-created transaction category
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_full ( path , required ) expand ( query ) PUT
/users/{id_user}/categories/full/{id_full}
Modify a user-created category
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_full ( path , required ) expand ( query ) DELETE
/users/{id_user}/config
Delete the given user configurations. deletions on keys prefixed by 'biapi.' (except callback_url) are ignored
id_user ( path , required ) — Hint: you can use 'me' or 'all'GET
/users/{id_user}/config
Get configuration of a user.
id_user ( path , required ) — Hint: you can use 'me' or 'all'POST
/users/{id_user}/config
Change configuration of a user. modifications on keys prefixed by 'biapi.' (except callback_url) are ignored
id_user ( path , required ) — Hint: you can use 'me' or 'all'DELETE
/users/{id_user}/connections
Delete all connections
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/connections
Get connections
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) POST
/users/{id_user}/connections
Add a new connection.
id_user ( path , required ) — Hint: you can use 'me' or 'all'source ( query ) — optional comma-separated list of sources to use for the connection synchronizationexpand ( query ) DELETE
/users/{id_user}/connections/{id_connection}
Delete a connection.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/delta
Get deltas of accounts
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) min_date ( query ) — minimal datemax_date ( query ) — maximum dateperiod ( query ) — period to group logsPOST
/users/{id_user}/connections/{id_connection}
Update a connection.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) background ( query ) — Do the connection update/synchronization in backgroundpsu_requested ( query ) — Whether the connection synchronization is asked by the PSU or not (default is true)refresh_psd2_auth ( query ) — Refresh the PSU's SCA for openapi sourceexpand ( query ) PUT
/users/{id_user}/connections/{id_connection}
Force synchronisation of a connection.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) last_update ( query ) — if supplied, get transactions inserted since this datebackground ( query ) — do the connection synchronization in backgroundpsu_requested ( query ) — Whether the connection synchronization is asked by the PSU or not (default is true)expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts
Delete all accounts
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts
Get accounts list.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) POST
/users/{id_user}/connections/{id_connection}/accounts
Create an account
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/accounts
Update many accounts at once
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts/{id_account}
Delete an account.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/accounts/{id_account}
Update an account
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/logs
Get accounts logs.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal (inclusive) datemax_date ( query ) — maximum (inclusive) dateexpand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/sources
Get account sources
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions
Delete transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions
Get transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal (inclusive) datemax_date ( query ) — maximum (inclusive) dateincome ( query ) — filter on income or expendituresdeleted ( query ) — display only deleted transactionsall ( query ) — display all transactions, including deleted oneslast_update ( query ) — get only transactions updated after the specified datetimewording ( query ) — filter transactions containing the given stringmin_value ( query ) — minimal (inclusive) valuemax_value ( query ) — maximum (inclusive) valuesearch ( query ) — search in labels, dates, values and categoriesvalue ( query ) — "XX|-XX" or "±XX"id_category ( query ) — filter on given category id(s) (comma separated) or "null"expand ( query ) POST
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions
Create transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}
Edit a transaction meta-data
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations
Delete all arbitrary key-value pairs of a transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) expand ( query ) GET
/users/{id_user}/forecast
Get forecast
id_user ( path , required ) — Hint: you can use 'me' or 'all'GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations
List all arbitrary key-value pairs on a transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations
Add or edit transaction arbitrary key-value pairs
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}
Delete a particular key-value pair on a transaction.
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) id_information ( path , required ) expand ( query ) GET
/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
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transaction ( path , required ) id_information ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters
Get clustered transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) POST
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters
Create clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}
Delete a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transactionscluster ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}
Edit a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_account ( path , required ) id_transactionscluster ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/informations
Get connection additionnal informations
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) DELETE
/webhooks/auth/{id_auth}
Deletes the webhook authentication type
id_auth ( path , required ) expand ( query ) POST
/webhooks/auth/{id_auth}
Updates the webhook authentication type
id_auth ( path , required ) expand ( query ) GET
/users/{id_user}/connections/{id_connection}/logs
Get connection logs
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal datemax_date ( query ) — maximum dateperiod ( query ) — period to group logsid_user ( query ) — ID of a userid_connection ( query ) — ID of a connectionid_connector ( query ) — ID of a connectorconnector_uuid ( query ) — UUID of a connectorerror ( query ) — connections log error filterid_source ( query ) — ID of a sourceid_max ( query ) — filter "id" of logs, maximum id to returnexpand ( query ) GET
/users/{id_user}/connections/{id_connection}/sources
Get connection sources
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/sources/{id_source}
Disable a connection source
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_source ( path , required ) expand ( query ) POST
/users/{id_user}/connections/{id_connection}/sources/{id_source}
"
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_source ( path , required ) background ( query ) — do the synchronization in background (to use with the sysynchronizenc parameter)expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/sources/{id_source}
Update connection source
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_source ( path , required ) background ( query ) — do the synchronization in background (to use with the synchronize parameter)expand ( query ) GET
/users/{id_user}/connections/{id_connection}/transactionsclusters
Get clustered transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) POST
/users/{id_user}/connections/{id_connection}/transactionsclusters
Create clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) expand ( query ) DELETE
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}
Delete a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_transactionscluster ( path , required ) expand ( query ) PUT
/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}
Edit a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_connection ( path , required ) id_transactionscluster ( path , required ) expand ( query ) GET
/users/{id_user}/logs
Get connection logs
id_user ( path , required ) — Hint: you can use 'me' or 'all'limit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal datemax_date ( query ) — maximum dateperiod ( query ) — period to group logsid_user ( query ) — ID of a userid_connection ( query ) — ID of a connectionid_connector ( query ) — ID of a connectorconnector_uuid ( query ) — UUID of a connectorerror ( query ) — connections log error filterid_source ( query ) — ID of a sourceid_max ( query ) — filter "id" of logs, maximum id to returnexpand ( query ) GET
/users/{id_user}/profiles
Get profiles
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/profiles/main
Get the main profile
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) GET
/users/{id_user}/profiles/{id_profile}
Get a profile
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_profile ( path , required ) expand ( query ) POST
/users/{id_user}/token
Create a token
id_user ( path , required ) — Hint: you can use 'me' or 'all'GET
/users/{id_user}/transactionsclusters
Get clustered transactions
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) POST
/users/{id_user}/transactionsclusters
Create clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'expand ( query ) DELETE
/users/{id_user}/transactionsclusters/{id_transactionscluster}
Delete a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_transactionscluster ( path , required ) expand ( query ) PUT
/users/{id_user}/transactionsclusters/{id_transactionscluster}
Edit a clustered transaction
id_user ( path , required ) — Hint: you can use 'me' or 'all'id_transactionscluster ( path , required ) expand ( query ) GET
/webauth
First step to establish an oAuth2 connection.
DELETE
/webhooks
Deletes all webhooks
POST
/webhooks
Adds a new webhook
DELETE
/webhooks/auth
Deletes all webhook authentication types
GET
/webhooks/auth
Get webhooks authentication types
POST
/webhooks/auth
Adds a new webhook authentication type
DELETE
/webhooks/{id_webhook}
Deletes a webhook
id_webhook ( path , required ) expand ( query ) POST
/webhooks/{id_webhook}
Updates a webhook
id_webhook ( path , required ) expand ( query ) PUT
/webhooks/{id_webhook}
Updates a webhook
id_webhook ( path , required ) expand ( query ) DELETE
/webhooks/{id_webhook}/add_to_data
delete all entries
id_webhook ( path , required ) expand ( query ) GET
/webhooks/{id_webhook}/add_to_data
retrieve the list of the value to add in webhooks when sending the requested webhook
id_webhook ( path , required ) expand ( query ) POST
/webhooks/{id_webhook}/add_to_data
Setup a field to store in user config when calling the endpoint
id_webhook ( path , required ) expand ( query ) DELETE
/webhooks/{id_webhook}/add_to_data/{key}
delete the requested entry
id_webhook ( path , required ) key ( path , required ) expand ( query ) GET
/webhooks/{id_webhook}/add_to_data/{key}
retrieve the value to add in the requested webhook for the requested name
id_webhook ( path , required ) key ( path , required ) expand ( query ) POST
/webhooks/{id_webhook}/add_to_data/{key}
upate the requested field to store in user config when calling the endpoint
id_webhook ( path , required ) key ( path , required ) expand ( query ) GET
/webhooks/{id_webhook}/logs
Get webhooks logs.
id_webhook ( path , required ) id_user ( query ) — limit number of results to this userlimit ( query , limit ) — limit number of resultsoffset ( query , offset ) — offset of first resultmin_date ( query ) — minimal (inclusive) datemax_date ( query ) — maximum (inclusive) dateexpand ( query )
167 endpoints auto-detected
curl -X POST \
"https://budgea.biapi.pro/2.0/auth/init" budgea.biapi.pro · HTTPS only