belvo.resources.recurring_expenses

View Source

 1from typing import Dict, List, Union
 2
 3from belvo.resources.base import Resource
 4
 5
 6class RecurringExpenses(Resource):
 7    endpoint = "/api/recurring-expenses/"
 8
 9    def create(
10        self,
11        link: str,
12        *,
13        token: str = None,
14        save_data: bool = True,
15        raise_exception: bool = False,
16        **kwargs: Dict,
17    ) -> Union[List[Dict], Dict]:
18        """Retrieve recurring expenses for a link
19
20        Retrieve recurring expense insights for checking and savings accounts from a specific link. You can receive insights for a period of up to 365 days, depending on the transaction history available for each bank.
21
22        Example:
23            ```python
24            # Fetch recurring expenses for a Link
25            recurring_expenses = client.RecurringExpenses.create("44d309dc-24c6-4734-99e0-22c595fee2c2")
26
27            # Fetch recurring expenses for a Link with and timeout after 15 seconds
28            recurring_expenses = client.RecurringExpenses.create(
29                "44d309dc-24c6-4734-99e0-22c595fee2c2",
30                timeout=15
31            )
32            ```
33
34        Args:
35            link (str): The `link.id` that you want to get information for (UUID).
36            token (str, optional): The MFA token generated by the bank in order to access the institution. Defaults to None.
37            save_data (bool, optional): Indicates whether or not to persist the data in Belvo. Defaults to `True`.
38            raise_exception (bool, optional): Indicates whether to raise an exception or return the API error. Defaults to `False`.
39
40        Returns:
41            Dict: The details of the object. For more information on the response from the API, see our [Recurring expenses API documentation](https://developers.belvo.com/reference/retrieverecurringexpenses).
42        """
43
44        data = {"link": link, "save_data": save_data}
45
46        if token:
47            data.update(token=token)
48
49        return self.session.post(
50            self.endpoint, data=data, raise_exception=raise_exception, **kwargs
51        )

class RecurringExpenses(belvo.resources.base.Resource): View Source

 7class RecurringExpenses(Resource):
 8    endpoint = "/api/recurring-expenses/"
 9
10    def create(
11        self,
12        link: str,
13        *,
14        token: str = None,
15        save_data: bool = True,
16        raise_exception: bool = False,
17        **kwargs: Dict,
18    ) -> Union[List[Dict], Dict]:
19        """Retrieve recurring expenses for a link
20
21        Retrieve recurring expense insights for checking and savings accounts from a specific link. You can receive insights for a period of up to 365 days, depending on the transaction history available for each bank.
22
23        Example:
24            ```python
25            # Fetch recurring expenses for a Link
26            recurring_expenses = client.RecurringExpenses.create("44d309dc-24c6-4734-99e0-22c595fee2c2")
27
28            # Fetch recurring expenses for a Link with and timeout after 15 seconds
29            recurring_expenses = client.RecurringExpenses.create(
30                "44d309dc-24c6-4734-99e0-22c595fee2c2",
31                timeout=15
32            )
33            ```
34
35        Args:
36            link (str): The `link.id` that you want to get information for (UUID).
37            token (str, optional): The MFA token generated by the bank in order to access the institution. Defaults to None.
38            save_data (bool, optional): Indicates whether or not to persist the data in Belvo. Defaults to `True`.
39            raise_exception (bool, optional): Indicates whether to raise an exception or return the API error. Defaults to `False`.
40
41        Returns:
42            Dict: The details of the object. For more information on the response from the API, see our [Recurring expenses API documentation](https://developers.belvo.com/reference/retrieverecurringexpenses).
43        """
44
45        data = {"link": link, "save_data": save_data}
46
47        if token:
48            data.update(token=token)
49
50        return self.session.post(
51            self.endpoint, data=data, raise_exception=raise_exception, **kwargs
52        )

endpoint = '/api/recurring-expenses/'

def create( self, link: str, *, token: str = None, save_data: bool = True, raise_exception: bool = False, **kwargs: Dict) -> Union[List[Dict], Dict]: View Source

10    def create(
11        self,
12        link: str,
13        *,
14        token: str = None,
15        save_data: bool = True,
16        raise_exception: bool = False,
17        **kwargs: Dict,
18    ) -> Union[List[Dict], Dict]:
19        """Retrieve recurring expenses for a link
20
21        Retrieve recurring expense insights for checking and savings accounts from a specific link. You can receive insights for a period of up to 365 days, depending on the transaction history available for each bank.
22
23        Example:
24            ```python
25            # Fetch recurring expenses for a Link
26            recurring_expenses = client.RecurringExpenses.create("44d309dc-24c6-4734-99e0-22c595fee2c2")
27
28            # Fetch recurring expenses for a Link with and timeout after 15 seconds
29            recurring_expenses = client.RecurringExpenses.create(
30                "44d309dc-24c6-4734-99e0-22c595fee2c2",
31                timeout=15
32            )
33            ```
34
35        Args:
36            link (str): The `link.id` that you want to get information for (UUID).
37            token (str, optional): The MFA token generated by the bank in order to access the institution. Defaults to None.
38            save_data (bool, optional): Indicates whether or not to persist the data in Belvo. Defaults to `True`.
39            raise_exception (bool, optional): Indicates whether to raise an exception or return the API error. Defaults to `False`.
40
41        Returns:
42            Dict: The details of the object. For more information on the response from the API, see our [Recurring expenses API documentation](https://developers.belvo.com/reference/retrieverecurringexpenses).
43        """
44
45        data = {"link": link, "save_data": save_data}
46
47        if token:
48            data.update(token=token)
49
50        return self.session.post(
51            self.endpoint, data=data, raise_exception=raise_exception, **kwargs
52        )

Retrieve recurring expenses for a link

Retrieve recurring expense insights for checking and savings accounts from a specific link. You can receive insights for a period of up to 365 days, depending on the transaction history available for each bank.

Example:

# Fetch recurring expenses for a Link
recurring_expenses = client.RecurringExpenses.create("44d309dc-24c6-4734-99e0-22c595fee2c2")

# Fetch recurring expenses for a Link with and timeout after 15 seconds
recurring_expenses = client.RecurringExpenses.create(
    "44d309dc-24c6-4734-99e0-22c595fee2c2",
    timeout=15
)

Arguments:

link (str): The link.id that you want to get information for (UUID).
token (str, optional): The MFA token generated by the bank in order to access the institution. Defaults to None.
save_data (bool, optional): Indicates whether or not to persist the data in Belvo. Defaults to True.
raise_exception (bool, optional): Indicates whether to raise an exception or return the API error. Defaults to False.

Returns:

Dict: The details of the object. For more information on the response from the API, see our Recurring expenses API documentation.

Inherited Members

belvo.resources.base.Resource: Resource; session; list; get; delete; resume