{"openapi":"3.0.0","servers":[{"url":"//budgea.biapi.pro/2.0"}],"info":{"description":"# Budgea Development Guides\n\nWelcome to **Budgea**'s documentation.\n\nThis 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.\n\n## Getting Started\n**IMPORTANT**\nDepending 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.\nAs an **agent**, you are allowed to call directly our APIs and implement your own form to get the user's credentials.\nAs a **partner**, you cannot manipulate the credentials, and have to delegate this step to us through our webview.\n\nThe sections below will document how to use our APIs, make sure you have the **agent** status to do so.\nFor the **partner**, please refer to the section *Webview* and *Callbacks* of this documentation.\n\n### Overview\nYour API is a REST API which requires a communication through https to send and receive JSON documents.\nDuring your tests, we recommend to make calls to the API with curl or any other HTTP client of your choice.\nYou can watch a video demonstration on this [URL](https://asciinema.org/a/FsaFyt3WAPyDm7sfaZPkwal3V).\nFor the examples we'll use the demo API with address `https://demo.biapi.pro`, you should change that name to your API's name.\n\n### Hello World\nLet's start by calling the service `/banks` which lists all available banks.\n```\ncurl https://demo.biapi.pro/2.0/banks/\n```\nTo log in to a bank webpage, you'll need to know for a given bank, the fields your user should fill in the form.\nLet's call a specific bank and ask for an additional resource *fields*.\n```\ncurl https://demo.biapi.pro/2.0/banks/59?expand=fields\n```\nThe response here concerns only 1 bank (since we specified an id) and the resource _Fields_ is added to the response thanks to the query parameter `expand`.\n\nTo get more interesting things done, you'll need to send authenticated requests.\n\n### Authentication\nThe way to authenticate is by passing the `Authorization: Bearer ` header in your request.\nAt the setup a _manage token_ have been generated, you can use this token for now, when creating your user we'll see how to generate a user's token.\n```\ncurl https://demo.biapi.pro/2.0/config \\\n -H 'Authorization: Bearer '\n```\nThis endpoint will list all the parameters you can change to adapt Budgea to your needs.\n\nWe've covered the very first calls. Before diving deeper, let's see some general information about the APIs.\n\n## Abstract\n\n### API URL\n`https://demo.biapi.pro/2.0`\n\n### Requests format\nData format: **application/x-www-form-urlencoded** or **application/json** (suggested)\n\nAdditional headers: Authorization: User's token (private)\n\n### Responses format\nData format: **application/json** ([http://www.json.org](http://www.json.org/))\nCharset: **UTF-8**\n\n### Resources\nEach call on an endpoint will return resources. The main resources are:\n| Resource | Description |\n| ---------------------|:------------------------------------------------------------------------------------------------------------------ |\n|Users |Represent a user |\n|Connection |A set of data used to authenticate on a website (usually a login and password). There is 1 connection for each website|\n|Account |A bank account contained in a connection |\n|Transaction |An entry in a bank account |\n|Investment |An asset in a bank account |\n\nThe chain of resources is as follow: **Users ∈ Connections ∈ Accounts ∈ Transactions or Investments**\n\n### RESTful API\n\nThis API is RESTful, which means it is stateless and each resource is accessed with an unique URI.\n\nSeveral HTTP methods are available:\n\n| Method | Description |\n| ------------------------|:-------------------------------|\n| GET /resources | List resources |\n| GET /resources/{ID} | Get a resource from its ID |\n| POST /resources | Create a new resource |\n| POST /resources/{ID} | Update a resource |\n| PUT /resources /{ID} | Update a resource |\n| DELETE /resources | Remove every resources |\n| DELETE /resources/{ID} | Delete a resource |\n\n\nEach resource can contain sub-resources, for example:\n`/users/me/connections/2/accounts/23/transactions/48`\n\n### HTTP response codes\n\n| Code | Message | Description |\n| ----------- |:---------------------:|-----------------------------------------------------------------------------------------------|\n| 200 | OK |Default response when a GET or POST request has succeed |\n| 202 | Accepted |For a new connection this code means it is necessary to provide complementary information (2FA)|\n| 204 | No content |Default response when a POST request succeed without content |\n| 400 | Bad request |Supplied parameters are incorrect |\n| 403 | Forbidden |Invalid token |\n| 500 | Internal Servor Error |Server error |\n| 503 | Service Unavailable |Service is temporarily unavailable |\n\n### Errors management\nIn case an error occurs (code 4xx or 5xx), the response can contain a JSON object describing this error:\n```json\n{\n \"code\": \"authFailure\",\n \"message\": \"Wrong password\" // Optional\n}\n```\nIf an error is displayed on the website, Its content is returned in error_message field.\nThe list of all possible errors is listed further down this page.\n\n### Authentication\nA user is authenticated by an access_token which is sent by the API during a call on one of the authentication services, and can be supplied with this header:\n`Authorization: Bearer YYYYYYYYYYYYYYYYYYYYYYYYYYY`\n\n There are two user levels:\n\n - Normal user, which can only access to his own accounts\n - Administrator, with extended rights\n\n### Default filters\nDuring a call to an URI which lists resources, some filters can be passed as query parameters:\n\n| Parameter | Type | Description |\n| ----------- |:---------:|-----------------------------------------------------------|\n| offset | Integer |Offset of the first returned resource |\n| limit | Integer |Limit number of results |\n| min_date | Date |Minimal date (if supported by service), format: YYYY-MM-DD |\n| max_date | Date |Maximal date (if supported by service), format: YYYY-MM-DD |\n\n### Extend requests\nDuring a GET on a set of resources or on a unique resource, it is possible to add a parameter expand to the request to extend relations with other resources:\n\n`GET /2.0/users/me/accounts/123?expand=transactions[category],connection`\n\n```json\n{\n \"id\" : 123\n \"name\" : \"Compte chèque\"\n \"balance\" : 1561.15\n \"transactions\" : [\n {\n \"id\" : 9849,\n \"simplified_wording\" : \"HALL'S BEER\",\n \"value\" : -513.20,\n ...\n \"category\" : {\n \"id\" : 561,\n \"name\" : \"Sorties / Bar\",\n ...\n }\n },\n ...\n ],\n \"id_user\" : 1,\n \"connection\" : {\n \"id\" : 1518,\n \"id_bank\" : 41,\n \"id_user\" : 1,\n \"error\" : null,\n ...\n }\n}\n```\n\n### Request example\n```http\nGET /2.0/banks?offset=0&limit=10&expand=fields\nHost: demo.biapi.pro\nAccept: application/json\nAuthorization: Bearer \n```\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\nContent-Length: 3026\nServer: Apache\nDate: Fri, 14 Mar 2014 08:24:02 GMT\n\n{\n \"banks\" : [\n {\n \"id_weboob\" : \"bnp\",\n \"name\" : \"BNP Paribas\",\n \"id\" : 3,\n \"hidden\" : false,\n \"fields\" : [\n {\n \"id\" : 1,\n \"id_bank\" : 3,\n \"regex\" : \"^[0-9]{5,10}$\",\n \"name\" : \"login\",\n \"type\" : \"text\",\n \"label\" : \"Numéro client\"\n },\n {\n \"id\" : 2,\n \"id_bank\" : 3,\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"password\",\n \"type\" : \"password\",\n \"label\" : \"Code secret\"\n }\n ]\n },\n ...\n ]\n \"total\" : 41\n}\n```\n\n### Constants\n#### List of bank account types\n| Type |Description |\n| ----------- |-----------------------------------|\n| checking |Checking account |\n| savings |Savings account |\n| deposit |Deposit accounts |\n| loan |Loan |\n| market | Market accounts |\n| joint |Joint account |\n| card |Card |\n| lifeinsurance |Life insurance accounts |\n| pee |Plan Épargne Entreprise |\n| perco |Plan Épargne Retraite |\n| article83 |Article 83 |\n| rsp |Réserve spéciale de participation |\n| pea |Plan d'épargne en actions |\n| capitalisation|Contrat de capitalisation |\n| perp |Plan d'épargne retraite populaire |\n| madelin |Contrat retraite Madelin |\n| unknown |Inconnu |\n\n#### List of transaction types\n\n| Type |Description |\n| ----------- |-----------------------------------|\n|transfer |Transfers |\n|order |Orders |\n|check |Checks |\n|deposit |Cash deposit |\n|payback |Payback |\n|withdrawal |Withdrawal |\n|loan_payment |Loan payment |\n|bank |Bank fees |\n|card |Card operation |\n|deferred_card |Deferred card operation |\n|card_summary |Mensual debit of a deferred card |\n\n#### List of synchronization errors\n##### Error on Connection object\nThe error field may take one of the below values in case of error when accessing the user space.\n\n| Error |Description |\n| ----------------------- |--------------------------------------------------------------------------------------------------|\n|wrongpass |The authentication on website has failed |\n|additionalInformationNeeded |Additional information is needed such as an OTP |\n|websiteUnavailable |The website is unavailable, for instance we get a HTTP 503 response when requesting the website |\n|actionNeeded |An action is needed on the website by the user, scraping is blocked |\n|SCARequired |An SCA process must be done by updating the connection |\n|decoupled |Requires a user validation (ex: digital key)|\n|passwordExpired |The password has expired and needs to be changed on the website. |\n|webauthRequired |A complete authentication process is required by update the connection via redirect |\n|bug |A bug has occurred during the synchronization. An alert has been sent to Budget Insight |\n\n#### Error on Account object\nErrors can be filled at the account level in case we access the user's dashboard but some account related data cannot be retrieved.\nFor instance, we may not access the transactions or investments for a specific account.\nGetting an error during an account synchronization does not impact the scraping of other acccounts.\n\n| Error |Description |\n| ----------------------- |--------------------------------------------------------------------------------------------------|\n|websiteUnavailable |The website or a page is unavailable |\n|actionNeeded |An action is needed on the website by the user, scraping is blocked |\n|bug |A bug has occurred during the synchronization. An alert has been sent to Budget Insight |\n\nNow you know the basics of Budgea API\n- Basic call to retrieve resources\n- Add query parameters to aplly filters\n- Expand resources\n- Authenticated calls\n\nWe're good for the basics! Now let's see how to integrate Budgea in your app and create your first user.\n\n## Integrate Budgea *(protocol or Webview)*\n### The workflow\nUsers of your application exist in the Budgea API.\nEvery User is identified by an access_token which is the shared secret between your application and our API.\n\nThe workflow is as below:\n1. The user is on your application and wants to share his bank accounts or invoices.\n2. A call is made **client side** (browser's javascript or desktop application) to create a temporarily token which will be used to make API calls.\n3. A form is built, allowing the user to select the connector to use (bank or provider, depending on context). Every connector requires different kind of credentials.\n4. A call on the API is made with the temporarily token to add a **Connection** with the credentials supplied by user.\n5. In case of success, the user chooses what bank accounts (**Account**) or subscriptions (**Subscription**) he wants to share with your application.\n6. When he validates the share, the temporarily token is transmitted to your server. This one will call the Budgea API with this token to get a permanent token.\n\n**Note**\nIn case your application works without a server (for example a desktop application), the permanent token can be obtained on the 1st step, by supplying a client_secret to /auth/init and the step 6 is omitted. To get more information, read the protocol.\n\nThere are 3 steps to integrate Budgea in your application:\n1. Provide a way for your users to share their credentials with you\n2. Get the data scraped from Budgea\n3. Be sure to follow the good practices before going into production\n\n### Get credentials from users\nYou have 2 options here:\n- Integrate the Budget Insight's Webview, a turnkey solution to get user's credentials\n- Create your own form following the protocol (must have the *agent* status)\n\n### Budgea webview\n\nThe Budgea webview complements REST API endpoints with web-based services to handle sensitive or complex operations:\n- add a connection (to a bank or a provider), or edit/repare access to a connection;\n- manage connections (add/remove/edit);\n- edit and validate bank transfers (alpha preview).\n\nUsage of the webview is mandatory if you don't hold an Agent status, since you are not allowed to use API endpoints carrying user credentials, and optional otherwise.\n\n#### Implementation guidelines\n\n##### Base URL\n\nThe base URL of all services must be customized: \n`https://{{domain}}.biapi.pro/2.0/auth/webview/` \n`https://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/` \n- `{{domain}}`: substitute with you API domain;\n- `{{lang}}`: optionally specify the language of the webview, `en` or `fr` (if not specified, an automatic redirection will be performed following the language of the browser).\n\n##### Browser integration\n\nServices available as part of the webview are designed as parameterized URLs intended to be opened in a web browser. A callback URI must be specified by callers to be notified at the end of the operation flow, similar to OAuth 2 specification.\n\nYou are encouraged to integrate web-based steps in your product following UX best practices:\n- in a web environment, perform a full-page redirect to the URL (using either [HTTP redirect](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/302) or [scripting](https://developer.mozilla.org/fr/docs/Web/API/Location)), and avoid new tabs or popups;\n- in a native Android app, prefer opening the default browser or relying on [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) to integrating a WebView;\n- in a native iOS app, prefer using a [SFSafariViewController](https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller) to integrating a WKWebView.\n\n##### Callback handling\n\nMost flows redirect to a callback URI at the end of the process. Query parameters are added to the URI to identify successful or failed operations.\n\nSuccessful parameters are specific to each flow. In case of an error, the following parameters are added:\n\n| Parameter | Description |\n| - | - |\n| `error` | An lowercase string error code identifying the kind of error that occurred. When the parameter is not present, the response is successful. |\n| `error_description` | A longer string description of the error (not intended for user display). |\n\nCommon error codes include:\n\n| Code | Description |\n| - | - |\n| `access_denied` | The user explicitly cancelled the flow. |\n| `server_error` | Oops, a technical failure occurred during the process. |\n\n**Forward compatibility requirement**: Additional error codes may be added in the future to describe specific cases. When implementing error codes handling, always fallback to a generic case for unknown codes.\n\n##### Browser compatibility\n\nThe webview is designed and tested to work with browsers supported by the Angular framework: \nhttps://angular.io/guide/browser-support\n\n##### Privacy / GDPR status\n\nThe webview itself does not use any kind of long-term data persistence mechanism such as cookies or local storage, but some authentication or authorization steps may delegate to third-party web services that may implement them.\n\n#### Configuration\n\nYou can configure the appearance and behaviour of the webview by configuring the associated *Client Application* in the console:\n\n| Key | Format | Description |\n| - | - | - |\n| `primary_color` | String | Optional. An accent color (hexadecimal string without '#' prefix) to personalize the UI elements of the webview. If absent, the default color is grey. |\n| `redirect_uri` | String | Optional. A recommended security whitelist configuration. The `redirect_uri` parameter sent to any endpoint of the webview is checked against the configuration, if any. |\n| `config.disable_connector_hints` | Boolean | Optional. This flags hides the list of most-used entries in the connector selection step. The default is `false`, i.e. the list is shown. |\n| `config.use_app_layout` | Boolean | Optional. Use this flag to enable presenting your log as an app icon. The default value is ` false`, i.e. the logo is shown in the top bar of the UI. |\n| `config.disable_accounts_pre_check` | Boolean | Optional. An optional boolean flag to prevent bank accounts to be automatically pre-checked when the user enters the activation step. The default value is ` false`, i.e. the bank accounts are pre-checked. |\n\n#### Endpoints reference\n\n##### Add connection flow\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/connect\n```\n\nThis flow allows an end-user to add a new connection to the API. The flow handles the following steps:\n- selecting a connector;\n- authenticating & authorizing with the connector, by collecting credentials or delegating;\n- managing consent to aggregate accounts/subscriptions;\n- collecting required information for professional accounts.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Optional. A user-scoped temporary code to use with the Budgea API.
If you don't provide a code, a new anonymous user will be created before the connection is added, and you will be returned an access token code scoped to it with the success callback. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `connector_ids` | Optional. A comma-separated list of connector IDs available to pick from.
If the parameter is omitted, all active connectors are available.
If you pass a single value, the user is not prompted to choose the connector.
This parameter is mutually exclusive with `connector_uuids`. |\n| `connector_uuids` | Optional. A comma-separated list of connector UUIDs available to pick from.
If the parameter is omitted, all active connectors are available.
If you pass a single value, the user is not prompted to choose the connector.
This parameter is mutually exclusive with `connector_ids`. |\n| `connector_capabilities` | Optional. A comma-separated list of capabilities to filter available connectors.
If the parameter is omitted, `bank` is inferred.
If multiple values are provided, only connectors that expose all the requested capabilities are available.
To request a bank connection, use `bank`.
To request a provider connection, use `document`. |\n| `account_ibans` | Optional. A comma-separated list of IBANs to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n| `account_types` | Optional. A comma-separated list of account types to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n| `account_usages` | Optional. A comma-separated list of account usages to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n\n###### Successful callback parameters\n\n| Parameter | Description |\n| - | - |\n| `connection_id` | The id of the newly created connection. Please note that when redirecting to the callback URI, the accounts and/or subscriptions are available in the API, but bank transactions or documents may still be syncing in background. |\n| `code` | Optional. If a `code` was *not* initially specified, an API code that you must exchange to obtain a permanent access token associated with the newly-created anonymous user holding the connection. The parameter is URL-encoded, make sure to handle it accordingly. |\n| `state` | Optional. Identical to the `state` parameter that was initially specified. |\n\n###### Additional error codes\n\n| Code | Description |\n| - | - |\n| `tos_declined` | The end-user refused to validate the terms of service. |\n\n##### Re-auth / edit connection credentials flow\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/reconnect\n```\n\nThis flow allows an end-user to re-authenticate against a bank or a provider in order to recover an existing connection, or to completely reset credentials associated with a connection.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API. |\n| `connection_id` | Required. The id of the existing connection. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `reset_credentials` | Optional. In the default mode (`false`), the service will try to recover the connection and prompt the user only with outdated or transient information (new password, OTP...).
Set the parameter to `true` to force resetting all the credentials associated with the connection. This parameter may not apply to all connectors. |\n\n###### Successful callback parameters\n\nThis flow adds no parameter to the callback URI in case of success, except from `state`.\n\n##### Manage connections\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/manage\n```\nThis flow allows an end-user to manage the connections associated with his account in the API. The user can add new connections, remove existing ones, fix connection errors, reset credentials or activate/deactivate bank accounts.\n\nSupport of `redirect_uri` in this flow is optional, as it can be integrated or presented as a terminal step, without relying on a final redirection.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API. |\n| `redirect_uri` | Optional. An absolute callback URI. When provided, the webview will display a close button that redirects to it. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow when providing a `redirect_uri`. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `connector_capabilities` | Optional. A comma-separated list of capabilities to filter available connectors when adding a new connection.
If the parameter is omitted, `bank` is inferred.
If multiple values are provided, only connectors that expose all the requested capabilities are available.
To request a bank connection, use `bank`.
To request a provider connection, use `document`. |\n| `account_types` | Optional. A comma-separated list of account types to filter accounts available for activation on adding a new bank connection or updating existing connections. Other accounts will not be selectable. |\n| `account_usages` | Optional. A comma-separated list of account usages to filter accounts available for activation in a bank connection context. Other accounts will not be selectable. |\n\n###### Callback parameters\n\nThis flow adds no parameter to the callback URI, except from `state`.\n\n##### Execute a bank transfer (preview)\n\n**Disclaimer**: Transfer or payment services are available as a preview, protocols and parameters are subject to change in upcoming beta/final releases.\n\n```\nhttps://{{domain}}.biapi.pro/2.0/auth/webview/{{lang}}/transfer\n```\nThis flow allows an end-user to execute a bank transfer. The flow handles the following steps:\n- if the transfer is not already created, all steps to authenticate with a bank, select the recipient, the emitter account, the amount and label;\n- executing the transfer, including managing SCAs for recipient registration and/or transfer validation.\n\n###### Endpoint parameters\n\n| Parameter | Description |\n| - | - |\n| `client_id` | Required. The ID of the requesting client application. You can manage client applications of your domain in the admin console. |\n| `redirect_uri` | Required. An absolute callback URI. The webview will redirect to it at the end of the flow. |\n| `code` | Required. A user-scoped temporary code to use with the Budgea API.
If you don't provide a code, a new anonymous user will be created before a connection is added and the transfer is executed, and you will be returned an access token code scoped to it with the success callback. |\n| `state` | Optional. An opaque string parameter that you can use to carry state across the flow. The parameter will be set \"as is\" on the callback URI. Make sure that the `state` you provide is properly URL-encoded. |\n| `transfer_id`| Optional. The ID of an prepared transfer to be validated in the webview. The user cannot edit anything on the transfer before validation. |\n\n###### Successfull callback parameters\n\n| Parameter | Description |\n| - | - |\n| `transfer_id` | The ID of the transfer that was created and executed. |\n| `code` | Optional. If a `code` was *not* initially specified, an API code that you can exchange to obtain a permanent access token associated with the newly-created anonymous user holding the transfer. The parameter is URL-encoded, make sure to handle it accordingly. |\n| `state` | Optional. Identical to the `state` parameter that was initially specified. |\n\n###### Additional error codes\n\n| Code | Description |\n| - | - |\n| `tos_declined` | The end-user refused to validate the terms of service. |\n\n#### Migrating from v3\n\nWe provide a full backward compatibility layer with current implementations of the webview v3 to ease the transition. All endpoints remains accessible, with the same parameters and callback behaviour. Migration instructions are provided below.\n\n*The v3 compatibility mode is expected to be removed on 31 December 2019.* You should migrate your implementation a soon as possible to new endpoints and parameters.\n\n##### Add connection flow / Edit connection credentials \n```\n/connect/select\n```\n\nThis endpoint has been superseded by `/connect` (no suffix) for adding a new connection, and `/reconnect` for resetting or updating an existing connection.\n\n| Endpoint parameter | Migration instructions |\n| - | - |\n| `client_id` | No change. |\n| `redirect_uri`, `state` | No change. |\n| `response_type` | This parameter is not used anymore. |\n| `id_connector`, `connectors` | Superseded by `connector_ids` sent to the `/connect` endpoint. |\n| `types` | Superseded by `connector_capabilities` sent to the `/connect` endpoint.
Use`connector_capabilities=bank` (bank connection) or `connector_capabilities=document` (provider connection). |\n| `id_connection` | Superseded by `connection_id` sent to the `/reconnect` endpoint. |\n\nPassing the code or access token as an URL fragment is no longer supported, use the `code` query parameter.\n\n| Callback parameter | Migration instructions |\n| - | - |\n| `id_connection` | Superseded by `connection_id`.
In the `/reconnect` flow, this parameter is not returned anymore. |\n| `code` | Still named `code`, but in the `/connect` flow the parameter is now **only** added if an anonymous user was created, i.e. the `code` parameter was **not** provided as a query parameter or fragment.
In the `/reconnect` flow, this parameter is not returned anymore. |\n| `state` | No change. |\n\n##### Manage connections\n\n```\n/accounts\n```\n\nThis endpoint has been superseded by `/manage`, that now fully allows users to add/remove connections, reset their credentials or recover from error states.\n\n| Endpoint parameter | Migration instructions |\n| - | - |\n| `client_id` | No change. |\n| `redirect_uri`, `state` | No change, these parameters are now optional. |\n| `response_type` | This parameter is not used anymore. |\n| `types` | Superseded by `connector_capabilities`.
Use`connector_capabilities=bank` (bank connection) or `connector_capabilities=document` (provider connection). |\n\nPassing the code or access token as an URL fragment is no longer supported, use the `code` query parameter.\n\n| Callback parameter | Migration instructions |\n| - | - |\n| `code` | This parameter is not returned anymore. |\n| `state` | No change. |\n\n##### Behaviour change\n\nIn v3, the `/accounts` flow used to redirect to the `redirect_uri` after a connection addition. This is no longer the case in v4, where redirection is only performed when the user explicitly closes the flow. If you need to perform actions when a connection is added or removed, you should rely on webhooks.\n\n#### Protocol\nThis section describes the protocol used to set bank and provider accounts of a user, in case you don't want to use the webview.\n\nThe idea is to call the following services client-side (with AJAX in case of a web application), to ensure the bank and providers credentials will not be sent to your servers.\n\n1. /auth/init\n```http\nPOST /auth/init\n```\n```json\n{\n \"auth_token\" : \"fBqjMZbYddebUGlkR445JKPA6pCoRaGb\",\n \"type\" : \"temporary\",\n \"expires_in\" : 1800,\n \"id_user\": 1\n}\n```\nThis service creates a temporarily token, to use in the \"Authorization\" header in next calls to the API\n\nThe returned token has a life-time of 30 minutes, and should be transfered to the API then (cf Permanent Token), so that your server can get a permanent access_token.\n\nIt is possible to generate a permanent token immediately, by calling the service with the manage_token, or by supply parameters client_id and client_secret.\n\n2. /banks or /providers\n```http\nGET /banks?expand=fields\nAuthorization: Bearer \n```\n```json\n{\n \"hidden\" : false,\n \"charged\" : true,\n \"name\" : \"American Express\",\n \"id\" : 30,\n \"fields\" : [\n {\n \"values\" : [\n {\n \"label\" : \"Particuliers/Professionnels\",\n \"value\" : \"pp\"\n },\n {\n \"value\" : \"ent\",\n \"label\" : \"Entreprises\"\n }\n ],\n \"label\" : \"Type de compte\",\n \"regex\" : null,\n \"name\" : \"website\",\n \"type\" : \"list\"\n },\n {\n \"type\" : \"password\",\n \"label\" : \"Code secret\",\n \"name\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\"\n }\n ],\n },\n ...\n ],\n \"total\" : 44,\n}\n```\nYou get a list of connectors, and all associated fields needed to build the form at step 3.\nYou can also use that list to show to your user, all available banks.\n\n3. /users/me/connections\nMake a POST request and supply the id_bank (ID of the chosen bank) or id_provider (ID of provider), and all requested fields as key/value parameters.\nFor example:\n```http\nPOST /users/me/connections\nAuthorization: Bearer \n-F login=12345678\n-F password=123456\n-F id_bank=59\n```\nYou can get the following return codes:\n\n|Code |Description |\n|---------------|------------------------------------------------------------ |\n|200 |The connection has succeed and has been created |\n|202 |It is necessary to provide complementary information. This occurs on the first connection on some kind of Boursorama accounts for example, where a SMS is sent to the customer. It is necessary to ask the user to fill fields requested in the fields, and do a POST again on /users/me/connections/ID, with the connection ID in id_connection. |\n|400 |Unable to connect to the website, the field error in the JSON can be **websiteUnavailable** or **wrongpass** |\n|403 |Invalid token |\n\n4. Activate accounts\nThe accounts the user wants to aggregate must be activated before any transaction or investment is retrieved.\nSeveral accounts can be activated in 1 request by separating the account ids with commas.\n```http\nPUT /users/me/connections//accounts/?all\n```\n\n5. Permanent token\nIf the user validates the share of his accounts, it is necessary to transform the temporary code to a permanent access_token (so that the user won't expire).\n\nTo do that, make a POST request on /auth/token/access with the following parameters:\n|Parameter |Description |\n|---------------------|----------------------------------------------------------------|\n|code |The temporarily token which will let you get the access_token |\n|client_id |The ID of your client application |\n|client_secret |The secret of your client application |\n\n```json\nPOST /auth/token/access\n\n{\n \"client_id\" : 17473055,\n \"client_secret\" : \"54tHJHjvodbANVzaRtcLzlHGXQiOgw80\",\n \"code\" : \"fBqjMZbYddebUGlkR445JKPA6pCoRaGb\"\n}\n```\n```http\nHTTP/1.1 200 OK\n\n{\n \"access_token\" : \"7wBPuFfb1Hod82f1+KNa0AmrkIuQ3h1G\",\n \"token_type\":\"Bearer\"\n}\n```\n\n### Update accounts\nAnother important call is when a user wants to add/remove connections to banks or providers, or to change the password on one of them, it is advised to give him a temporarily code from the permanent access_token, with the following call (using the access_token as bearer):\n```http\nPOST /auth/token/code\nAuthorization: Bearer \n```\n```json\n{\n \"code\" : \"/JiDppWgbmc+5ztHIUJtHl0ynYfw682Z\",\n \"type\" : \"temporary\",\n \"expires_in\" : 1800,\n}\n```\nIts life-time is 30 minutes, and let the browser to list connections and accounts, via `GET /users/me/connections?expand=accounts` for example.\n\n To update the password of a connection, you can do a POST on the *connection* resource, with the field *password* in the data. The new credentials are checked to make sure they are valid, and the return codes are the same as when adding a connection.\n\n## Getting the data (Webhooks)\nYou have created your users and their connections, now it's time to get the data.\nThere are 2 ways to retrieve it, the 2 can be complementary:\n- make regular calls to the API\n- use the webhooks (recommended)\n\n### Manual Synchronization\nIt is possible to do a manual synchronization of a user. We recommend to use this method in case the user wants fresh data after logging in.\n\nTo trigger the synchronization, call the API as below:\n`PUT /users/ID/connections`\nThe following call is blocking until the synchronization is terminated.\n\nEven if it is not recommended, it's possible to fetch synchronously new data. To do that, you can use the *expand* parameter:\n` /users/ID/connections?expand=accounts[transactions,investments[type]],subscriptions`\n```json\n{\n \"connections\" : [\n {\n \"accounts\" : [\n {\n \"balance\" : 7481.01,\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"deleted\" : null,\n \"display\" : true,\n \"formatted_balance\" : \"7 481,01 €\",\n \"iban\" : \"FR76131048379405300290000016\",\n \"id\" : 17,\n \"id_connection\" : 7,\n \"investments\" : [\n {\n \"code\" : \"FR0010330902\",\n \"description\" : \"\",\n \"diff\" : -67.86,\n \"id\" : 55,\n \"id_account\" : 19,\n \"id_type\" : 1,\n \"label\" : \"Agressor PEA\",\n \"portfolio_share\" : 0.48,\n \"prev_diff\" : 2019.57,\n \"quantity\" : 7.338,\n \"type\" : {\n \"color\" : \"AABBCC\",\n \"id\" : 1,\n \"name\" : \"Fonds action\"\n },\n \"unitprice\" : 488.98,\n \"unitvalue\" : 479.73,\n \"valuation\" : 3520.28\n }\n ],\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"name\" : \"Compte chèque\",\n \"number\" : \"3002900000\",\n \"transactions\" : [\n {\n \"active\" : true,\n \"application_date\" : \"2015-06-17\",\n \"coming\" : false,\n \"comment\" : null,\n \"commission\" : null,\n \"country\" : null,\n \"date\" : \"2015-06-18\",\n \"date_scraped\" : \"2015-07-04 15:17:30\",\n \"deleted\" : null,\n \"documents_count\" : 0,\n \"formatted_value\" : \"-16,22 €\",\n \"id\" : 309,\n \"id_account\" : 17,\n \"id_category\" : 9998,\n \"id_cluster\" : null,\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"new\" : true,\n \"original_currency\" : null,\n \"original_value\" : null,\n \"original_wording\" : \"FACTURE CB HALL'S BEER\",\n \"rdate\" : \"2015-06-17\",\n \"simplified_wording\" : \"HALL'S BEER\",\n \"state\" : \"parsed\",\n \"stemmed_wording\" : \"HALL'S BEER\",\n \"type\" : \"card\",\n \"value\" : -16.22,\n \"wording\" : \"HALL'S BEER\"\n }\n ],\n \"type\" : \"checking\"\n }\n ],\n \"error\" : null,\n \"expire\" : null,\n \"id\" : 7,\n \"id_user\" : 7,\n \"id_bank\" : 41,\n \"last_update\" : \"2015-07-04 15:17:31\"\n }\n ],\n \"total\" : 1,\n}\n```\n\n### Background synchronizations & Webhooks\nWebhooks are callbacks sent to your server, when an event is triggered during a synchronization.\nSynchronizations are automatic, the frequency can be set using the configuration key `autosync.frequency`.\nUsing webhooks allows you to get the most up-to-date data of your users, after each synchronization.\n\nThe automatic synchronization makes it possible to recover new bank entries, or new invoices, at a given frequency.\nYou have the possibility to add webhooks on several events, and choose to receive each one on a distinct URL.\nTo see the list of available webhooks you can call the endpoint hereunder:\n```\ncurl https://demo.biapi.pro/2.0/webhooks_events \\\n -H 'Authorization: Bearer '\n```\n\nThe background synchronizations for each user are independent, and their plannings are spread over the day so that they do not overload any website.\n\nOnce the synchronization of a user is over, a POST request is sent on the callback URL you have defined, including all webhook data.\nA typical json sent to your server is as below:\n```http\nPOST /callback HTTP/1.1\nHost: example.org\nContent-Length: 959\nAccept-Encoding: gzip, deflate, compress\nAccept: */*\nUser-Agent: Budgea API/2.0\nContent-Type: application/json; charset=utf-8\nAuthorization: Bearer sl/wuqgD2eOo+4Zf9FjvAz3YJgU+JKsJ\n\n{\n \"connections\" : [\n {\n \"accounts\" : [\n {\n \"balance\" : 7481.01,\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"deleted\" : null,\n \"display\" : true,\n \"formatted_balance\" : \"7 481,01 €\",\n \"iban\" : \"FR76131048379405300290000016\",\n \"id\" : 17,\n \"id_connection\" : 7,\n \"investments\" : [\n {\n \"code\" : \"FR0010330902\",\n \"description\" : \"\",\n \"diff\" : -67.86,\n \"id\" : 55,\n \"id_account\" : 19,\n \"id_type\" : 1,\n \"label\" : \"Agressor PEA\",\n \"portfolio_share\" : 0.48,\n \"prev_diff\" : 2019.57,\n \"quantity\" : 7.338,\n \"type\" : {\n \"color\" : \"AABBCC\",\n \"id\" : 1,\n \"name\" : \"Fonds action\"\n },\n \"unitprice\" : 488.98,\n \"unitvalue\" : 479.73,\n \"valuation\" : 3520.28\n }\n ],\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"name\" : \"Compte chèque\",\n \"number\" : \"3002900000\",\n \"transactions\" : [\n {\n \"active\" : true,\n \"application_date\" : \"2015-06-17\",\n \"coming\" : false,\n \"comment\" : null,\n \"commission\" : null,\n \"country\" : null,\n \"date\" : \"2015-06-18\",\n \"date_scraped\" : \"2015-07-04 15:17:30\",\n \"deleted\" : null,\n \"documents_count\" : 0,\n \"formatted_value\" : \"-16,22 €\",\n \"id\" : 309,\n \"id_account\" : 17,\n \"id_category\" : 9998,\n \"id_cluster\" : null,\n \"last_update\" : \"2015-07-04 15:17:30\",\n \"new\" : true,\n \"original_currency\" : null,\n \"original_value\" : null,\n \"original_wording\" : \"FACTURE CB HALL'S BEER\",\n \"rdate\" : \"2015-06-17\",\n \"simplified_wording\" : \"HALL'S BEER\",\n \"state\" : \"parsed\",\n \"stemmed_wording\" : \"HALL'S BEER\",\n \"type\" : \"card\",\n \"value\" : -16.22,\n \"wording\" : \"HALL'S BEER\"\n }\n ],\n \"type\" : \"checking\"\n }\n ],\n \"bank\" : {\n \"id_weboob\" : \"ing\",\n \"charged\" : true,\n \"name\" : \"ING Direct\",\n \"id\" : 7,\n \"hidden\" : false\n },\n \"error\" : null,\n \"expire\" : null,\n \"id\" : 7,\n \"id_user\" : 7,\n \"id_bank\" : 41,\n \"last_update\" : \"2015-07-04 15:17:31\"\n }\n ],\n \"total\" : 1,\n \"user\" : {\n \"signin\" : \"2015-07-04 15:17:29\",\n \"id\" : 7,\n \"platform\" : \"sharedAccess\"\n }\n}\n```\nThe authentication on the callback is made with the access_token of the user (which is a shared secret between your server and the Budgea API).\n\nWhen you are in production, it is needed to define a HTTPS URL using a valid certificate, delivered by a recognized authority. If this is not the case, you can contact us to add your CA (Certificate Authority) to our PKI (Public Key Infrastructure).\n\nImportant: it is necessary to send back a HTTP 200 code, without what we consider that data is not correctly taken into account on your system, and it will be sent again at the next user synchronization.\n\n## Guidelines for production\nNow you should have integrated the API inside your application. Make sure your Webhooks URLs are in HTTPS, if so you can enable the production state of the API.\n\nTo make things great, here are some good practices, please check you have respected them:\n- You have provided to your users a way to configure their accounts\n- You have provided to your users a way to change their account passwords\n- You consider the **error** field of Connections, to alert the user in case the state is **wrongpass**\n- You map IDs of Accounts, Subscriptions, Transactions and Documents in your application, to be sure to correctly match them\n- When the deleted field is set on a bank transaction, you delete it in your database\n- You don't loop on all users to launch synchronizations, this might saturate the service\n\nIf you have questions about above points, please contact us. Otherwise, you can put into production!\n\n### Going further\nIf you want to raise the bar for your app and add features such as the ability to do transfers, get invoices, aggregate patrimony and more, please refer to the sections below.\nWe'll discuss complementary APIs building upon the aggregation, allowing for the best of financial apps.\n\n## Budgea API Pay\nThis API allows for the emition of transfers between the aggregated accounts.\nJust like the simple aggregation, BI provides a webview or a protocol to follow, to implement this feature.\n\n### API pay protocol\nThis section describes how the transfer and recipient protocol work, in case you don't want to integrate the webview.\nThe idea is to do following calls client side (with AJAX in case of a web application), so that the interaction with the Budgea API is transparent.\n\n#### Executing a transfer\n1. /auth/token/code\nIf you do calls client side, get a new temporary code for the user, from the access_token. This will prevent security issues.\n```\ncurl -d '' \\\n https://demo.biapi.pro/2.0/auth/token/code \\\n -H 'Authorization: Bearer '\n```\n```json\n{\n \"code\": \"/JiDppWgbmc+5ztHIUJtHl0ynYfw682Z\",\n \"type\": \"temporary\",\n \"expires_in\": 1800\n}\n```\nThe returned token has a life-time of 30 minutes.\n\n2. /users/me/accounts?able_to_transfer=1\nList all the accounts that can do transfers. Authenticate the call with the code you got at step 1.\n```\ncurl https://demo.biapi.pro/2.0/users/me/accounts?able_to_transfer=1 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z'\n```\n```json\n{\n \"accounts\" : [\n {\n \"display\" : true,\n \"balance\" : 2893.36,\n \"id_type\" : 2,\n \"number\" : \"****1572\",\n \"type\" : \"checking\",\n \"deleted\" : null,\n \"bic\" : \"BNPAFRPPXXX\",\n \"bookmarked\" : false,\n \"coming\" : -2702.74,\n \"id_user\" : 1,\n \"original_name\" : \"Compte de chèques\",\n \"currency\" : {\n \"symbol\" : \"€\",\n \"id\" : \"EUR\",\n \"prefix\" : false\n },\n \"name\" : \"lol\",\n \"iban\" : \"FR7630004012550000041157244\",\n \"last_update\" : \"2016-12-28 12:31:04\",\n \"id\" : 723,\n \"formatted_balance\" : \"2893,36 €\",\n \"able_to_transfer\" : true,\n \"id_connection\" : 202\n }\n ],\n \"total\" : 1\n}\n```\n\n3. /users/me/accounts/ID/recipients\nList all available recipients for a given account.\n```\ncurl https://demo.biapi.pro/2.0/users/me/accounts/723/recipients?limit=1 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z'\n```\n```json\n{\n \"total\" : 27,\n \"recipients\" : [\n {\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Interne\",\n \"deleted\" : null,\n \"enabled_at\" : \"2016-10-31 18:52:53\",\n \"expire\" : null,\n \"iban\" : \"FR7630004012550003027641744\",\n \"id\" : 1,\n \"id_account\" : 1,\n \"id_target_account\" : 2,\n \"label\" : \"Livret A\",\n \"last_update\" : \"2016-12-05 12:07:24\",\n \"time_scraped\" : \"2016-10-31 18:52:54\",\n \"webid\" : \"2741588268268091098819849694548441184167285851255682796371\"\n }\n ]\n}\n```\n\n4. /users/me/accounts/ID/recipients/ID/transfers\nCreate the transfer\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients/1/transfers \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F amount=10, \\\n -F label=\"Test virement\", \\\n -F exec_date=\"2018-09-12\" // optional\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"amount\" : 10,\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"exec_date\" : \"2018-09-12\",\n \"fees\" : null\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2018-09-12 10:34:59\",\n \"state\" : \"created\",\n \"webid\" : null\n}\n```\n\n5. /users/me/transfers/ID\nExecute the transfer\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/transfers/22 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F validated=true\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"amount\" : 10,\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"exec_date\" : \"2016-12-19\",\n \"fees\" : null,\n \"fields\" : [\n {\n \"label\" : \"Code secret BNP Paribas\",\n \"type\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"password\"\n }\n ],\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2016-12-19 10:34:59\",\n \"state\" : \"created\",\n \"webid\" : null\n}\n```\nHere, an authentication step asks user to enter his bank password. The transfer can be validated with:\n\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/transfers/22 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F validated=true \\\n -F password=\"123456\"\n```\n```json\n{\n \"account_iban\" : \"FR7630004012550000041157244\",\n \"currency\" : {\n \"id\" : \"EUR\",\n \"prefix\" : false,\n \"symbol\" : \"€\"\n },\n \"amount\" : 10,\n \"exec_date\" : \"2016-12-19\",\n \"fees\" : 0,\n \"formatted_amount\" : \"10,00 €\",\n \"id\" : 22,\n \"id_account\" : 1,\n \"id_recipient\" : 1,\n \"label\" : \"Test virement\",\n \"recipient_iban\" : \"FR7630004012550003027641744\",\n \"register_date\" : \"2016-12-19 10:34:59\",\n \"state\" : \"pending\",\n \"webid\" : \"ZZ10C4FKSNP05TK95\"\n}\n```\nThe field state is changed to *pending*, telling that the transfer has been correctly executed on the bank. A connection synchronization is then launched, to find the bank transaction in the movements history. In this case, the transfer state will be changed to *done*.\n\n#### Adding a recipient\n1. /auth/token/code\nGet a temporary token for the user. Same procedure than step 1 for a transfer.\n\n2. /users/me/accounts?able_to_transfer=1\nList accounts allowing transfers. Same procedure than step 2 for a transfer.\n\n3. /users/me/accounts/ID/recipients/\nAdd a new recipient.\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F iban=FR7613048379405300290000355 \\\n -F label=\"Papa\", \\\n -F category=\"Famille\" // optional\n```\n```json\n{\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Famille\",\n \"deleted\" : null,\n \"enabled_at\" : null,\n \"expire\" : \"2017-04-29 16:56:20\",\n \"fields\" : [\n {\n \"label\" : \"Veuillez entrer le code reçu par SMS\",\n \"type\" : \"password\",\n \"regex\" : \"^[0-9]{6}$\",\n \"name\" : \"sms\"\n }\n ],\n \"iban\" : \"FR7613048379405300290000355\",\n \"id\" : 2,\n \"id_account\" : 1,\n \"id_target_account\" : null,\n \"label\" : \"Papa\",\n \"last_update\" : \"2017-04-29 16:26:20\",\n \"time_scraped\" : null,\n \"webid\" : null\n}\n```\nIt is necessary to post on the object Recipient with the requested fields (here sms), until the add is validated:\n```\ncurl \\\n https://demo.biapi.pro/2.0/users/me/accounts/1/recipients/2 \\\n -H 'Authorization: Bearer /JiDppWgbmc+5ztHIUJtHl0ynYfw682Z' \\\n -F sms=\"123456\"\n```\n```json\n{\n \"bank_name\" : \"BNP PARIBAS\",\n \"bic\" : \"BNPAFRPPXXX\",\n \"category\" : \"Famille\",\n \"deleted\" : null,\n \"enabled_at\" : \"2017-05-01 00:00:00\",\n \"expire\" : null,\n \"iban\" : \"FR7613048379405300290000355\",\n \"id\" : 2,\n \"id_account\" : 1,\n \"id_target_account\" : null,\n \"label\" : \"Papa\",\n \"last_update\" : \"2017-04-29 16:26:20\",\n \"time_scraped\" : null,\n \"webid\" : \"2741588268268091098819849694548441184167285851255682796371\"\n}\n```\nIf the field enabled_at is in the future, it means that it isn't possible yet to execute a transfer, as the bank requires to wait a validation period.\n\n### API Pay Webview\nThis section describes how to integrate the webview of the Budgea Pay API inside your application, to let your users do transfers to their recipients.\n\n#### User redirection\nTo redirect the user to the webview, it is necessary to build a URI authenticated with a temporary token.\nThis can be done from our library, or by calling the endpoint `/auth/token/code` (see the protocol section for an example).\nIf the parameter **redirect_uri** is supplied, the user will be redirected to that page once the transfer is done.\n\n#### List of pages\nHere are a list a pages you may call to redirect your user directly on a page of the process:\n|Path |Description of the page |\n|-------------------------------------|----------------------------------------------------------------------------------|\n|/transfers |List Transfers |\n|/transfers/accounts |List emitter accounts |\n|/transfers/accounts/id/recipients |List recipients |\n|/transfers/accounts/id/recipients/id |Initialization of a transfer between the account and the recipient |\n|/transfers/id |Detail of a given transfer |\n\n## Deprecated\n\nThis section lists all the deprecated features in Budgea API. The associated date is the date of its removal.\n**Do not use them**.\n\n### Key Investments (**2019-06-24**)\n\nAdding a temporary new key \"all_investments\" that will include deleted investments in the **webhooks**.\n\n### No automatic expand on User objects (**2019-07-30**)\nIn the API responses, by default, User objects won't display the keys \"config\", \"alert_settings\" and \"invites\" anymore.\nYou will still be able to access this data by expanding the request.\nExample: GET /users/me/?expand=alert_settings,config\n\n### Renaming of \"type\" field for jwt tokens (**2019-07-30**)\nFor user's tokens in the jwt format, the \"type\" field will be renamed from \"shared_access\" to \"sharedAccess\".\n","title":"Budgea API Documentation","version":"2.0","x-apisguru-categories":["financial"],"x-origin":[{"format":"swagger","url":"https://budgea.biapi.pro/2.0/doc/","version":"2.0"}],"x-providerName":"biapi.pro"},"tags":[{"name":"Administration"},{"name":"Authentication"},{"name":"Banks"},{"name":"Connections"},{"name":"Documents"},{"name":"OIDC"},{"name":"PFM"},{"name":"Payments"},{"name":"Providers"},{"name":"Recipients"},{"name":"Service"},{"name":"Terms"},{"name":"Timeline"},{"name":"Transfer"},{"name":"Transfers"},{"name":"Users management"},{"name":"Wealth"}],"paths":{"/account_types":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accounttypes":{"items":{"$ref":"#/components/schemas/AccountType"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["accounttypes"],"type":"object"}}},"description":"accounttypes"}},"summary":"Get account types","tags":["Banks"]}},"/account_types/{id_account_type}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_account_type","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountType"}}},"description":"Successful GET on AccountType resource"}},"summary":"Get an account type","tags":["Banks"]}},"/admin/jwt":{"post":{"description":"This endpoint generates a new jwt manage token. It requires an admin manage token to be used

","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"duration":{"description":"number of minute before the token expiration (0 for token that won't expire unless the client application is deleted) (default: 1)","type":"integer"},"scope":{"description":"scope requested for the token (default: config)","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"required":["jwt_token","payload"],"type":"object"}},"jwt_token":{"examples":{"response":{"value":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1Mzg1OTUwODYsInR5cGUiOiJtYW5hZ2VfdG9rZW4iLCJhdWQiOiJsb2NhbGhvc3Q6MzE1OCIsImV4cCI6MTUzODU5NTE0Niwic2NvcGUiOiJjb25maWcifQ.Z-ygtorGB3yitd2MNias9r3dPojPh4yxFKO5uVM0NhEty5UhnwkqSZA29JKZKmTc7mUSDc30THFIL-VkHBOu2gfxv3fjrZ9R35jo29H_TEYpxiOxxl0m5jLxDn4KEoWpDCiuwkoEdklVJCOMFGC_Sp3uZ89C82OZ_-7CDExnA99FPKbJpVVHaIQdlmOAATHG-KvRJKJu7j2wIUSpIZ3flIqav9dBtaHbjaI-K0WTSC-a13gdzHJKhHmReKWNL8cOMIziPrUx4zv57_DSLWSI2e2FJ_SKbiEAgHcfEmnwktPwTeAdJhgUq5UVH1EP71NkpTQQL4SzHi3tlKmsG3SCbg"}}},"payload":{"examples":{"response":{"value":{"aud":"localhost:3158","exp":1538595146,"iat":1538595086,"scope":"config","type":"manage_token"}}}}},"description":""}},"summary":"Generate a jwt manage token","tags":["Authentication"]}},"/auth/init":{"post":{"description":"This endpoint creates a new temporary token related to a new anonymous user.

It will expire 30 minutes after.

Note: if you supply client_id and client_secret, or if you call this endpoint with the manage_token, the token will be permanent.

","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"client_id":{"description":"ID of the client","type":"string"},"client_secret":{"description":"secret of the client","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"auth_token":{"description":"new token created for the new anonymous user","type":"string"},"expires_in":{"description":"duration in seconds of the token validity","type":"integer"},"type":{"description":"type of the token","type":"string"}},"required":["auth_token","type"],"type":"object"}},"auth_token":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}},"expires_in":{"examples":{"response":{"value":1800}}},"type":{"examples":{"response":{"value":"temporary"}}}},"description":""}},"summary":"Create a new anonymous user","tags":["Authentication"]}},"/auth/jwt":{"post":{"description":"This endpoint generates a new jwt token for the user. This token will last the time in minutes given by the config key auth.default_token_expire (permanent if this the parameter expire=False is given)

","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"client_id":{"description":"id of the client","type":"string"},"client_secret":{"description":"secret for the client","type":"string"},"expire":{"description":"if set to True, the token will expire n minutes after its creation, n being the value of configuration key auth.default_token_expire (default: True)","type":"boolean"},"id_user":{"description":"user for whom the token has to be generated. If not supplied, a user will be created","type":"integer"},"scope":{"description":"scope requested for the token","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"jwt_token":{"description":"the jwt token","type":"string"},"payload":{"description":"the payload contained in the jwt token","type":"object"}},"required":["jwt_token","payload"],"type":"object"}},"jwt_token":{"examples":{"response":{"value":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZF91c2VyIjozMywiYXVkIjoibG9jYWxob3N0OjMxNTgiLCJpc3MiOjE5ODM4OTgyLCJleHAiOjE1Mzg1OTY2OTcsInNjb3BlIjoiIiwiaWF0IjoxNTM4NTk0ODk3LCJ0eXBlIjoic2hhcmVkX2FjY2VzcyJ9.Tesc90tQ35Fk2SbRXw_Da1Ec-AwAzi104N-hrZWyBeXYkoao6512Ym8v_3207zm-bE1mRDjmQJQN0bbvImZlNGKA8JqoxbXF5l8eetXnv-U9yZXp9ScpUoNWxrRbtyyiwIGWDsRjCjOXcrVvzYd0oJ2RpUXR2NFyCCRjuMJFU87ojGj9eHo5e1B78vB1xZe3c3Yyx8bCvm0Qe2JjoSuhnXgMzAuLQm2KHha_9iHuQBC4zmmICOvNsQ5gBWAnf0W0IYHTZG1vioGNstX05nYiGSSlmzP6HgA5CmB2A57rBERFYB7V59wSQJzUyVOpCOuPCp7zPkRNfgFsZqqACg-DDg"}}},"payload":{"examples":{"response":{"value":{"aud":"localhost:3158","exp":1538596697,"iat":1538594897,"id_user":33,"iss":19838982,"scope":"","type":"sharedAccess"}}}}},"description":""}},"summary":"Generate a user jwt token","tags":["Authentication"]}},"/auth/renew":{"post":{"description":"","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"client_id":{"description":"ID of the client","type":"string"},"client_secret":{"description":"secret of the client","type":"string"},"grant_type":{"description":"default is \"client_credentials\"","type":"string"},"id_user":{"description":"id of the user to generate a token for","type":"integer"},"revoke_previous":{"description":"if true, all other permanent tokens for the user will be deleted","type":"boolean"}},"required":["client_id","client_secret","id_user"],"type":"object"}}}},"responses":{"200":{"content":{"access_token":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}},"application/json":{"schema":{"properties":{"access_token":{"description":"the access token transformed from the temporary one","type":"string"},"token_type":{"description":"the access token type","type":"string"}},"required":["access_token","token_type"],"type":"object"}},"token_type":{"examples":{"response":{"value":"Bearer"}}}},"description":""}},"summary":"Get a new access token given an user id and client credentials","tags":["Authentication"]}},"/auth/token":{"delete":{"description":"This endpoint removes the token in use.

","responses":{"200":{"description":"standard HTTP response"}},"summary":"Remove user access","tags":["Authentication","PFM"]},"post":{"description":"Request a new user token by giving an username and a password. Or a manage payment token by giving a client



","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"application":{"description":"application name","type":"string"},"grant_type":{"description":"password when requesting a user token and client_credentials for a payment manage token (default: password)","type":"string"},"password":{"description":"password","type":"string"},"scope":{"description":"scope requested for the token","type":"string"},"username":{"description":"username","type":"string"}},"required":["username","password","application"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"expires_in":{"description":"duration in seconds of the token validity","type":"integer"},"scope":{"description":"the token scope","type":"string"},"token":{"description":"the requested token","type":"string"}},"required":["token","scope"],"type":"object"}},"profile":{"examples":{"response":{"value":{}}}},"scope":{"examples":{"response":{"value":""}}},"token":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}},"user":{"examples":{"response":{"value":{}}}}},"description":""}},"summary":"Login to API with credentials","tags":["PFM"]}},"/auth/token/access":{"post":{"description":"In order to register a new user with the OAuth 2 process, the client has to call this endpoint to request a granted access_token with the received temporary code.

","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"client_id":{"description":"ID of the client","type":"string"},"client_secret":{"description":"secret of the client","type":"string"},"code":{"description":"user's temporary code","type":"string"},"grant_type":{"description":"default is \"authorization_code\"","type":"string"},"redirect_uri":{"description":"redirect uri used by user","type":"string"}},"required":["client_id","client_secret","code"],"type":"object"}}}},"responses":{"200":{"content":{"access_token":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}},"application/json":{"schema":{"properties":{"access_token":{"description":"the access token transformed from the temporary one","type":"string"},"token_type":{"description":"the access token type","type":"string"}},"required":["access_token","token_type"],"type":"object"}},"token_type":{"examples":{"response":{"value":"Bearer"}}}},"description":""}},"summary":"Transform a temporary code to a access_token","tags":["Authentication"]}},"/auth/token/code":{"get":{"description":"This endpoint generates a new temporary token for the user.

In case the access_token is used by a trusted device, and you want to let another one (for example a web browser) access to user resources, use this service to create a token which will expire in 30 minutes.

Additionally, you can also generate a temporary single-use token by specifying 'type=singleAccess' as query parameter. A single-use token can only be used once no matter the endpoint being accessed.

","responses":{"200":{"content":{"access":{"examples":{"response":{"value":"standard"}}},"application/json":{"schema":{"properties":{"access":{"description":"the reusability of a token (standard or single use)","type":"string"},"code":{"description":"the temporary token","type":"string"},"expires_in":{"description":"duration in seconds of the token validity","type":"integer"},"type":{"description":"the token type","type":"object"}},"required":["code","type","access","expires_in"],"type":"object"}},"code":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}},"expires_in":{"examples":{"response":{"value":1800}}},"type":{"examples":{"response":{"value":"temporary"}}}},"description":""}},"summary":"Generate a user temporary token","tags":["Authentication"]}},"/banks":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"banks":{"items":{"$ref":"#/components/schemas/Connector"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["banks"],"type":"object"}}},"description":"banks"}},"summary":"Get list of connectors","tags":["Connections","Banks","Providers"]}},"/banks/categories":{"post":{"description":"It requires the name of the category to be created

","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"name":{"description":"name of the category to be created","type":"string"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorCategory"}}},"description":"Successful POST on ConnectorCategory resource"}},"summary":"Create bank categories","tags":["Banks"]}},"/banks/categories/{id_category}":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_category","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorCategory"}}},"description":"Successful DELETE on ConnectorCategory resource"}},"summary":"Delete the supplied category","tags":["Banks"]},"post":{"description":"Edit the name for the supplied category.

","parameters":[{"description":"","in":"path","name":"id_category","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"name":{"description":"new name for the supplied category","type":"string"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorCategory"}}},"description":"Successful POST on ConnectorCategory resource"}},"summary":"Edit a bank categories","tags":["Banks"]}},"/banks/{id_bank}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_bank","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"description":"Successful GET on Connector resource"}},"summary":"Get a connector","tags":["Connections","Banks","Providers"]}},"/banks/{id_connector}/connections":{"get":{"description":"By default, it selects a set of 3 connections with the 'diversity' method

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"methode of selection use between 'diversity' (default), 'cover' and 'type_select'","in":"query","name":"method","required":false,"schema":{"type":"string"}},{"description":"the number of requested connections, if applicable by the method","in":"query","name":"n","required":false,"schema":{"type":"integer"}},{"description":"for 'type_select' method. Specific account type id (weboob_type_id) to select","in":"query","name":"type","required":false,"schema":{"type":"integer"}},{"description":"for 'type_select' method. Each connection requires at least N","in":"query","name":"occurences","required":false,"schema":{"type":"integer"}},{"description":"specify a source name that should have a null state","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"description":"Ensure the connection will not have a sync happening for at","in":"query","name":"minutes_without_sync","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connections"],"type":"object"}}},"description":"connections"}},"summary":"Get a subset of id_connection for a given bank. Different selection methode are possible","tags":["Banks","Connections"]}},"/banks/{id_connector}/logos":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/banks/{id_connector}/logos/main":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/banks/{id_connector}/logos/thumbnail":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/banks/{id_connector}/sources":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectorSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get list of connector sources","tags":["Connections","Banks","Providers"]}},"/banks/{id_connector}/sources/{id_connector_source}/fields":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_connector_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"source_fields":{"items":{"$ref":"#/components/schemas/ConnectorSourceField"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["source_fields"],"type":"object"}}},"description":"source_fields"}},"summary":"Get fields specific to a domain and a source","tags":["Connections","Banks"]}},"/banks/{id_connector}/sources/{id_source}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSource"}}},"description":"Successful GET on ConnectorSource resource"}},"summary":"Get the connector source","tags":["Connections","Banks","Providers"]}},"/categories":{"get":{"description":"Ressource to get all existing categories

","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["categories"],"type":"object"}}},"description":"categories"}},"summary":"Get all categories","tags":["Banks"]}},"/categories/keywords":{"post":{"description":"If the keyword already exists the keyword is not added. Used for the categorization of transactions.

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

","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keyword"}}},"description":"Successful POST on Keyword resource"}},"summary":"Add a new keyword associated with a category in the database.","tags":["Banks"]}},"/categories/keywords/{id_keyword}":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_keyword","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Keyword"}}},"description":"Successful DELETE on Keyword resource"}},"summary":"Delete a particular key-value pair on a transaction.","tags":["Banks"]}},"/categorize":{"post":{"description":"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)

","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"type":{"description":"type of the transaction (default: unknown)","type":"string"},"value":{"description":"value of the transaction","type":"integer"},"wording":{"description":"label of the transaction","type":"string"}},"required":["wording","value","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"required":["failed","total","transactions"],"type":"object"}},"failed":{"examples":{"response":{"value":1}}},"total":{"examples":{"response":{"value":2}}},"transactions":{"examples":{"response":{"value":[{"id_category":84,"state":"categorized_by_keyword","type":"card","value":-14,"wording":"the great restaurant "},{"id_category":9998,"state":"fail_categorizing","type":"card","value":-14,"wording":"toto"}]}}}},"description":""}},"summary":"categorize transactions without storing them","tags":["Banks"]}},"/certificate/{type}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"type","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}},"description":"Successful GET on Certificate resource"}},"summary":"Get the latest certificate of a type","tags":["Authentication"]}},"/clients":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"clients":{"items":{"$ref":"#/components/schemas/Client"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["clients"],"type":"object"}}},"description":"clients"}},"summary":"List clients","tags":["Administration"]},"post":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"config":{"description":"custom config about the client","type":"string"},"generate_keys":{"description":"if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False)","type":"boolean"},"name":{"description":"name of client","type":"string"},"redirect_uris":{"description":"list of allowed redirect uris","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Successful POST on Client resource"}},"summary":"Create a client","tags":["Administration"]}},"/clients/{id_client}":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_client","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Successful DELETE on Client resource"}},"summary":"Delete a client","tags":["Administration"]},"get":{"description":"If you use the manage_token or a configuration token, you will get also the client secret.

","parameters":[{"description":"","in":"path","name":"id_client","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Successful GET on Client resource"}},"summary":"Get information about a client","tags":["Administration"]},"put":{"description":"","parameters":[{"description":"","in":"path","name":"id_client","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"config":{"description":"custom config about the client","type":"string"},"description":{"description":"text to display as a default description","type":"string"},"description_banks":{"description":"text to display as a description for banks","type":"string"},"description_providers":{"description":"text to display as a description for providers","type":"string"},"generate_keys":{"description":"set a rsa key pair for the client, which make it possible to generate a jwt user token using this client. No effect if the client already has a set of keys(default: False)","type":"boolean"},"name":{"description":"name of client","type":"string"},"primary_color":{"description":"hexadecimal code of the client primary color (e.g F45B9A)","type":"string"},"pro":{"description":"Wether the client should display the company manager page","type":"boolean"},"redirect_uris":{"description":"list of allowed redirect uris","type":"string"},"secondary_color":{"description":"hexadecimal code of the client secondary color (e.g F45B9A)","type":"string"},"secret":{"description":"reset the secret","type":"boolean"},"update_config":{"description":"update the custom information about the client instead of replacing the existing one (default: True)","type":"boolean"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}},"description":"Successful PUT on Client resource"}},"summary":"Update a client","tags":["Administration"]}},"/clients/{id_client}/logo":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_client","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"Successful DELETE on File resource"}},"summary":"Delete the client logo","tags":["Administration"]},"post":{"description":"","parameters":[{"description":"","in":"path","name":"id_client","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}},"description":"Successful POST on File resource"}},"summary":"Update the client logo","tags":["Administration"]}},"/config":{"get":{"description":"

","parameters":[{"description":"limit the results to keys matching the given value","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get configuration of the API.","tags":["Administration"]},"post":{"description":"","responses":{"200":{"description":"standard HTTP response"}},"summary":"Insert/update configuration key(s)/value(s) on the API.","tags":["Administration"]}},"/config/logs":{"get":{"description":"

","parameters":[{"description":"limit the results to keys matching the given value","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"type of change done on the configuration","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"minimal date of the change","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date of the change","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"configlogs":{"items":{"$ref":"#/components/schemas/ConfigLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["configlogs"],"type":"object"}}},"description":"configlogs"}},"summary":"Get configuration change history of the API.","tags":["Administration"]}},"/connections":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connections"],"type":"object"}}},"description":"connections"}},"summary":"Get connections without a user","tags":["Connections","Banks","Providers"]}},"/connections/{id_connection}/logs":{"get":{"description":"Get logs about connections.

","parameters":[{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"period to group logs","in":"query","name":"period","required":false,"schema":{"type":"string"}},{"description":"ID of a user","in":"query","name":"id_user","required":false,"schema":{"type":"integer"}},{"description":"ID of a connection","in":"query","name":"id_connection","required":false,"schema":{"type":"integer"}},{"description":"ID of a connector","in":"query","name":"id_connector","required":false,"schema":{"type":"integer"}},{"description":"UUID of a connector","in":"query","name":"connector_uuid","required":false,"schema":{"type":"string"}},{"description":"connections log error filter","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"description":"ID of a source","in":"query","name":"id_source","required":false,"schema":{"type":"integer"}},{"description":"filter \"id\" of logs, maximum id to return","in":"query","name":"id_max","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectionlogs":{"items":{"$ref":"#/components/schemas/ConnectionLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectionlogs"],"type":"object"}}},"description":"connectionlogs"}},"summary":"Get connection logs","tags":["Connections","Banks","Providers"]}},"/connections/{id_connection}/sources":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectionSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get connection sources","tags":["Connections","Banks","Providers"]}},"/connections/{id_connection}/sources/{id_source}":{"delete":{"description":"This will make it so the specified source will not be synchronized anymore.

","parameters":[{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful DELETE on ConnectionSource resource"}},"summary":"Disable a connection source","tags":["Connections","Banks","Providers"]},"post":{"description":"This endpoint is used to enable a source or force a synchronization on it.

","parameters":[{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"description":"do the synchronization in background (to use with the sysynchronizenc parameter)","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postConnections_idConnection_sources_idSource_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful POST on ConnectionSource resource"}},"summary":"\"","tags":["Connections","Banks","Providers"]},"put":{"description":"This endpoint is used to enable a source or force a synchronization on it.

","parameters":[{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"description":"do the synchronization in background (to use with the synchronize parameter)","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/putConnections_idConnection_sources_idSource_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful PUT on ConnectionSource resource"}},"summary":"Update connection source","tags":["Connections","Banks","Providers"]}},"/connectors":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectors":{"items":{"$ref":"#/components/schemas/Connector"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectors"],"type":"object"}}},"description":"connectors"}},"summary":"Get list of connectors","tags":["Connections","Banks","Providers"]},"post":{"description":"Send a request to add a new connector

","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"comment":{"description":"Optionnal comment","type":"string"},"email":{"description":"Email of the user","type":"string"},"login":{"description":"Users login","type":"string"},"name":{"description":"Name of the bank or provider","type":"string"},"password":{"description":"Users password","type":"string"},"sendmail":{"description":"if set, send an email to user","type":"boolean"},"types":{"description":"Type of connector, eg. banks or providers","type":"string"},"url":{"description":"Url of the bank","type":"string"}},"required":["name","login","password"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"description":"Successful POST on Connector resource"}},"summary":"Request a new connector","tags":["Connections","Banks","Providers"]},"put":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"hidden":{"description":"to enable or disable connector (bank or provider)","type":"boolean"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"description":"Successful PUT on Connector resource"}},"summary":"Enable/disable several connectors","tags":["Banks"]}},"/connectors/{id_connector}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"description":"Successful GET on Connector resource"}},"summary":"Get a connector","tags":["Connections","Banks","Providers"]},"put":{"description":"

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"auth_mechanism":{"description":"the authentication mechanism to use for this connector","type":"string"},"hidden":{"description":"to enable or disable connector (bank or provider)","type":"boolean"},"id_categories":{"description":"one or several comma separated categories to map to the given connector (or null to map no category)","type":"string"},"sync_frequency":{"description":"Allows you to overload global sync_frequency param","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}},"auth_mechanism":{"examples":{"response":{"value":"credentials"}}},"beta":{"examples":{"response":{"value":true}}},"capabilities":{"examples":{"response":{"value":["profile","banktransferaddrecipient","contact","bank","banktransfer"]}}},"categories":{"examples":{"response":{"value":["virtual"]}}},"charged":{"examples":{"response":{"value":true}}},"code":{"examples":{"response":{"value":"40618"}}},"color":{"examples":{"response":{"value":"f10389"}}},"hidden":{"examples":{"response":{"value":false}}},"id":{"examples":{"response":{"value":4}}},"name":{"examples":{"response":{"value":"Boursorama"}}},"slug":{"examples":{"response":{"value":"BOU"}}},"sync_frequency":{"examples":{"response":{"value":null}}}},"description":"Successful PUT on Connector resource"}},"summary":"Edit the provided connector","tags":["Banks"]}},"/connectors/{id_connector}/logos":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]},"post":{"description":"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.

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.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorLogo"}}},"description":"Successful POST on ConnectorLogo resource"}},"summary":"Create a connector Logo","tags":["Banks","Providers"]},"put":{"description":"This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).

Form params: - id_file (integer): The id of the file to link with that connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorLogo"}}},"description":"Successful PUT on ConnectorLogo resource"}},"summary":"Create or Update a connector Logo","tags":["Banks","Providers"]}},"/connectors/{id_connector}/logos/main":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/connectors/{id_connector}/logos/thumbnail":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/connectors/{id_connector}/logos/{id_logo}":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_logo","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorLogo"}}},"description":"Successful DELETE on ConnectorLogo resource"}},"summary":"Delete a single Logo object.","tags":["Banks","Providers"]},"put":{"description":"This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).

Form params: - id_file (integer): The id of the file to link with that connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_logo","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorLogo"}}},"description":"Successful PUT on ConnectorLogo resource"}},"summary":"Create or Update a connector Logo.","tags":["Banks","Providers"]}},"/connectors/{id_connector}/sources":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectorSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get list of connector sources","tags":["Connections","Banks","Providers"]},"put":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"disabled_capabilities":{"description":"list (json format) of capabilities the sources will be disabled for","type":"string"},"unavailable_capabilities":{"description":"list (json format) of capabilities the sources will be unavailable for","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSource"}}},"description":"Successful PUT on ConnectorSource resource"}},"summary":"Edit several connector sources","tags":["Connections","Banks","Providers"]}},"/connectors/{id_connector}/sources/{id_connector_source}/fields":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_connector_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"source_fields":{"items":{"$ref":"#/components/schemas/ConnectorSourceField"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["source_fields"],"type":"object"}}},"description":"source_fields"}},"summary":"Get fields specific to a domain and a source","tags":["Connections","Banks"]}},"/connectors/{id_connector}/sources/{id_source}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSource"}}},"description":"Successful GET on ConnectorSource resource"}},"summary":"Get the connector source","tags":["Connections","Banks","Providers"]},"put":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"auth_mechanism":{"description":"the authentication mechanism to use for this connector source","type":"string"},"disabled":{"description":"to enable or disable connector source","type":"boolean"},"disabled_capabilities":{"description":"list (json format) of capabilities this source will be disabled for","type":"string"},"unavailable":{"description":"to enable or disable the source (can only be edited by BI employees)","type":"boolean"},"unavailable_capabilities":{"description":"list (json format) of capabilities this source will be unavailable for","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSource"}}},"description":"Successful PUT on ConnectorSource resource"}},"summary":"Edit the provided connector source","tags":["Connections","Banks","Providers"]}},"/incidents":{"get":{"description":"By default, provide all incidents. Results are paginated. Some filters can be set via query parameters.

","parameters":[{"description":"comma separated list, filter incidents in the given states.","in":"query","name":"state","required":false,"schema":{"type":"string"}},{"description":"give only the current state of the particular incidents.","in":"query","name":"id","required":false,"schema":{"type":"integer"}},{"description":"comma_separated list, filter the incidents of the given weboob_id","in":"query","name":"weboob_id","required":false,"schema":{"type":"string"}},{"description":"filter last_update date >= start_date. YYYY-MM-DD format.","in":"query","name":"start_date","required":false,"schema":{"type":"string"}},{"description":"filter last_update date <= start_date. YYYY-MM-DD format.","in":"query","name":"end_date","required":false,"schema":{"type":"string"}},{"description":"pagination option. Default to 1.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"pagination option. Default to 30.","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get incidents logs.","tags":["Timeline"]}},"/invoicing":{"get":{"description":"You can get all the invoicing data or just specific ones by using the available parameters.

If no parameters are specified, no invoicing data is returned.

","parameters":[{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"the number of user synchronized during the period","in":"query","name":"users_synced","required":false,"schema":{"type":"string"}},{"description":"the number of user of the Bank API synchronized during the period","in":"query","name":"users_bank","required":false,"schema":{"type":"string"}},{"description":" the number of user of the Bill API synchronized during the period","in":"query","name":"users_bill","required":false,"schema":{"type":"string"}},{"description":"the number of accounts synchronized during the period","in":"query","name":"accounts_synced","required":false,"schema":{"type":"string"}},{"description":"the number of subscriptions synchronized during the period","in":"query","name":"subscriptions_synced","required":false,"schema":{"type":"string"}},{"description":"the number of connections synchronized during the period","in":"query","name":"connections_synced","required":false,"schema":{"type":"string"}},{"description":"the number of Bank API connections synchronized during the period","in":"query","name":"connections_account","required":false,"schema":{"type":"string"}},{"description":"the number of transfers done during the period","in":"query","name":"transfers_synced","required":false,"schema":{"type":"string"}},{"description":"the number of payments done during the period","in":"query","name":"payments_synced","required":false,"schema":{"type":"string"}},{"description":"get all the invoicing data at once","in":"query","name":"all","required":false,"schema":{"type":"string"}},{"description":"get full ids list instead of numbers","in":"query","name":"detail","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get invoicing data for a given period (default is the current month).","tags":["Banks"]}},"/logs":{"get":{"description":"Get logs about connections.

","parameters":[{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"period to group logs","in":"query","name":"period","required":false,"schema":{"type":"string"}},{"description":"ID of a user","in":"query","name":"id_user","required":false,"schema":{"type":"integer"}},{"description":"ID of a connection","in":"query","name":"id_connection","required":false,"schema":{"type":"integer"}},{"description":"ID of a connector","in":"query","name":"id_connector","required":false,"schema":{"type":"integer"}},{"description":"UUID of a connector","in":"query","name":"connector_uuid","required":false,"schema":{"type":"string"}},{"description":"connections log error filter","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"description":"ID of a source","in":"query","name":"id_source","required":false,"schema":{"type":"integer"}},{"description":"filter \"id\" of logs, maximum id to return","in":"query","name":"id_max","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectionlogs":{"items":{"$ref":"#/components/schemas/ConnectionLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectionlogs"],"type":"object"}}},"description":"connectionlogs"}},"summary":"Get connection logs","tags":["Connections","Banks","Providers"]}},"/monitoring":{"get":{"description":"","parameters":[{"description":"number on days on which stats on synchronization have to be done per worker (Default: 1)","in":"query","name":"period","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"get performances stats on this instance","tags":["Administration"]}},"/providers":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"providers":{"items":{"$ref":"#/components/schemas/Connector"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["providers"],"type":"object"}}},"description":"providers"}},"summary":"Get list of connectors","tags":["Connections","Banks","Providers"]}},"/providers/{id_connector}/connections":{"get":{"description":"By default, it selects a set of 3 connections.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"the length of the connection subset","in":"query","name":"range","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connections"],"type":"object"}}},"description":"connections"}},"summary":"Get a random subset of provider's id_connection","tags":["Banks","Connections"]}},"/providers/{id_connector}/logos":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/providers/{id_connector}/logos/main":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/providers/{id_connector}/logos/thumbnail":{"get":{"description":"This endpoint returns all links to files associated with this connector.

","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectorlogos":{"items":{"$ref":"#/components/schemas/ConnectorLogo"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectorlogos"],"type":"object"}}},"description":"connectorlogos"}},"summary":"Get all links to the files associated with this connector.","tags":["Banks","Providers"]}},"/providers/{id_connector}/sources":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectorSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get list of connector sources","tags":["Connections","Banks","Providers"]}},"/providers/{id_connector}/sources/{id_connector_source}/fields":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_connector_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"source_fields":{"items":{"$ref":"#/components/schemas/ConnectorSourceField"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["source_fields"],"type":"object"}}},"description":"source_fields"}},"summary":"Get fields specific to a domain and a source","tags":["Connections","Banks"]}},"/providers/{id_connector}/sources/{id_source}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_connector","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorSource"}}},"description":"Successful GET on ConnectorSource resource"}},"summary":"Get the connector source","tags":["Connections","Banks","Providers"]}},"/providers/{id_provider}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_provider","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connector"}}},"description":"Successful GET on Connector resource"}},"summary":"Get a connector","tags":["Connections","Banks","Providers"]}},"/psd2-registrations":{"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"psd2registrations":{"items":{"$ref":"#/components/schemas/Psd2Registration"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["psd2registrations"],"type":"object"}}},"description":"psd2registrations"}},"summary":"Get details on all psd2 registrations","tags":["Banks"]}},"/psd2-registrations/{id_psd2-registration}":{"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_psd2-registration","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Psd2Registration"}}},"description":"Successful GET on Psd2Registration resource"}},"summary":"Get details for a given psd2 registration","tags":["Banks"]}},"/psd2-registrations/{id_psd2registration}/logs":{"get":{"description":"Get logs of psd2 registration. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.

","parameters":[{"description":"","in":"path","name":"id_psd2registration","required":true,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal (inclusive) date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum (inclusive) date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"psd2registrationlogs":{"items":{"$ref":"#/components/schemas/Psd2RegistrationLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["psd2registrationlogs"],"type":"object"}}},"description":"psd2registrationlogs"}},"summary":"Get psd2 registration logs.","tags":["Banks"]}},"/publickey":{"get":{"description":"","responses":{"200":{"description":"standard HTTP response"}},"summary":"Get public encryption key of the API.","tags":["Administration"]}},"/test/sync":{"post":{"description":"It can be used to test receiving data on your webhooks.

","responses":{"200":{"description":"standard HTTP response"}},"summary":"Test synchronization on a random connection.","tags":["Administration"]}},"/test/webhooks":{"post":{"description":"It can be used to test receiving data on your webhooks.

","responses":{"200":{"description":"standard HTTP response"}},"summary":"Test synchronization on a random connection.","tags":["Administration"]}},"/users":{"get":{"description":"","parameters":[{"description":"searches a user by mail (if it contains no '@', '@biapi.pro' will be added at the end)","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["users"],"type":"object"}}},"description":"users"}},"summary":"Get users","tags":["Users management"]}},"/users/{id_user}":{"delete":{"description":"This endpoint deletes the user.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Successful DELETE on User resource"}},"summary":"Delete the user","tags":["Authentication","Users management"]},"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Successful GET on User resource"}},"summary":"Get a user","tags":["Users management","PFM","Authentication"]}},"/users/{id_user}/account_types":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accounttypes":{"items":{"$ref":"#/components/schemas/AccountType"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["accounttypes"],"type":"object"}}},"description":"accounttypes"}},"summary":"Get account types","tags":["Banks"]}},"/users/{id_user}/account_types/{id_account_type}":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account_type","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountType"}}},"description":"Successful GET on AccountType resource"}},"summary":"Get an account type","tags":["Banks"]}},"/users/{id_user}/accounts/{id_account}/categories":{"get":{"description":"Ressource to get categories for the user's transactions

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get the category","tags":["Banks"]}},"/users/{id_user}/accounts/{id_account}/transactionsclusters":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactionsclusters":{"items":{"$ref":"#/components/schemas/TransactionsCluster"},"type":"array"}},"required":["transactionsclusters"],"type":"object"}}},"description":"transactionsclusters"}},"summary":"Get clustered transactions","tags":["Banks"]},"post":{"description":"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

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful POST on TransactionsCluster resource"}},"summary":"Create clustered transaction","tags":["Banks"]}},"/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful DELETE on TransactionsCluster resource"}},"summary":"Delete a clustered transaction","tags":["Banks"]},"put":{"description":"Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful PUT on TransactionsCluster resource"}},"summary":"Edit a clustered transaction","tags":["Banks"]}},"/users/{id_user}/alerts":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/Alert"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["alerts"],"type":"object"}}},"description":"alerts"}},"summary":"Get alerts","tags":["Banks"]}},"/users/{id_user}/categories":{"get":{"description":"Ressource to get categories for the user's transactions

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get the category","tags":["Banks"]}},"/users/{id_user}/categories/full":{"get":{"description":"Ressource to get categories

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"categorys":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["categorys"],"type":"object"}}},"description":"categorys"}},"summary":"Get the category","tags":["Banks"]},"post":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"accountant_account":{"description":"Accountant account number.","type":"string"},"color":{"description":"Color of the category.","type":"string"},"id_parent_category":{"description":"ID of the parent category.","type":"integer"},"id_parent_category_in_menu":{"description":"ID of the parent category to be displayed.","type":"integer"},"income":{"description":"Is an income category. If null, this is both an income and an expense category.","type":"boolean"},"name":{"description":"Name of the category.","type":"string"},"refundable":{"description":"This category accepts opposite sign of transactions.","type":"boolean"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"Successful POST on Category resource"}},"summary":"Create a new transaction category","tags":["Banks"]}},"/users/{id_user}/categories/full/{id_full}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_full","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"Successful DELETE on Category resource"}},"summary":"Delete a user-created transaction category","tags":["Banks"]},"put":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_full","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"accountant_account":{"description":"Accountant account number.","type":"string"},"hide":{"description":"Hide (but not delete) a category. Must be 0, 1 or toggle.","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":"Successful PUT on Category resource"}},"summary":"Modify a user-created category","tags":["Banks"]}},"/users/{id_user}/config":{"delete":{"description":"- keys (string): list of coma separated keys to be deleted.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Delete the given user configurations. deletions on keys prefixed by 'biapi.' (except callback_url) are ignored","tags":["Users management"]},"get":{"description":"

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"required":["biapi.last_push"],"type":"object"}},"biapi.last_push":{"examples":{"response":{"value":"2025-08-15T13:50:43.295Z"}}}},"description":""}},"summary":"Get configuration of a user.","tags":["Users management"]},"post":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Change configuration of a user. modifications on keys prefixed by 'biapi.' (except callback_url) are ignored","tags":["Users management"]}},"/users/{id_user}/connections":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Successful DELETE on Connection resource"}},"summary":"Delete all connections","tags":["Connections","Banks","Providers"]},"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connections"],"type":"object"}}},"description":"connections"}},"summary":"Get connections","tags":["Connections","Banks","Providers"]},"post":{"description":"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).

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"optional comma-separated list of sources to use for the connection synchronization","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"connector_uuid":{"description":"optional uuid of the connector (replaces id_connector)","type":"string"},"id_connector":{"description":"ID of the connector","type":"integer"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Successful POST on Connection resource"}},"summary":"Add a new connection.","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}":{"delete":{"description":"This endpoint deletes a connection and all related accounts and transactions.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Successful DELETE on Connection resource"}},"summary":"Delete a connection.","tags":["Connections","Banks","Providers"]},"post":{"description":"Give new parameters to change on the configuration of this connection (for example \"password\").

It tests connection to website, and if it fails, a 400 response is given with the error code \"wrongpass\" or \"websiteUnavailable\".

You can also supply meta-parameters on connection, like 'active' or 'expire'.

It's possible to execute the update/synchronization in the background with a query parameter. If done in background this endpoint will respond with data that is not yet updated. To obtain updated data, polling is required as the the data will be filled in the background.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"Do the connection update/synchronization in background","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"description":"Whether the connection synchronization is asked by the PSU or not (default is true)","in":"query","name":"psu_requested","required":false,"schema":{"type":"boolean"}},{"description":"Refresh the PSU's SCA for openapi source","in":"query","name":"refresh_psd2_auth","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"active":{"description":"Set if the connection synchronization is active","type":"boolean"},"decoupled":{"description":"Try to update a connection with the decoupled error","type":"boolean"},"expire":{"description":"Set expiration of the connection to this date","format":"date-time","type":"string"},"login":{"description":"Set login to this new login","type":"string"},"password":{"description":"Set password to this new password","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Successful POST on Connection resource"}},"summary":"Update a connection.","tags":["Connections","Banks","Providers"]},"put":{"description":"We suggest to pass parameter expand=accounts[transactions] to get all *new* and *updated* transactions.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"if supplied, get transactions inserted since this date","in":"query","name":"last_update","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"do the connection synchronization in background","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"description":"Whether the connection synchronization is asked by the PSU or not (default is true)","in":"query","name":"psu_requested","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connection"}}},"description":"Successful PUT on Connection resource"}},"summary":"Force synchronisation of a connection.","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}/accounts":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Successful DELETE on Account resource"}},"summary":"Delete all accounts","tags":["Banks"]},"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/Account"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["accounts"],"type":"object"}}},"description":"accounts"}},"summary":"Get accounts list.","tags":["Banks"]},"post":{"description":"This endpoint creates an account related to a connection or not.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"balance":{"description":"balance of account","format":"float","type":"number"},"iban":{"description":"IBAN of account","type":"string"},"id_connection":{"description":"the connection to attach to the account","type":"integer"},"id_currency":{"description":"the currency of the account (default: 'EUR')","type":"string"},"name":{"description":"name of account","type":"string"},"number":{"description":"number of account","type":"string"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Successful POST on Account resource"}},"summary":"Create an account","tags":["Banks"]},"put":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Successful PUT on Account resource"}},"summary":"Update many accounts at once","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}":{"delete":{"description":"It deletes a specific account.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Successful DELETE on Account resource"}},"summary":"Delete an account.","tags":["Banks"]},"put":{"description":"It updates a specific account

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"balance":{"description":"Balance of the account","format":"float","type":"number"},"bookmarked":{"description":"If the account is bookmarked","type":"boolean"},"disabled":{"description":"If the account is disabled (not synchronized)","type":"boolean"},"display":{"description":"If the account is displayed","type":"boolean"},"iban":{"description":"IBAN of the account","type":"string"},"name":{"description":"Label of the account","type":"string"},"usage":{"description":"Usage of the account : PRIV, ORGA or ASSO","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Successful PUT on Account resource"}},"summary":"Update an account","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/categories":{"get":{"description":"Ressource to get categories for the user's transactions

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get the category","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/delta":{"get":{"description":"Get account delta between sums of transactions and difference of account balance for the given period.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"period to group logs","in":"query","name":"period","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get deltas of accounts","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/logs":{"get":{"description":"Get logs of account. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal (inclusive) date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum (inclusive) date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accountlogs":{"items":{"$ref":"#/components/schemas/AccountLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["accountlogs"],"type":"object"}}},"description":"accountlogs"}},"summary":"Get accounts logs.","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/sources":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectionSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get account sources","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"Successful DELETE on Transaction resource"}},"summary":"Delete transactions","tags":["Banks"]},"get":{"description":"Get list of transactions.

By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal (inclusive) date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum (inclusive) date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"filter on income or expenditures","in":"query","name":"income","required":false,"schema":{"type":"boolean"}},{"description":"display only deleted transactions","in":"query","name":"deleted","required":false,"schema":{"type":"boolean"}},{"description":"display all transactions, including deleted ones","in":"query","name":"all","required":false,"schema":{"type":"boolean"}},{"description":"get only transactions updated after the specified datetime","in":"query","name":"last_update","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"filter transactions containing the given string","in":"query","name":"wording","required":false,"schema":{"type":"string"}},{"description":"minimal (inclusive) value","in":"query","name":"min_value","required":false,"schema":{"format":"float","type":"number"}},{"description":"maximum (inclusive) value","in":"query","name":"max_value","required":false,"schema":{"format":"float","type":"number"}},{"description":"search in labels, dates, values and categories","in":"query","name":"search","required":false,"schema":{"type":"string"}},{"description":"\"XX|-XX\" or \"±XX\"","in":"query","name":"value","required":false,"schema":{"type":"string"}},{"description":"filter on given category id(s) (comma separated) or \"null\"","in":"query","name":"id_category","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactions":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"}},"required":["transactions"],"type":"object"}}},"description":"transactions"}},"summary":"Get transactions","tags":["Banks"]},"post":{"description":"Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.



","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"active":{"description":"1 if the transaction should be taken into account by pfm services (default: 1)","type":"boolean"},"coming":{"description":"1 if the transaction has already been debited (default: 0)","type":"boolean"},"date":{"description":"date of the transaction","format":"date","type":"string"},"date_scraped":{"description":"date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)","format":"date-time","type":"string"},"id_account":{"description":"account of the transaction. If not supplied, it has to be given in the route","type":"integer"},"original_wording":{"description":"label of the transaction","type":"string"},"rdate":{"description":"realisation date of the transaction (default: value of date)","format":"date","type":"string"},"state":{"description":"nature of the transaction (default: new)","type":"string"},"type":{"description":"type of the transaction (default: unknown)","type":"string"},"value":{"description":"vallue of the transaction","type":"integer"}},"required":["original_wording","value","date"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"Successful POST on Transaction resource"}},"summary":"Create transactions","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}":{"put":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"active":{"description":"if false, transaction isn't considered in analyzisis endpoints (like /balances)","type":"boolean"},"application_date":{"description":"change application date of the transaction","format":"date","type":"string"},"comment":{"description":"change comment","type":"string"},"id_category":{"description":"ID of the associated category","type":"integer"},"wording":{"description":"user rewording of the transaction","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}},"description":"Successful PUT on Transaction resource"}},"summary":"Edit a transaction meta-data","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInformation"}}},"description":"Successful DELETE on TransactionInformation resource"}},"summary":"Delete all arbitrary key-value pairs of a transaction","tags":["Banks"]},"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactioninformations":{"items":{"$ref":"#/components/schemas/TransactionInformation"},"type":"array"}},"required":["transactioninformations"],"type":"object"}}},"description":"transactioninformations"}},"summary":"List all arbitrary key-value pairs on a transaction","tags":["Banks"]},"put":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInformation"}}},"description":"Successful PUT on TransactionInformation resource"}},"summary":"Add or edit transaction arbitrary key-value pairs","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_information","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInformation"}}},"description":"Successful DELETE on TransactionInformation resource"}},"summary":"Delete a particular key-value pair on a transaction.","tags":["Banks"]},"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transaction","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_information","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInformation"}}},"description":"Successful GET on TransactionInformation resource"}},"summary":"Get a particular arbitrary key-value pair on a transaction","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactionsclusters":{"items":{"$ref":"#/components/schemas/TransactionsCluster"},"type":"array"}},"required":["transactionsclusters"],"type":"object"}}},"description":"transactionsclusters"}},"summary":"Get clustered transactions","tags":["Banks"]},"post":{"description":"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

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful POST on TransactionsCluster resource"}},"summary":"Create clustered transaction","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful DELETE on TransactionsCluster resource"}},"summary":"Delete a clustered transaction","tags":["Banks"]},"put":{"description":"Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_account","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful PUT on TransactionsCluster resource"}},"summary":"Edit a clustered transaction","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/informations":{"get":{"description":"

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/Connection"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connections"],"type":"object"}},"compagny":{"examples":{"response":{"value":{"...":"...","name":"Roundcore"}}}},"owner":{"examples":{"response":{"value":{"...":"...","name":"Monsieur Honoré Émile"}}}}},"description":"connections"}},"summary":"Get connection additionnal informations","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}/logs":{"get":{"description":"Get logs about connections.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"period to group logs","in":"query","name":"period","required":false,"schema":{"type":"string"}},{"description":"ID of a user","in":"query","name":"id_user","required":false,"schema":{"type":"integer"}},{"description":"ID of a connection","in":"query","name":"id_connection","required":false,"schema":{"type":"integer"}},{"description":"ID of a connector","in":"query","name":"id_connector","required":false,"schema":{"type":"integer"}},{"description":"UUID of a connector","in":"query","name":"connector_uuid","required":false,"schema":{"type":"string"}},{"description":"connections log error filter","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"description":"ID of a source","in":"query","name":"id_source","required":false,"schema":{"type":"integer"}},{"description":"filter \"id\" of logs, maximum id to return","in":"query","name":"id_max","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectionlogs":{"items":{"$ref":"#/components/schemas/ConnectionLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectionlogs"],"type":"object"}}},"description":"connectionlogs"}},"summary":"Get connection logs","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}/sources":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/ConnectionSource"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["sources"],"type":"object"}}},"description":"sources"}},"summary":"Get connection sources","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}/sources/{id_source}":{"delete":{"description":"This will make it so the specified source will not be synchronized anymore.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful DELETE on ConnectionSource resource"}},"summary":"Disable a connection source","tags":["Connections","Banks","Providers"]},"post":{"description":"This endpoint is used to enable a source or force a synchronization on it.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"description":"do the synchronization in background (to use with the sysynchronizenc parameter)","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postConnections_idConnection_sources_idSource_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful POST on ConnectionSource resource"}},"summary":"\"","tags":["Connections","Banks","Providers"]},"put":{"description":"This endpoint is used to enable a source or force a synchronization on it.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_source","required":true,"schema":{"type":"integer"}},{"description":"do the synchronization in background (to use with the synchronize parameter)","in":"query","name":"background","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/putConnections_idConnection_sources_idSource_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSource"}}},"description":"Successful PUT on ConnectionSource resource"}},"summary":"Update connection source","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/connections/{id_connection}/transactionsclusters":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactionsclusters":{"items":{"$ref":"#/components/schemas/TransactionsCluster"},"type":"array"}},"required":["transactionsclusters"],"type":"object"}}},"description":"transactionsclusters"}},"summary":"Get clustered transactions","tags":["Banks"]},"post":{"description":"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

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful POST on TransactionsCluster resource"}},"summary":"Create clustered transaction","tags":["Banks"]}},"/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful DELETE on TransactionsCluster resource"}},"summary":"Delete a clustered transaction","tags":["Banks"]},"put":{"description":"Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_connection","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful PUT on TransactionsCluster resource"}},"summary":"Edit a clustered transaction","tags":["Banks"]}},"/users/{id_user}/forecast":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"standard HTTP response"}},"summary":"Get forecast","tags":["Banks","PFM"]}},"/users/{id_user}/logs":{"get":{"description":"Get logs about connections.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"period to group logs","in":"query","name":"period","required":false,"schema":{"type":"string"}},{"description":"ID of a user","in":"query","name":"id_user","required":false,"schema":{"type":"integer"}},{"description":"ID of a connection","in":"query","name":"id_connection","required":false,"schema":{"type":"integer"}},{"description":"ID of a connector","in":"query","name":"id_connector","required":false,"schema":{"type":"integer"}},{"description":"UUID of a connector","in":"query","name":"connector_uuid","required":false,"schema":{"type":"string"}},{"description":"connections log error filter","in":"query","name":"error","required":false,"schema":{"type":"string"}},{"description":"ID of a source","in":"query","name":"id_source","required":false,"schema":{"type":"integer"}},{"description":"filter \"id\" of logs, maximum id to return","in":"query","name":"id_max","required":false,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"connectionlogs":{"items":{"$ref":"#/components/schemas/ConnectionLog"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["connectionlogs"],"type":"object"}}},"description":"connectionlogs"}},"summary":"Get connection logs","tags":["Connections","Banks","Providers"]}},"/users/{id_user}/profiles":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"profiles":{"items":{"$ref":"#/components/schemas/Profile"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["profiles"],"type":"object"}}},"description":"profiles"}},"summary":"Get profiles","tags":["Users management","PFM"]}},"/users/{id_user}/profiles/main":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"Successful GET on Profile resource"}},"summary":"Get the main profile","tags":["Users management","PFM"]}},"/users/{id_user}/profiles/{id_profile}":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_profile","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}},"description":"Successful GET on Profile resource"}},"summary":"Get a profile","tags":["Users management","PFM"]}},"/users/{id_user}/token":{"post":{"description":"Create an access_token for this user and get it.

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"application":{"description":"application name","type":"string"}},"required":["application"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"required":["token"],"type":"object"}},"token":{"examples":{"response":{"value":"A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"}}}},"description":""}},"summary":"Create a token","tags":["Users management","Authentication"]}},"/users/{id_user}/transactionsclusters":{"get":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"transactionsclusters":{"items":{"$ref":"#/components/schemas/TransactionsCluster"},"type":"array"}},"required":["transactionsclusters"],"type":"object"}}},"description":"transactionsclusters"}},"summary":"Get clustered transactions","tags":["Banks"]},"post":{"description":"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

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful POST on TransactionsCluster resource"}},"summary":"Create clustered transaction","tags":["Banks"]}},"/users/{id_user}/transactionsclusters/{id_transactionscluster}":{"delete":{"description":"","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful DELETE on TransactionsCluster resource"}},"summary":"Delete a clustered transaction","tags":["Banks"]},"put":{"description":"Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

","parameters":[{"description":"Hint: you can use 'me' or 'all'","in":"path","name":"id_user","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id_transactionscluster","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsCluster"}}},"description":"Successful PUT on TransactionsCluster resource"}},"summary":"Edit a clustered transaction","tags":["Banks"]}},"/webauth":{"get":{"description":"The route encapsulate 2 functionalities: 1. Create or update a connection through oAuth2 session.

2. Execute a transfer through OAuth2 session.","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"client_id":{"description":"Client Application ID","type":"integer"},"id_transfer":{"description":"ID of the transfer","type":"integer"},"redirect_uri":{"description":"Redirect URI","type":"string"},"state":{"description":"Optional state","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"standard HTTP response"}},"summary":"First step to establish an oAuth2 connection.","tags":["Authentication","Transfer"]}},"/webhooks":{"delete":{"description":"Updates the deleted field with the date of the deletion

","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful DELETE on Webhook resource"}},"summary":"Deletes all webhooks","tags":["Administration"]},"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"webhooks":{"items":{"$ref":"#/components/schemas/Webhook"},"type":"array"}},"required":["webhooks"],"type":"object"}}},"description":"webhooks"}},"summary":"Get webhooks","tags":["Administration"]},"post":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"event":{"description":"The webhook event","type":"string"},"id_auth":{"description":"The webhook authentication process to use (its ID or its name)","type":"string"},"id_service":{"description":"The service ID to associate with the webhook","type":"integer"},"id_user":{"description":"The user ID to associate with the webhook","type":"integer"},"params":{"description":"The webhook parameters as an object with three keys: type, key and value","type":"string"},"url":{"description":"The webhook callback url","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful POST on Webhook resource"}},"summary":"Adds a new webhook","tags":["Administration"]}},"/webhooks/auth":{"delete":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"}}},"description":"Successful DELETE on AuthProvider resource"}},"summary":"Deletes all webhook authentication types","tags":["Administration"]},"get":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"authproviders":{"items":{"$ref":"#/components/schemas/AuthProvider"},"type":"array"},"total":{"description":"total number of results","type":"number"}},"required":["authproviders"],"type":"object"}}},"description":"authproviders"}},"summary":"Get webhooks authentication types","tags":["Administration"]},"post":{"description":"","parameters":[{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"config":{"description":"The authentication process configuration. A dict contains either the certificate","type":"string"},"name":{"description":"The name of the authentication process to differentiate","type":"string"},"type":{"description":"The type of the authentication process (oauth, certificate, token, etc...)","type":"integer"}},"required":["type","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"}}},"description":"Successful POST on AuthProvider resource"}},"summary":"Adds a new webhook authentication type","tags":["Administration"]}},"/webhooks/auth/{id_auth}":{"delete":{"description":"Updates the deleted field with the date of the deletion

","parameters":[{"description":"","in":"path","name":"id_auth","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"}}},"description":"Successful DELETE on AuthProvider resource"}},"summary":"Deletes the webhook authentication type","tags":["Administration"]},"post":{"description":"","parameters":[{"description":"","in":"path","name":"id_auth","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"config":{"description":"The authentication process configuration. A dict containing either the certificate","type":"string"},"name":{"description":"The name of the authentication process to differentiate","type":"string"},"type":{"description":"The type of the authentication process (oauth, certificate, token, etc...)","type":"integer"}},"required":["type","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"}}},"description":"Successful POST on AuthProvider resource"}},"summary":"Updates the webhook authentication type","tags":["Administration"]},"put":{"description":"","parameters":[{"description":"","in":"path","name":"id_auth","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"config":{"description":"The authentication process configuration. A dict containt either the certificate","type":"string"},"name":{"description":"The name of the authentication process to differentiate","type":"string"},"type":{"description":"The type of the authentication process (oauth, certificate, token, etc...)","type":"integer"}},"required":["type","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProvider"}}},"description":"Successful PUT on AuthProvider resource"}},"summary":"Updates the webhook authentication type","tags":["Administration"]}},"/webhooks/{id_webhook}":{"delete":{"description":"Updates the deleted field with the date of the deletion

","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful DELETE on Webhook resource"}},"summary":"Deletes a webhook","tags":["Administration"]},"post":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postWebhooks_idWebhook_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful POST on Webhook resource"}},"summary":"Updates a webhook","tags":["Administration"]},"put":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postWebhooks_idWebhook_"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful PUT on Webhook resource"}},"summary":"Updates a webhook","tags":["Administration"]}},"/webhooks/{id_webhook}/add_to_data":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful DELETE on Webhook resource"}},"summary":"delete all entries","tags":["Administration"]},"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"webhooks":{"items":{"$ref":"#/components/schemas/Webhook"},"type":"array"}},"required":["webhooks"],"type":"object"}}},"description":"webhooks"}},"summary":"retrieve the list of the value to add in webhooks when sending the requested webhook","tags":["Administration"]},"post":{"description":"For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.

","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful POST on Webhook resource"}},"summary":"Setup a field to store in user config when calling the endpoint","tags":["Administration"]}},"/webhooks/{id_webhook}/add_to_data/{key}":{"delete":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful DELETE on Webhook resource"}},"summary":"delete the requested entry","tags":["Administration"]},"get":{"description":"","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful GET on Webhook resource"}},"summary":"retrieve the value to add in the requested webhook for the requested name","tags":["Administration"]},"post":{"description":"For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.

","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"description":"","in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"description":"Successful POST on Webhook resource"}},"summary":"upate the requested field to store in user config when calling the endpoint","tags":["Administration"]}},"/webhooks/{id_webhook}/logs":{"get":{"description":"Get logs of the webhooks.

By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.

","parameters":[{"description":"","in":"path","name":"id_webhook","required":true,"schema":{"type":"integer"}},{"description":"limit number of results to this user","in":"query","name":"id_user","required":false,"schema":{"type":"integer"}},{"description":"limit number of results","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"offset of first result","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"minimal (inclusive) date","in":"query","name":"min_date","required":false,"schema":{"format":"date","type":"string"}},{"description":"maximum (inclusive) date","in":"query","name":"max_date","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total":{"description":"total number of results","type":"number"},"webhooklogs":{"items":{"$ref":"#/components/schemas/WebhookLog"},"type":"array"}},"required":["webhooklogs"],"type":"object"}}},"description":"webhooklogs"}},"summary":"Get webhooks logs.","tags":["Administration"]}}},"components":{"requestBodies":{"postConnections_idConnection_sources_idSource_":{"content":{"multipart/form-data":{"schema":{"properties":{"disabled":{"description":"to enable or disable connector source","type":"boolean"},"synchronize":{"description":"whether to force a synchronization on the source if it's not disabled","type":"boolean"}},"type":"object"}}}},"postWebhooks_idWebhook_":{"content":{"multipart/form-data":{"schema":{"properties":{"deleted":{"description":"a date to delete the webhook or 'null' to enable it","type":"string"},"event":{"description":"The webhook event","type":"string"},"id_auth":{"description":"The webhook authentication process to use","type":"integer"},"id_service":{"description":"The service ID to associate with the webhook","type":"integer"},"id_user":{"description":"The user ID to associate with the webhook","type":"integer"},"url":{"description":"The webhook callback url","type":"string"}},"type":"object"}}}},"putConnections_idConnection_sources_idSource_":{"content":{"multipart/form-data":{"schema":{"properties":{"disabled":{"description":"to enable or disable connector source","type":"boolean"},"force":{"description":"whether to force the synchronization on the source if it's in error","type":"boolean"},"synchronize":{"description":"whether to force a synchronization on the source if it's not disabled","type":"boolean"}},"type":"object"}}}}},"schemas":{"Access":{"example":{"email":"","id":0,"id_profile":0,"id_role":0,"id_user":0},"properties":{"email":{"type":"string"},"id":{"type":"integer"},"id_profile":{"type":"integer"},"id_role":{"type":"integer"},"id_user":{"type":"integer"}},"required":["id","id_profile"],"type":"object"},"Account":{"example":{"balance":0,"bookmarked":false,"coming":0,"company_name":"","currency":"","deleted":"2025-08-15T13:50:43.296Z","disabled":"2025-08-15T13:50:43.296Z","display":true,"error":"","iban":"","id":0,"id_connection":0,"id_parent":0,"id_source":0,"id_type":0,"id_user":0,"last_update":"2025-08-15T13:50:43.296Z","name":"","number":"","opening_date":"2025-08-15T13:50:43.296Z","original_name":"","ownership":"","usage":"","webid":""},"properties":{"balance":{"description":"Balance of the account","format":"float","type":"number"},"bookmarked":{"default":false,"description":"This account has been bookmarked by user","type":"integer"},"coming":{"default":0,"description":"Amount of coming operations not yet debited","format":"float","type":"number"},"company_name":{"description":"Name of the company holding the employee savings of the account","type":"string"},"currency":{"description":"Account currency","type":"object"},"deleted":{"description":"This account is not found on the website anymore","format":"date-time","type":"string"},"disabled":{"description":"This account has been deleted by user and will not be synchronized anymore","format":"date-time","type":"string"},"display":{"default":true,"description":"Display this account in accounts list","type":"boolean"},"error":{"description":"If the last update has failed, the error code","type":"string"},"iban":{"description":"Account IBAN","type":"string"},"id":{"description":"ID of the account","type":"integer"},"id_connection":{"description":"ID of the related connection","type":"integer"},"id_parent":{"description":"Id of the parent account","type":"integer"},"id_source":{"description":"ID of the related connection source","type":"integer"},"id_type":{"description":"ID of the account type","type":"integer"},"id_user":{"description":"ID of the related user","type":"integer"},"last_update":{"description":"Last successful update of the account","format":"date-time","type":"string"},"name":{"description":"Name of the account","type":"string"},"number":{"description":"Account number","type":"string"},"opening_date":{"description":"Opening date of the account","format":"date","type":"string"},"original_name":{"description":"Original name of the account on the bank","type":"string"},"ownership":{"description":"Relationship between the credentials owner and the account","type":"string"},"usage":{"description":"Account usage (if not set by the user, displays the value of original_usage)","type":"string"},"webid":{"description":"Account webid","type":"string"}},"required":["id","original_name","balance","display","bookmarked"],"type":"object"},"AccountLog":{"example":{"balance":0,"coming":0,"error":"","error_message":"","id":0,"id_account":0,"id_connection_log":0,"id_connector":0,"timestamp":""},"properties":{"balance":{"description":"Balanced recorded","format":"float","type":"number"},"coming":{"default":0,"description":"Coming debit recorded","format":"float","type":"number"},"error":{"description":"If fail, contains the error code","type":"string"},"error_message":{"description":"If fail, error message received from bank or provider","type":"string"},"id":{"description":"ID of the log","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_connection_log":{"description":"ID of the related connection log","type":"integer"},"id_connector":{"description":"provider id","type":"integer"},"timestamp":{"default":"","description":"Timestamp of log","format":"date-time","type":"string"}},"required":["id","id_account","balance","timestamp"],"type":"object"},"AccountType":{"example":{"color":"","display_name":"","display_name_p":"","id":0,"id_parent":0,"is_invest":false,"name":"","product":"","weboob_type_id":0},"properties":{"color":{"description":"Color of the account type (hexdecimal)","type":"string"},"display_name":{"description":"Name to display in singular","type":"string"},"display_name_p":{"description":"Name to display in plurial","type":"string"},"id":{"description":"ID of the account type","type":"integer"},"id_parent":{"description":"Id of the parent type","type":"integer"},"is_invest":{"default":false,"description":"Is it an investment account","type":"boolean"},"name":{"description":"Name of the account type","type":"string"},"product":{"description":"Product associated with the account","type":"string"},"weboob_type_id":{"description":"Map to the weboob_type_id","type":"integer"}},"required":["id","name","is_invest","weboob_type_id","display_name_p","display_name"],"type":"object"},"Alert":{"example":{"id":0,"id_account":0,"id_investment":0,"id_transaction":0,"id_user":0,"timestamp":"","type":"","value":0},"properties":{"id":{"type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_investment":{"description":"ID of the related investment","type":"integer"},"id_transaction":{"description":"ID of the related transaction","type":"integer"},"id_user":{"description":"ID of the related user","type":"integer"},"timestamp":{"default":"","description":"Date of the alerts emission","format":"date-time","type":"string"},"type":{"description":"Type of the alert","type":"string"},"value":{"description":"Amount related to the alert","format":"float","type":"number"}},"required":["id","id_user","timestamp","type","value"],"type":"object"},"AuthProvider":{"example":{"id":0,"name":"","type":""},"properties":{"id":{"type":"integer"},"name":{"description":"Name to differentiate the authentication type","type":"string"},"type":{"description":"Authentication type to use when pushing the webhook","type":"string"}},"required":["id","name","type"],"type":"object"},"Category":{"example":{"color":"","id":0,"id_logo":0,"id_parent_category":0,"id_parent_category_in_menu":0,"id_user":0,"income":false,"name":"","name_displayed":"","refundable":false},"properties":{"color":{"description":"Color of the category","type":"string"},"id":{"description":"ID of the category","type":"integer"},"id_logo":{"description":"ID of the logo","type":"integer"},"id_parent_category":{"description":"ID of the parent category. If this is a parent category, it will be equal to its own ID","type":"integer"},"id_parent_category_in_menu":{"description":"ID of the parent category to be displayed","type":"integer"},"id_user":{"description":"If not null, this category is specific to a user","type":"integer"},"income":{"description":"Is an income category. If null, this is both an income and an expense category","type":"boolean"},"name":{"description":"Name of the category","type":"string"},"name_displayed":{"description":"Displayed name, with HTML tags","type":"string"},"refundable":{"description":"This category accepts opposite sign of transactions","type":"boolean"}},"required":["id","id_parent_category","name","color","id_parent_category_in_menu","refundable"],"type":"object"},"Certificate":{"example":{"created":"2025-08-15T13:50:43.297Z","id":0,"id_private_key_file":0,"id_public_key_file":0,"type":""},"properties":{"created":{"format":"date-time","type":"string"},"id":{"type":"integer"},"id_private_key_file":{"type":"integer"},"id_public_key_file":{"type":"integer"},"type":{"type":"string"}},"required":["id","id_public_key_file","id_private_key_file","type","created"],"type":"object"},"Client":{"example":{"id":0,"id_logo":0,"name":"","private_key":"","pro":false,"public_key":"","redirect_uris":"","secret":""},"properties":{"config":{"description":"customizable config","type":"string"},"id":{"type":"integer"},"id_logo":{"type":"integer"},"name":{"default":"","type":"string"},"private_key":{"type":"string"},"pro":{"default":false,"description":"Should the client display the company manager page.","type":"boolean"},"public_key":{"type":"string"},"redirect_uris":{"default":"","type":"string"},"secret":{"type":"string"}},"required":["id","name","secret","redirect_uris","pro"],"type":"object"},"ConfigLog":{"example":{"id":0,"new_value":"","origin":"","previous_value":"","timestamp":"","type":""},"properties":{"id":{"type":"integer"},"key":{"type":"string"},"new_value":{"type":"string"},"origin":{"description":"The entity who made the config key modification","type":"string"},"previous_value":{"type":"string"},"timestamp":{"default":"","description":"Timestamp of when the configuration key was changed","format":"date-time","type":"string"},"type":{"description":"Action done on the config: add, update or delete","type":"string"}},"required":["id","key","type","timestamp"],"type":"object"},"Connection":{"example":{"active":true,"created":"","id":0,"id_connector":0,"id_user":0,"last_push":"2025-08-15T13:50:43.297Z","last_update":"2025-08-15T13:50:43.297Z","next_try":"2025-08-15T13:50:43.297Z"},"properties":{"active":{"default":true,"description":"This connection is active and will be automatically synced","type":"boolean"},"created":{"default":"","description":"Creation date","format":"date-time","type":"string"},"id":{"description":"ID of connection","type":"integer"},"id_connector":{"description":"ID of the related connector","type":"integer"},"id_user":{"description":"ID of the related user","type":"integer"},"last_push":{"description":"Last successful push","format":"date-time","type":"string"},"last_update":{"description":"Last successful update","format":"date-time","type":"string"},"next_try":{"description":"Date of next synchronization","format":"date-time","type":"string"}},"required":["id","id_connector","active"],"type":"object"},"ConnectionLog":{"example":{"error":"","error_message":"","error_uid":"","id":0,"id_connection":0,"id_connector":0,"id_source":0,"id_user":0,"login":"","nb_accounts":0,"next_try":"2025-08-15T13:50:43.297Z","session_folder_id":"","start":"2025-08-15T13:50:43.297Z","statut":0,"timestamp":"","worker":""},"properties":{"error":{"description":"If fail, contains the error code","type":"string"},"error_message":{"description":"If fail, error message received from connector","type":"string"},"error_uid":{"description":"MD5 hash of the exception backtrace","type":"string"},"fields":{"description":"Fields for connection in additionalInformationNeeded state with background option","type":"string"},"id":{"description":"ID of the log","type":"integer"},"id_connection":{"description":"ID of the connection","type":"integer"},"id_connector":{"description":"ID of the connector","type":"integer"},"id_source":{"description":"ID of the related connection source","type":"integer"},"id_user":{"description":"ID of the user","type":"integer"},"login":{"description":"bcrypt hash of the login","type":"string"},"nb_accounts":{"description":"In case of bank connection, number of accounts","type":"integer"},"next_try":{"description":"If fail, the date represents the next try to connect","format":"date-time","type":"string"},"session_folder_id":{"description":"Session folder uid","type":"string"},"start":{"description":"Timestamp when the synchronization has started","format":"date-time","type":"string"},"statut":{"description":"Status of user (1 = charged user)","type":"integer"},"timestamp":{"default":"","description":"Timestamp of log, when the synchronization has finished","format":"date-time","type":"string"},"worker":{"description":"Worker used to do synchronization","type":"string"}},"required":["id","id_connection","timestamp"],"type":"object"},"ConnectionSource":{"example":{"access_expire":"2025-08-15T13:50:43.297Z","created":"","disabled":"2025-08-15T13:50:43.297Z","expire":"2025-08-15T13:50:43.297Z","id":0,"id_connection":0,"id_connector_source":0,"last_update":"2025-08-15T13:50:43.297Z","name":"","next_try":"2025-08-15T13:50:43.297Z","state":""},"properties":{"access_expire":{"description":"Expiration date of the access","format":"date-time","type":"string"},"created":{"default":"","description":"Creation date of the connection source","format":"date-time","type":"string"},"disabled":{"description":"This source is not used to synchronize the connection","format":"date-time","type":"string"},"expire":{"description":"Expiration of the connection source. Used to purge the connection in case completion was not finished","format":"date-time","type":"string"},"id":{"description":"ID of connection","type":"integer"},"id_connection":{"description":"ID of the related connection","type":"integer"},"id_connector_source":{"description":"ID of the related connector source","type":"integer"},"last_update":{"description":"Last successful update","format":"date-time","type":"string"},"name":{"description":"Name of the connection source","type":"string"},"next_try":{"description":"Date of next synchronization","format":"date-time","type":"string"},"state":{"description":"If the last update has failed, the state code","type":"string"}},"required":["id","id_connection","id_connector_source","name","created"],"type":"object"},"Connector":{"example":{"auth_mechanism":"","beta":false,"charged":true,"code":"","color":"","hidden":false,"id":0,"months_to_fetch":0,"name":"","restricted":false,"siret":"","slug":"","sync_frequency":0,"uuid":""},"properties":{"auth_mechanism":{"description":"Authentication mechanism to use","type":"string"},"beta":{"default":false,"description":"If true, this connector is perhaps unstable :)","type":"boolean"},"charged":{"default":true,"description":"Usage of this connector is charged","type":"boolean"},"code":{"description":"Bank code","type":"string"},"color":{"description":"Main color of the bank or provider","type":"string"},"hidden":{"default":false,"description":"This connector is hidden from your users","type":"boolean"},"id":{"description":"ID of the connector","type":"integer"},"months_to_fetch":{"description":"How many months of history to fetch","type":"integer"},"name":{"description":"Name of the bank or provider","type":"string"},"restricted":{"default":false,"description":"If true, new connections cannot be added with this connector","type":"boolean"},"siret":{"description":"SIRET code for Bill modules","type":"string"},"slug":{"type":"string"},"sync_frequency":{"description":"How many days to wait between syncs","format":"float","type":"number"},"uuid":{"description":"Unique connector identifier","type":"string"}},"required":["id","name","charged","beta","uuid","restricted"],"type":"object"},"ConnectorCategory":{"example":{"id":0,"name":false},"properties":{"id":{"description":"ID of the bank category","type":"integer"},"name":{"default":false,"description":"Name of the category","type":"string"}},"required":["id","name"],"type":"object"},"ConnectorLogo":{"example":{"id":0,"id_connector":0,"id_file":0,"type":""},"properties":{"id":{"type":"integer"},"id_connector":{"description":"ID of the connector","type":"integer"},"id_file":{"description":"Id of the Bank/Provider Logo","type":"integer"},"type":{"description":"Logo's type","type":"string"}},"required":["id","id_connector","id_file"],"type":"object"},"ConnectorSource":{"example":{"auth_mechanism":"","disabled":"2025-08-15T13:50:43.299Z","disabled_capabilities":"","fallback":"","id":0,"id_connector":0,"id_weboob":"","name":"","priority":0},"properties":{"auth_mechanism":{"description":"Authentication mechanism to use","type":"string"},"disabled":{"description":"This source is not used to synchronize the connection","format":"date-time","type":"string"},"disabled_capabilities":{"description":"Comma separated list of capabilities disabled on this connector source","type":"string"},"fallback":{"description":"Name of the source this fallback is for","type":"string"},"id":{"description":"ID of the connector source","type":"integer"},"id_connector":{"description":"ID of the connector","type":"integer"},"id_weboob":{"type":"string"},"name":{"description":"Name of the source","type":"string"},"priority":{"description":"The source priority order for the synchronization","type":"integer"},"stability":{"description":"last known stability","type":"string"}},"required":["id","id_connector","name","id_weboob"],"type":"object"},"ConnectorSourceField":{"example":{"id_connector_source":0,"label":"","name":"","regex":"","required":true,"secret":true,"type":"text"},"properties":{"id_connector_source":{"description":"ID of the related connector source","type":"integer"},"label":{"description":"Label to display to user","type":"string"},"name":{"description":"Name of the config","type":"string"},"regex":{"description":"If set, the value must match this regexp","type":"string"},"required":{"default":true,"description":"If true, config has to be set to use this source","type":"boolean"},"secret":{"default":true,"description":"If true, value must be hidden on fronts","type":"boolean"},"type":{"default":"text","description":"Type of config","type":"string"}},"required":["id_connector_source","name","label"],"type":"object"},"Currency":{"example":{"crypto":false,"datetime":"2025-08-15T13:50:43.299Z","id":"","marketcap":0,"precision":2,"prefix":false,"symbol":""},"properties":{"crypto":{"default":false,"description":"It is a crypto currency or not","type":"boolean"},"datetime":{"description":"Time and date of Market Cap (for cryptos)","format":"date-time","type":"string"},"id":{"description":"ISO 4217 code used as ID","type":"string"},"marketcap":{"description":"Market Capitalization in EUR","format":"float","type":"number"},"precision":{"default":2,"description":"Numbers of significant digits","type":"integer"},"prefix":{"default":false,"description":"Amount is prefixed or not by the currency","type":"boolean"},"symbol":{"description":"Symbol representing the currency","type":"string"}},"required":["id","symbol","prefix"],"type":"object"},"Device":{"example":{"debug":false,"id":0,"id_token":0,"last_update":"","notification_token":"","type":"","version":""},"properties":{"debug":{"default":false,"type":"boolean"},"id":{"type":"integer"},"id_token":{"type":"integer"},"last_update":{"default":"","format":"date-time","type":"string"},"notification_token":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["id","id_token","type","notification_token","last_update","version","debug"],"type":"object"},"Document":{"example":{"currency":"","date":"2025-08-15T13:50:43.299Z","duedate":"2025-08-15T13:50:43.299Z","has_file_on_website":true,"id":0,"id_category":0,"id_file":0,"id_subscription":0,"id_thumbnail":0,"id_type":0,"id_user":0,"income":true,"issuer":"","last_update":"2025-08-15T13:50:43.299Z","name":"","number":"","readonly":true,"timestamp":"","total_amount":0,"untaxed_amount":0,"vat":0,"webid":""},"properties":{"currency":{"description":"Document currency","type":"object"},"date":{"format":"date-time","type":"string"},"duedate":{"format":"date","type":"string"},"has_file_on_website":{"default":true,"description":"Boolean to set if file is available on website","type":"boolean"},"id":{"type":"integer"},"id_category":{"type":"integer"},"id_file":{"type":"integer"},"id_subscription":{"type":"integer"},"id_thumbnail":{"type":"integer"},"id_type":{"type":"integer"},"id_user":{"type":"integer"},"income":{"default":true,"type":"boolean"},"issuer":{"type":"string"},"last_update":{"description":"Last successful update of the document","format":"date-time","type":"string"},"name":{"type":"string"},"number":{"type":"string"},"readonly":{"default":true,"type":"boolean"},"timestamp":{"default":"","format":"date-time","type":"string"},"total_amount":{"format":"float","type":"number"},"untaxed_amount":{"format":"float","type":"number"},"vat":{"format":"float","type":"number"},"webid":{"type":"string"}},"required":["id","id_user","timestamp","readonly","has_file_on_website"],"type":"object"},"DocumentType":{"example":{"attacheable":true,"id":0,"name":""},"properties":{"attacheable":{"default":true,"type":"boolean"},"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name","attacheable"],"type":"object"},"Field":{"example":{"auth_mechanisms":"","connector_sources":"","ephemeral":false,"id":0,"id_connector":0,"label":"","name":"","regex":"","required":true,"type":"text","value":""},"properties":{"auth_mechanisms":{"description":"Authentication mechanisms this field is used for","type":"string"},"connector_sources":{"description":"Sources this field is used for","type":"string"},"ephemeral":{"default":false,"description":"This field will not be saved in database","type":"boolean"},"id":{"description":"ID of the field","type":"integer"},"id_connector":{"description":"ID of the related connector","type":"integer"},"label":{"description":"Label to display to user","type":"string"},"name":{"description":"Name of the field","type":"string"},"regex":{"description":"If set, the value must match this regexp","type":"string"},"required":{"default":true,"description":"If true, field has to be set to synchronize the connection","type":"boolean"},"type":{"default":"text","description":"Type of field (text, password, list, hidden)","type":"string"},"value":{"description":"Default value of the field","type":"string"}},"required":["id_connector","id","name","label","required"],"type":"object"},"File":{"example":{"content_type":"","file_size":0,"filename":"","id":0},"properties":{"content_type":{"type":"string"},"file_size":{"type":"integer"},"filename":{"type":"string"},"id":{"type":"integer"}},"required":["id","content_type","filename","file_size"],"type":"object"},"Group":{"example":{"color":"","conf":"","email":"","id":0,"id_logo":0,"id_parent_group":0,"name":"","url":""},"properties":{"color":{"type":"string"},"conf":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"id_logo":{"type":"integer"},"id_parent_group":{"type":"integer"},"name":{"type":"string"},"url":{"type":"string"}},"required":["id"],"type":"object"},"HashTable":{"example":{"display":true,"income":false,"nature":"","wording":""},"properties":{"display":{"default":true,"type":"boolean"},"income":{"type":"boolean"},"nature":{"type":"string"},"wording":{"type":"string"}},"required":["wording","income","display","nature"],"type":"object"},"IdentityInfo":{"example":{"external_ref":"","id":0,"id_user":0,"identification":"","issuer":"","kind":"","scheme_name":""},"properties":{"external_ref":{"description":"Label associated with the beneficiary account","type":"string"},"id":{"type":"integer"},"id_user":{"description":"ID of a related user","type":"integer"},"identification":{"description":"Identification number","type":"string"},"issuer":{"description":"issuer of the identification","type":"string"},"kind":{"description":"Kind of the entity","type":"string"},"scheme_name":{"description":"Identification number type","type":"string"}},"required":["id"],"type":"object"},"Investment":{"example":{"code":"","code_type":"","deleted":"2025-08-15T13:50:43.299Z","description":"","diff":0,"diff_percent":0,"id":0,"id_account":0,"id_security":0,"label":"","last_update":"2025-08-15T13:50:43.299Z","original_currency":"","original_diff":0,"original_unitprice":0,"original_unitvalue":0,"original_valuation":0,"portfolio_share":0,"prev_diff":0,"prev_vdate":"2025-08-15T13:50:43.299Z","quantity":0,"source":"","unitprice":0,"unitvalue":0,"valuation":0,"vdate":"2025-08-15T13:50:43.299Z"},"properties":{"code":{"description":"Investment code","type":"string"},"code_type":{"description":"Code type (ISIN of AMF)","type":"string"},"deleted":{"description":"If set, this investment has been removed from the website","format":"date-time","type":"string"},"description":{"description":"Description of the investment","type":"string"},"diff":{"default":0,"description":"Capital gain","format":"float","type":"number"},"diff_percent":{"description":"Capital gain in percent (between 0 and 1)","format":"float","type":"number"},"id":{"description":"ID of the investment","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_security":{"description":"ID of the related security","type":"integer"},"label":{"description":"Label of the investment","type":"string"},"last_update":{"description":"Last update of the investment","format":"date-time","type":"string"},"original_currency":{"description":"Original currency","type":"object"},"original_diff":{"description":"Capital gain in the original currency","format":"float","type":"number"},"original_unitprice":{"description":"Current unit value in the original currency","format":"float","type":"number"},"original_unitvalue":{"description":"Average buy price in the original currency","format":"float","type":"number"},"original_valuation":{"description":"Valuation in original currency","format":"float","type":"number"},"portfolio_share":{"description":"Percent of the portfolio","format":"float","type":"number"},"prev_diff":{"description":"Capital gain from previous value","format":"float","type":"number"},"prev_vdate":{"description":"Value date of the previous value (prev_diff)","format":"date","type":"string"},"quantity":{"default":0,"description":"Quantity","format":"float","type":"number"},"source":{"description":"Source of the ISIN code (website, notFound)","type":"string"},"unitprice":{"default":0,"description":"Average buy price","format":"float","type":"number"},"unitvalue":{"default":0,"description":"Current unit value","format":"float","type":"number"},"valuation":{"default":0,"description":"Current valuation","format":"float","type":"number"},"vdate":{"description":"Value date","format":"date","type":"string"}},"required":["id","id_account","label","code"],"type":"object"},"InvestmentValue":{"example":{"id":0,"id_investment":0,"original_currency":"","original_unitvalue":0,"unitvalue":0,"vdate":"2025-08-15T13:50:43.299Z"},"properties":{"id":{"description":"ID of the value","type":"integer"},"id_investment":{"description":"ID of the related investment","type":"integer"},"original_currency":{"description":"Original currency","type":"object"},"original_unitvalue":{"description":"Value on this date, in the original currency","format":"float","type":"number"},"unitvalue":{"description":"Value on this date","format":"float","type":"number"},"vdate":{"description":"Date of this value","format":"date","type":"string"}},"required":["id","id_investment","vdate","unitvalue"],"type":"object"},"Keyword":{"example":{"id":0,"id_category":0,"income":false,"keyword":"","priority":0},"properties":{"id":{"type":"integer"},"id_category":{"type":"integer"},"income":{"type":"boolean"},"keyword":{"type":"string"},"priority":{"type":"integer"}},"required":["id","keyword","id_category","priority","income"],"type":"object"},"LockedUser":{"example":{"id_user":0,"timestamp":"","worker":""},"properties":{"id_user":{"type":"integer"},"timestamp":{"default":"","format":"date-time","type":"string"},"worker":{"type":"string"}},"required":["id_user","timestamp"],"type":"object"},"MarketOrder":{"example":{"amount":0,"code":"","created":"2025-08-15T13:50:43.299Z","date":"2025-08-15T13:50:43.299Z","deleted":"2025-08-15T13:50:43.299Z","execution_date":"2025-08-15T13:50:43.299Z","id":0,"id_account":0,"label":"","last_update":"2025-08-15T13:50:43.299Z","ordervalue":0,"payment_method":"","quantity":0,"state":"","stock_market":"","unitprice":0,"unitvalue":0,"validity_date":"2025-08-15T13:50:43.299Z","webid":""},"properties":{"amount":{"default":0,"description":"Total amount of the market order","format":"float","type":"number"},"code":{"description":"ISIN code of the investment associated with the market order","type":"string"},"created":{"description":"Insertion date of the market order in bi_market_order","format":"date-time","type":"string"},"date":{"description":"Creation date of the market order","format":"date","type":"string"},"deleted":{"description":"If set, this market order has been removed from the website","format":"date-time","type":"string"},"execution_date":{"description":"Execution date of the market order","format":"date","type":"string"},"id":{"description":"ID of the market order","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"label":{"description":"Label of the investment associated with the market order","type":"string"},"last_update":{"description":"Last update of the market order","format":"date-time","type":"string"},"ordervalue":{"default":0,"description":"Limit value or trigger value, only relevant if the order type is LIMIT or TRIGGER","format":"float","type":"number"},"payment_method":{"description":"Payment method for the market order (usually 'SRD' or 'Comptant')","type":"string"},"quantity":{"default":0,"description":"Quantity of stock shares in the market order","format":"float","type":"number"},"state":{"description":"Current state of the market order","type":"string"},"stock_market":{"description":"Stock market on which the order was executed","type":"string"},"unitprice":{"default":0,"description":"Value of the stock at the moment of the market order","format":"float","type":"number"},"unitvalue":{"default":0,"description":"Current value of the stock associated with the market order","format":"float","type":"number"},"validity_date":{"description":"Validity date of the market order","format":"date","type":"string"},"webid":{"description":"Weboob ID of the market order","type":"string"}},"required":["id","id_account","label","created"],"type":"object"},"OidcWhitelist":{"example":{"id":0,"redirect_uri":""},"properties":{"id":{"type":"integer"},"redirect_uri":{"description":"authorized redirect uri","type":"string"}},"required":["id","redirect_uri"],"type":"object"},"Payment":{"example":{"client_redirect_uri":"","error_code":"","error_description":"","id":0,"register_date":"2025-08-15T13:50:43.299Z","state":"","validate_uri":""},"properties":{"client_redirect_uri":{"description":"URL to redirecting to client","type":"string"},"error_code":{"description":"In case of error, the error code","type":"string"},"error_description":{"description":"Error message","type":"string"},"id":{"type":"integer"},"register_date":{"description":"Date of payment registration","format":"date-time","type":"string"},"state":{"description":"State of the payment","type":"string"},"validate_uri":{"description":"URL to validate payment","type":"string"}},"required":["id"],"type":"object"},"PaymentAccount":{"example":{"disabled_date":"2025-08-15T13:50:43.299Z","id":0,"id_account":0,"identification":"","issuer":"","label":"","scheme_name":""},"properties":{"disabled_date":{"description":"Date at which the entry was disabled","format":"date-time","type":"string"},"id":{"type":"integer"},"id_account":{"description":"ID of a related account","type":"integer"},"identification":{"description":"Account identification number","type":"string"},"issuer":{"description":"Issuer or bic associated with the account","type":"string"},"label":{"description":"Label associated with the beneficiary account","type":"string"},"scheme_name":{"description":"Account number type","type":"string"}},"required":["id"],"type":"object"},"PaymentLog":{"example":{"error_code":"","error_description":"","id":0,"id_file":0,"id_payment":0,"state":"","timestamp":""},"properties":{"error_code":{"description":"In case of error, the error code","type":"string"},"error_description":{"description":"Error message","type":"string"},"id":{"type":"integer"},"id_file":{"description":"ID of the related payment file","type":"integer"},"id_payment":{"description":"ID of the related payment","type":"integer"},"state":{"description":"State of the payment","type":"string"},"timestamp":{"default":"","description":"Timestamp of the log","format":"date-time","type":"string"}},"required":["id","timestamp"],"type":"object"},"Pocket":{"example":{"availability_date":"2025-08-15T13:50:43.299Z","condition":"inconnu","deleted":"2025-08-15T13:50:43.299Z","id":0,"id_account":0,"id_investment":0,"label":"","last_update":"2025-08-15T13:50:43.299Z","quantity":0,"value":0},"properties":{"availability_date":{"description":"Availability date of the pocket","format":"date","type":"string"},"condition":{"default":"inconnu","description":"Withdrawal condition of the pocket","type":"string"},"deleted":{"description":"If set, this pocket has been removed from the website","format":"date-time","type":"string"},"id":{"description":"ID of the pocket","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_investment":{"description":"ID of the related investment","type":"integer"},"label":{"description":"Label of the pocket","type":"string"},"last_update":{"description":"Last update of the pocket","format":"date-time","type":"string"},"quantity":{"default":0,"description":"Quantity of stocks","format":"float","type":"number"},"value":{"description":"Value of the pocket","format":"float","type":"number"}},"required":["id","id_account","id_investment","value","condition"],"type":"object"},"Profile":{"example":{"admin":false,"conf":"","id":0,"id_user":0,"lang":"","role":"admin","statut":0},"properties":{"admin":{"default":false,"type":"boolean"},"conf":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"id_user":{"type":"integer"},"lang":{"type":"string"},"role":{"default":"admin","enum":["admin","ser"],"type":"string"},"statut":{"default":0,"type":"integer"}},"required":["id","id_user","role","email","statut","admin"],"type":"object"},"Psd2Registration":{"example":{"id":0,"id_connector_source":0,"status":""},"properties":{"id":{"type":"integer"},"id_connector_source":{"description":"ID of the connector source","type":"integer"},"status":{"description":"Current status: created/updated/error","type":"string"}},"required":["id","status"],"type":"object"},"Psd2RegistrationLog":{"description":"Keep traces of PSD2 registration calls.\n The table is used by the plugin `psd2registration` to know:\n - whether it must call `update` or `create` routes on the PSD2 APIs when the config is updated\n - the list of PSD2 API to create (needed when a new connector is added)\n - the list of broken connectors","example":{"created_at":"2025-08-15T13:50:43.299Z","error_message":"","id":0,"id_psd2registration":0,"type":""},"properties":{"created_at":{"description":"When this row was created","format":"date-time","type":"string"},"error_message":{"description":"If fail, error message received from connector","type":"string"},"id":{"type":"integer"},"id_psd2registration":{"description":"ID of the psd2 registration","type":"integer"},"type":{"description":"Action done: create, update, delete","type":"string"}},"required":["id","created_at","type"],"type":"object"},"Recipient":{"example":{"add_verified":false,"bank_name":"","category":"","currency":"","deleted":"2025-08-15T13:50:43.299Z","enabled_at":"2025-08-15T13:50:43.299Z","error":"","expire":"2025-08-15T13:50:43.299Z","iban":"","id":0,"id_account":0,"id_target_account":0,"label":"","last_update":"2025-08-15T13:50:43.299Z","state":"","time_scraped":"2025-08-15T13:50:43.299Z","webid":""},"properties":{"add_verified":{"description":"Was the recipient adding authorized","type":"boolean"},"bank_name":{"description":"Bank of the recipient","type":"string"},"category":{"description":"Category in which the recipient is","type":"string"},"currency":{"description":"Currency of the object","type":"object"},"deleted":{"description":"The recipient isn't found anymore on the bank","format":"date-time","type":"string"},"enabled_at":{"description":"It will be possible to do transfers to this recipient at this date","format":"date-time","type":"string"},"error":{"description":"Error message","type":"string"},"expire":{"format":"date-time","type":"string"},"fields":{"description":"Fields for recipient with additionalInformationNeeded state","type":"string"},"iban":{"description":"IBAN of the recipient","type":"string"},"id":{"description":"ID of the recipient","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_target_account":{"description":"ID of the target account, in case of internal recipient","type":"integer"},"label":{"description":"Label of the recipient","type":"string"},"last_update":{"description":"Last time we have fetched this recipient","format":"date-time","type":"string"},"state":{"description":"State of recipient","type":"string"},"time_scraped":{"description":"First time we've seen this recipient","format":"date-time","type":"string"},"webid":{"description":"Webid of the recipient","type":"string"}},"required":["id","id_account","label","category","last_update"],"type":"object"},"RecipientLog":{"example":{"error":"","id":0,"id_file":0,"id_recipient":0,"request_data":"","step":"","timestamp":""},"properties":{"error":{"description":"Error message during recipient addition, if any","type":"string"},"fields":{"description":"Fields for recipient in additionalInformationNeeded state with background option","type":"string"},"id":{"description":"ID of the transfer log entry","type":"integer"},"id_file":{"description":"ID of the related file","type":"integer"},"id_recipient":{"description":"ID of the related recipient","type":"integer"},"request_data":{"description":"Data stored related to user who has requested the recipient addition","type":"string"},"step":{"description":"Step of recipient addition, (add_recipient, asking_field, recipient addition validated, creation, storing_files)","type":"string"},"timestamp":{"default":"","description":"Timestamp of the log","format":"date-time","type":"string"}},"required":["id","timestamp"],"type":"object"},"Security":{"example":{"code":"","id":0,"id_type":0,"last_update":"2025-08-15T13:50:43.299Z","name":""},"properties":{"code":{"description":"ISIN code of the security","type":"string"},"id":{"description":"ID of the security","type":"integer"},"id_type":{"description":"ID of the security type","type":"integer"},"last_update":{"description":"Last update of the security","format":"date-time","type":"string"},"name":{"description":"Name of the security","type":"string"}},"required":["id","name"],"type":"object"},"Subscription":{"example":{"deleted":"2025-08-15T13:50:43.299Z","disabled":"2025-08-15T13:50:43.299Z","error":"","id":0,"id_connection":0,"id_source":0,"id_user":0,"label":"","last_update":"2025-08-15T13:50:43.299Z","number":"","renewdate":"2025-08-15T13:50:43.299Z","subscriber":"","validity":"2025-08-15T13:50:43.299Z"},"properties":{"deleted":{"description":"This subscription is not found on the website anymore","format":"date-time","type":"string"},"disabled":{"description":"This subscription has been deleted by user and will not be synchronized anymore","format":"date-time","type":"string"},"error":{"description":"If the last update has failed, the error code","type":"string"},"id":{"description":"ID of subscription","type":"integer"},"id_connection":{"description":"ID of related connection","type":"integer"},"id_source":{"description":"ID of the related connection source","type":"integer"},"id_user":{"description":"ID of related user","type":"integer"},"label":{"description":"Label of the subscription","type":"string"},"last_update":{"description":"Last successful update of the subscription","format":"date-time","type":"string"},"number":{"description":"Subscription's number","type":"string"},"renewdate":{"description":"Next renew date, if any","format":"date","type":"string"},"subscriber":{"description":"Name of the subscriber","type":"string"},"validity":{"description":"The subscription is valid until this date, if any","format":"date","type":"string"}},"required":["id","number","label"],"type":"object"},"SubscriptionLog":{"example":{"error":"","error_message":"","id":0,"id_connection_log":0,"id_source":0,"id_subscription":0,"nb_docs":0,"timestamp":""},"properties":{"error":{"description":"If fail, contains the error code","type":"string"},"error_message":{"description":"If fail, error message received from provider","type":"string"},"id":{"description":"ID of the log","type":"integer"},"id_connection_log":{"description":"ID of the related connection log","type":"integer"},"id_source":{"description":"ID of the related connection source","type":"integer"},"id_subscription":{"description":"ID of the related subscription","type":"integer"},"nb_docs":{"description":"Number of docs on the subscription","type":"integer"},"timestamp":{"default":"","description":"Timestamp of log","format":"date-time","type":"string"}},"required":["id","id_subscription","timestamp"],"type":"object"},"TermsOfService":{"example":{"created":"2025-08-15T13:50:43.299Z","deleted":"2025-08-15T13:50:43.299Z","id":0,"version":""},"properties":{"created":{"format":"date-time","type":"string"},"deleted":{"format":"date-time","type":"string"},"id":{"type":"integer"},"version":{"type":"string"}},"required":["id","version","created"],"type":"object"},"Transaction":{"example":{"active":true,"application_date":"2025-08-15T13:50:43.299Z","bdate":"2025-08-15T13:50:43.299Z","bdatetime":"2025-08-15T13:50:43.299Z","card":"","coming":false,"comment":"","commission":0,"commission_currency":"","counterparty":"","country":"","date":"2025-08-15T13:50:43.299Z","date_scraped":"2025-08-15T13:50:43.299Z","datetime":"2025-08-15T13:50:43.299Z","deleted":"2025-08-15T13:50:43.299Z","gross_value":0,"id":0,"id_account":0,"id_category":0,"id_cluster":0,"last_update":"2025-08-15T13:50:43.299Z","nature":"inconnu","original_currency":"","original_gross_value":0,"original_value":0,"rdate":"2025-08-15T13:50:43.299Z","rdatetime":"2025-08-15T13:50:43.299Z","state":"new","value":0,"vdate":"2025-08-15T13:50:43.299Z","vdatetime":"2025-08-15T13:50:43.299Z","webid":"","wording":""},"properties":{"active":{"default":true,"description":"If false, PFM services will ignore this transaction","type":"boolean"},"application_date":{"description":"Date considered by PFM services. It is used to change the month of a transaction, for example.","format":"date","type":"string"},"bdate":{"description":"Date used by the bank for the transaction","format":"date","type":"string"},"bdatetime":{"description":"Datetime used by the bank","format":"date-time","type":"string"},"card":{"description":"Card number associated to the transaction","type":"string"},"coming":{"description":"If true, this transaction hasn't been yet debited","type":"boolean"},"comment":{"description":"User comment","type":"string"},"commission":{"description":"Commission taken on the transaction","format":"float","type":"number"},"commission_currency":{"description":"Commission currency","type":"object"},"counterparty":{"description":"Counterparty","type":"string"},"country":{"description":"Original country","type":"string"},"date":{"description":"Debit date","format":"date","type":"string"},"date_scraped":{"description":"Date when the transaction has been seen","format":"date-time","type":"string"},"datetime":{"description":"Datetime of the debit of the transaction","format":"date-time","type":"string"},"deleted":{"description":"If set, this transaction has been removed from the bank","format":"date-time","type":"string"},"gross_value":{"description":"Gross value of the transaction","format":"float","type":"number"},"id":{"description":"ID of the transaction","type":"integer"},"id_account":{"description":"ID of the related account","type":"integer"},"id_category":{"description":"ID of the related category","type":"integer"},"id_cluster":{"description":"If the transaction is part of a cluster","type":"integer"},"last_update":{"description":"Last update of the transaction","format":"date-time","type":"string"},"nature":{"default":"inconnu","description":"Type of transaction","type":"string"},"original_currency":{"description":"Original currency","type":"object"},"original_gross_value":{"description":"Gross value in the original currency","format":"float","type":"number"},"original_value":{"description":"Value in the original currency","format":"float","type":"number"},"original_wording":{"description":"Full label of the transaction","type":"string"},"rdate":{"description":"Realization of the transaction","format":"date","type":"string"},"rdatetime":{"description":"Datetime of the realization of the transaction","format":"date-time","type":"string"},"simplified_wording":{"description":"Simplified label of the transaction","type":"string"},"state":{"default":"new","description":"Internal state of the transaction","type":"string"},"stemmed_wording":{"description":"Do not use it","type":"string"},"value":{"description":"Value of the transaction","format":"float","type":"number"},"vdate":{"description":"Value date of the transaction","format":"date","type":"string"},"vdatetime":{"description":"Datetime of the Value of the transaction","format":"date-time","type":"string"},"webid":{"description":"Webid of the transaction","type":"string"},"wording":{"description":"Label set by the user","type":"string"}},"required":["id","id_account","date","nature","original_wording","simplified_wording","stemmed_wording","state","date_scraped","rdate","coming","active"],"type":"object"},"TransactionInformation":{"example":{"id":0,"id_transaction":0,"key":"","value":""},"properties":{"id":{"description":"ID of this transaction information","type":"integer"},"id_transaction":{"description":"ID of the related transaction","type":"integer"},"key":{"description":"Key of the transaction information","type":"string"},"value":{"description":"Value of the transaction information","type":"string"}},"required":["id","id_transaction","key"],"type":"object"},"TransactionsCluster":{"example":{"created_by":"","enabled":true,"id":0,"id_account":0,"id_category":0,"mean_amount":0,"median_increment":0,"next_date":"2025-08-15T13:50:43.300Z","wording":""},"properties":{"created_by":{"type":"string"},"enabled":{"default":true,"type":"boolean"},"id":{"type":"integer"},"id_account":{"type":"integer"},"id_category":{"type":"integer"},"mean_amount":{"format":"float","type":"number"},"median_increment":{"type":"integer"},"next_date":{"format":"date","type":"string"},"wording":{"type":"string"}},"required":["id","id_account","mean_amount","enabled","wording"],"type":"object"},"Transfer":{"description":"This is a representation of a transfer.","example":{"account_balance":0,"account_iban":"","amount":0,"beneficiary_label":"","beneficiary_number":"","beneficiary_type":"recipient","currency":"","error":"","exec_date":"2025-08-15T13:50:43.300Z","fees":0,"id":0,"id_account":0,"id_recipient":0,"id_transaction":0,"id_user":0,"label":"","recipient_iban":"","register_date":"2025-08-15T13:50:43.300Z","state":"","validate_mechanism":"","webid":""},"properties":{"account_balance":{"description":"Balance of the account just before the transfer","format":"float","type":"number"},"account_iban":{"description":"IBAN of the debited account","type":"string"},"amount":{"description":"Amount of the transfer","format":"float","type":"number"},"beneficiary_label":{"description":"Label of the beneficiary (needed for transfer to other beneficiary type than 'recipient')","type":"string"},"beneficiary_number":{"description":"Beneficiary bank identifier value like recipient webid, iban: EX6713281847025300290000062 or phone_number: 06XXXXXX","type":"string"},"beneficiary_type":{"default":"recipient","description":"Type of beneficiary number, for example: 'recipient' (in bank recipient list), 'iban' or 'phone_number'","type":"string"},"currency":{"description":"Currency of the object","type":"object"},"error":{"description":"Error message during transfer, if any","type":"string"},"exec_date":{"description":"Date when the transfer will be operated by the bank","format":"date","type":"string"},"fees":{"description":"Fees taken by the bank","format":"float","type":"number"},"id":{"description":"ID of transfer","type":"integer"},"id_account":{"description":"ID of the debited account","type":"integer"},"id_recipient":{"description":"ID of the recipient","type":"integer"},"id_transaction":{"description":"If found, ID of the related transaction","type":"integer"},"id_user":{"description":"ID of the related user","type":"integer"},"label":{"description":"Label of the transfer","type":"string"},"recipient_iban":{"description":"IBAN of the recipient in bank recipient list","type":"string"},"register_date":{"description":"Date when the transfer has been registered","format":"date-time","type":"string"},"state":{"description":"State of the transfer (created, scheduled, validating, pending, coming, done, canceled, transactionNotFound, deleted, error, bug)","type":"string"},"validate_mechanism":{"description":"Authentication method used to validate transfer (credentials or webauth)","type":"string"},"webid":{"description":"WebID of the transfer","type":"string"}},"required":["id","exec_date","register_date","amount","state","beneficiary_type"],"type":"object"},"TransferLog":{"example":{"error":"","id":0,"id_file":0,"id_transfer":0,"request_data":"","state":"","timestamp":""},"properties":{"error":{"description":"Error message during transfer, if any","type":"string"},"fields":{"description":"Fields for transfer in additionalInformationNeeded state with background option","type":"string"},"id":{"description":"ID of the transfer log entry","type":"integer"},"id_file":{"description":"ID of the related file","type":"integer"},"id_transfer":{"description":"ID of the related transfer","type":"integer"},"request_data":{"description":"Data stored related to user who has requested the transfer","type":"string"},"state":{"description":"State of the transfer (created, scheduled, validating, pending, done, canceled, error, bug)","type":"string"},"timestamp":{"default":"","description":"Timestamp of the log","format":"date-time","type":"string"}},"required":["id","timestamp"],"type":"object"},"User":{"example":{"id":0,"platform":"","signin":""},"properties":{"id":{"type":"integer"},"platform":{"enum":["web","iPad","iPhone","Android","CAstore","requestAccess","sharedAccess","singleAccess","transfer","refresh_token"],"type":"string"},"signin":{"default":"","format":"date-time","type":"string"}},"required":["id","signin","platform"],"type":"object"},"UserAlert":{"description":"/!\\ Careful we use default value from database if present\n\n For more information see AlertsPlugin.init","example":{"apply":"","balance_max":10000,"balance_min1":500,"balance_min2":0,"date_range":0,"enabled":true,"expense_max":500,"id":0,"income_max":500,"resume_enabled":true,"resume_frequency":7,"transaction_types":"","type":"transactions","value_type":"flat"},"properties":{"apply":{"type":"string"},"balance_max":{"default":10000,"format":"float","type":"number"},"balance_min1":{"default":500,"format":"float","type":"number"},"balance_min2":{"default":0,"format":"float","type":"number"},"date_range":{"type":"integer"},"enabled":{"default":true,"type":"boolean"},"expense_max":{"default":500,"format":"float","type":"number"},"id":{"type":"integer"},"income_max":{"default":500,"format":"float","type":"number"},"resume_enabled":{"default":true,"type":"boolean"},"resume_frequency":{"default":7,"type":"integer"},"transaction_types":{"type":"string"},"type":{"default":"transactions","type":"string"},"value_type":{"default":"flat","type":"string"}},"required":["id","value_type","type","resume_frequency"],"type":"object"},"Webhook":{"example":{"created":"2025-08-15T13:50:43.300Z","deleted":"2025-08-15T13:50:43.300Z","id":0,"id_auth":0,"id_event":0,"id_service":0,"id_user":0,"updated":"2025-08-15T13:50:43.300Z","url":""},"properties":{"add_to_data":{"description":"json value to describe data to add","type":"string"},"created":{"description":"Date of the webhook creation","format":"date-time","type":"string"},"deleted":{"description":"Date of the webhook deletion","format":"date-time","type":"string"},"flush_fail":{"description":"json value to store last related webhook data flushing fail","type":"string"},"id":{"description":"ID of the webhook","type":"integer"},"id_auth":{"description":"ID of the authentication process","type":"integer"},"id_event":{"description":"ID of the webhook event","type":"integer"},"id_service":{"description":"ID of the service","type":"integer"},"id_user":{"description":"ID of the emitter user","type":"integer"},"updated":{"description":"Date of the webhook last update","format":"date-time","type":"string"},"url":{"description":"URL of the webhook","type":"string"}},"required":["id","created","updated"],"type":"object"},"WebhookData":{"example":{"created":"2025-08-15T13:50:43.300Z","id":0,"id_resource":0,"id_service":0,"id_user":0,"id_webhook":0,"mimetype":"","success":"2025-08-15T13:50:43.300Z"},"properties":{"created":{"description":"Timestamp when the hook data was generated","format":"date-time","type":"string"},"data":{"description":"Data emitted","type":"string"},"id":{"description":"ID of the webhook data","type":"integer"},"id_resource":{"description":"a changing ID used to filter webhookdata depending on the event triggered","type":"integer"},"id_service":{"description":"ID of the recipient service","type":"integer"},"id_user":{"description":"ID of the emitter user","type":"integer"},"id_webhook":{"description":"ID of the webhook","type":"integer"},"mimetype":{"description":"Mimetype of the data","type":"string"},"success":{"description":"Timestamp when the hook has been successfully called","format":"date-time","type":"string"}},"required":["id","created"],"type":"object"},"WebhookLog":{"example":{"id":0,"id_service":0,"id_user":0,"id_webhook_data":0,"next_try":"2025-08-15T13:50:43.300Z","response_code":0,"response_date":"2025-08-15T13:50:43.300Z","timestamp":"2025-08-15T13:50:43.300Z"},"properties":{"id":{"description":"ID of the log","type":"integer"},"id_service":{"description":"ID of the service","type":"integer"},"id_user":{"description":"ID of the user","type":"integer"},"id_webhook_data":{"description":"ID of the webhook data","type":"integer"},"next_try":{"description":"If the log is an error, do not retry to push before this timestamp","format":"date-time","type":"string"},"response_code":{"description":"Return code of the reply to the hook","type":"integer"},"response_date":{"description":"Timestamp of the reply to the hook","format":"date-time","type":"string"},"timestamp":{"description":"Timestamp when the hook was sent","format":"date-time","type":"string"}},"required":["id","timestamp"],"type":"object"}}},"x-deactivated_services":[],"x-query-services":["administration","authentication","banks","connections","documents","oidc","payments","pfm","providers","recipients","service","terms","timeline","transfer","transfers","usersmanagement","wealth"]}