lunchmoney-python 2.10.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. lunchmoney_python-2.10.0/PKG-INFO +285 -0
  2. lunchmoney_python-2.10.0/README.md +267 -0
  3. lunchmoney_python-2.10.0/lunchmoney/__init__.py +205 -0
  4. lunchmoney_python-2.10.0/lunchmoney/api/__init__.py +16 -0
  5. lunchmoney_python-2.10.0/lunchmoney/api/categories_api.py +1499 -0
  6. lunchmoney_python-2.10.0/lunchmoney/api/manual_accounts_api.py +1479 -0
  7. lunchmoney_python-2.10.0/lunchmoney/api/me_api.py +293 -0
  8. lunchmoney_python-2.10.0/lunchmoney/api/plaid_accounts_api.py +909 -0
  9. lunchmoney_python-2.10.0/lunchmoney/api/recurring_items_api.py +702 -0
  10. lunchmoney_python-2.10.0/lunchmoney/api/summary_api.py +434 -0
  11. lunchmoney_python-2.10.0/lunchmoney/api/tags_api.py +1465 -0
  12. lunchmoney_python-2.10.0/lunchmoney/api/transactions_api.py +914 -0
  13. lunchmoney_python-2.10.0/lunchmoney/api/transactions_bulk_api.py +1527 -0
  14. lunchmoney_python-2.10.0/lunchmoney/api/transactions_files_api.py +891 -0
  15. lunchmoney_python-2.10.0/lunchmoney/api/transactions_group_api.py +601 -0
  16. lunchmoney_python-2.10.0/lunchmoney/api/transactions_split_api.py +616 -0
  17. lunchmoney_python-2.10.0/lunchmoney/api_client.py +805 -0
  18. lunchmoney_python-2.10.0/lunchmoney/api_response.py +21 -0
  19. lunchmoney_python-2.10.0/lunchmoney/configuration.py +620 -0
  20. lunchmoney_python-2.10.0/lunchmoney/exceptions.py +217 -0
  21. lunchmoney_python-2.10.0/lunchmoney/models/__init__.py +84 -0
  22. lunchmoney_python-2.10.0/lunchmoney/models/account_type_enum.py +46 -0
  23. lunchmoney_python-2.10.0/lunchmoney/models/aligned_category_totals_object.py +108 -0
  24. lunchmoney_python-2.10.0/lunchmoney/models/aligned_summary_category_object.py +110 -0
  25. lunchmoney_python-2.10.0/lunchmoney/models/aligned_summary_response_object.py +104 -0
  26. lunchmoney_python-2.10.0/lunchmoney/models/category_object.py +146 -0
  27. lunchmoney_python-2.10.0/lunchmoney/models/child_category_object.py +141 -0
  28. lunchmoney_python-2.10.0/lunchmoney/models/child_transaction_object.py +219 -0
  29. lunchmoney_python-2.10.0/lunchmoney/models/create_category_request_object.py +137 -0
  30. lunchmoney_python-2.10.0/lunchmoney/models/create_category_request_object_children_inner.py +159 -0
  31. lunchmoney_python-2.10.0/lunchmoney/models/create_manual_account_request_object.py +138 -0
  32. lunchmoney_python-2.10.0/lunchmoney/models/create_manual_account_request_object_balance.py +145 -0
  33. lunchmoney_python-2.10.0/lunchmoney/models/create_new_transactions_request.py +103 -0
  34. lunchmoney_python-2.10.0/lunchmoney/models/create_tag_request_object.py +112 -0
  35. lunchmoney_python-2.10.0/lunchmoney/models/currency_enum.py +198 -0
  36. lunchmoney_python-2.10.0/lunchmoney/models/delete_category_response_with_dependencies.py +94 -0
  37. lunchmoney_python-2.10.0/lunchmoney/models/delete_category_response_with_dependencies_dependents.py +98 -0
  38. lunchmoney_python-2.10.0/lunchmoney/models/delete_tag_response_with_dependencies.py +94 -0
  39. lunchmoney_python-2.10.0/lunchmoney/models/delete_tag_response_with_dependencies_dependents.py +90 -0
  40. lunchmoney_python-2.10.0/lunchmoney/models/delete_transactions_request.py +89 -0
  41. lunchmoney_python-2.10.0/lunchmoney/models/error_response_object.py +98 -0
  42. lunchmoney_python-2.10.0/lunchmoney/models/error_response_object_errors_inner.py +101 -0
  43. lunchmoney_python-2.10.0/lunchmoney/models/get_all_categories200_response.py +96 -0
  44. lunchmoney_python-2.10.0/lunchmoney/models/get_all_manual_accounts200_response.py +96 -0
  45. lunchmoney_python-2.10.0/lunchmoney/models/get_all_plaid_accounts200_response.py +96 -0
  46. lunchmoney_python-2.10.0/lunchmoney/models/get_all_recurring200_response.py +96 -0
  47. lunchmoney_python-2.10.0/lunchmoney/models/get_all_tags200_response.py +96 -0
  48. lunchmoney_python-2.10.0/lunchmoney/models/get_all_transactions200_response.py +100 -0
  49. lunchmoney_python-2.10.0/lunchmoney/models/get_all_transactions_created_since_parameter.py +145 -0
  50. lunchmoney_python-2.10.0/lunchmoney/models/get_budget_summary200_response.py +138 -0
  51. lunchmoney_python-2.10.0/lunchmoney/models/get_transaction_attachment_url200_response.py +91 -0
  52. lunchmoney_python-2.10.0/lunchmoney/models/group_transactions_request.py +122 -0
  53. lunchmoney_python-2.10.0/lunchmoney/models/insert_transaction_object.py +164 -0
  54. lunchmoney_python-2.10.0/lunchmoney/models/insert_transaction_object_amount.py +145 -0
  55. lunchmoney_python-2.10.0/lunchmoney/models/insert_transactions_response_object.py +106 -0
  56. lunchmoney_python-2.10.0/lunchmoney/models/manual_account_object.py +158 -0
  57. lunchmoney_python-2.10.0/lunchmoney/models/non_aligned_category_totals_object.py +94 -0
  58. lunchmoney_python-2.10.0/lunchmoney/models/non_aligned_summary_category_object.py +94 -0
  59. lunchmoney_python-2.10.0/lunchmoney/models/non_aligned_summary_response_object.py +104 -0
  60. lunchmoney_python-2.10.0/lunchmoney/models/plaid_account_object.py +168 -0
  61. lunchmoney_python-2.10.0/lunchmoney/models/recurring_object.py +143 -0
  62. lunchmoney_python-2.10.0/lunchmoney/models/recurring_object_matches.py +105 -0
  63. lunchmoney_python-2.10.0/lunchmoney/models/recurring_object_matches_found_transactions_inner.py +91 -0
  64. lunchmoney_python-2.10.0/lunchmoney/models/recurring_object_overrides.py +92 -0
  65. lunchmoney_python-2.10.0/lunchmoney/models/recurring_object_transaction_criteria.py +149 -0
  66. lunchmoney_python-2.10.0/lunchmoney/models/skipped_existing_external_id_object.py +108 -0
  67. lunchmoney_python-2.10.0/lunchmoney/models/split_transaction_object.py +102 -0
  68. lunchmoney_python-2.10.0/lunchmoney/models/split_transaction_object_amount.py +145 -0
  69. lunchmoney_python-2.10.0/lunchmoney/models/split_transaction_request.py +97 -0
  70. lunchmoney_python-2.10.0/lunchmoney/models/summary_category_occurrence_object.py +126 -0
  71. lunchmoney_python-2.10.0/lunchmoney/models/summary_recurring_transaction_object.py +100 -0
  72. lunchmoney_python-2.10.0/lunchmoney/models/summary_rollover_pool_adjustment_object.py +98 -0
  73. lunchmoney_python-2.10.0/lunchmoney/models/summary_rollover_pool_object.py +98 -0
  74. lunchmoney_python-2.10.0/lunchmoney/models/summary_totals_breakdown_object.py +98 -0
  75. lunchmoney_python-2.10.0/lunchmoney/models/summary_totals_object.py +97 -0
  76. lunchmoney_python-2.10.0/lunchmoney/models/tag_object.py +125 -0
  77. lunchmoney_python-2.10.0/lunchmoney/models/transaction_attachment_object.py +106 -0
  78. lunchmoney_python-2.10.0/lunchmoney/models/transaction_object.py +229 -0
  79. lunchmoney_python-2.10.0/lunchmoney/models/update_category_request_object.py +156 -0
  80. lunchmoney_python-2.10.0/lunchmoney/models/update_manual_account_request_object.py +156 -0
  81. lunchmoney_python-2.10.0/lunchmoney/models/update_manual_account_request_object_balance.py +145 -0
  82. lunchmoney_python-2.10.0/lunchmoney/models/update_tag_request_object.py +126 -0
  83. lunchmoney_python-2.10.0/lunchmoney/models/update_transaction_object.py +228 -0
  84. lunchmoney_python-2.10.0/lunchmoney/models/update_transaction_object_amount.py +145 -0
  85. lunchmoney_python-2.10.0/lunchmoney/models/update_transactions200_response.py +96 -0
  86. lunchmoney_python-2.10.0/lunchmoney/models/update_transactions_request.py +97 -0
  87. lunchmoney_python-2.10.0/lunchmoney/models/update_transactions_request_transactions_inner.py +228 -0
  88. lunchmoney_python-2.10.0/lunchmoney/models/user_object.py +106 -0
  89. lunchmoney_python-2.10.0/lunchmoney/py.typed +0 -0
  90. lunchmoney_python-2.10.0/lunchmoney/rest.py +259 -0
  91. lunchmoney_python-2.10.0/lunchmoney_python.egg-info/PKG-INFO +285 -0
  92. lunchmoney_python-2.10.0/lunchmoney_python.egg-info/SOURCES.txt +176 -0
  93. lunchmoney_python-2.10.0/lunchmoney_python.egg-info/dependency_links.txt +1 -0
  94. lunchmoney_python-2.10.0/lunchmoney_python.egg-info/requires.txt +4 -0
  95. lunchmoney_python-2.10.0/lunchmoney_python.egg-info/top_level.txt +1 -0
  96. lunchmoney_python-2.10.0/pyproject.toml +95 -0
  97. lunchmoney_python-2.10.0/setup.cfg +7 -0
  98. lunchmoney_python-2.10.0/setup.py +51 -0
  99. lunchmoney_python-2.10.0/test/test_account_type_enum.py +34 -0
  100. lunchmoney_python-2.10.0/test/test_aligned_category_totals_object.py +63 -0
  101. lunchmoney_python-2.10.0/test/test_aligned_summary_category_object.py +89 -0
  102. lunchmoney_python-2.10.0/test/test_aligned_summary_response_object.py +134 -0
  103. lunchmoney_python-2.10.0/test/test_categories_api.py +67 -0
  104. lunchmoney_python-2.10.0/test/test_category_object.py +96 -0
  105. lunchmoney_python-2.10.0/test/test_child_category_object.py +78 -0
  106. lunchmoney_python-2.10.0/test/test_child_transaction_object.py +110 -0
  107. lunchmoney_python-2.10.0/test/test_create_category_request_object.py +65 -0
  108. lunchmoney_python-2.10.0/test/test_create_category_request_object_children_inner.py +96 -0
  109. lunchmoney_python-2.10.0/test/test_create_manual_account_request_object.py +66 -0
  110. lunchmoney_python-2.10.0/test/test_create_manual_account_request_object_balance.py +51 -0
  111. lunchmoney_python-2.10.0/test/test_create_new_transactions_request.py +90 -0
  112. lunchmoney_python-2.10.0/test/test_create_tag_request_object.py +57 -0
  113. lunchmoney_python-2.10.0/test/test_currency_enum.py +34 -0
  114. lunchmoney_python-2.10.0/test/test_delete_category_response_with_dependencies.py +67 -0
  115. lunchmoney_python-2.10.0/test/test_delete_category_response_with_dependencies_dependents.py +63 -0
  116. lunchmoney_python-2.10.0/test/test_delete_tag_response_with_dependencies.py +59 -0
  117. lunchmoney_python-2.10.0/test/test_delete_tag_response_with_dependencies_dependents.py +55 -0
  118. lunchmoney_python-2.10.0/test/test_delete_transactions_request.py +57 -0
  119. lunchmoney_python-2.10.0/test/test_error_response_object.py +59 -0
  120. lunchmoney_python-2.10.0/test/test_error_response_object_errors_inner.py +53 -0
  121. lunchmoney_python-2.10.0/test/test_get_all_categories200_response.py +85 -0
  122. lunchmoney_python-2.10.0/test/test_get_all_manual_accounts200_response.py +70 -0
  123. lunchmoney_python-2.10.0/test/test_get_all_plaid_accounts200_response.py +73 -0
  124. lunchmoney_python-2.10.0/test/test_get_all_recurring200_response.py +91 -0
  125. lunchmoney_python-2.10.0/test/test_get_all_tags200_response.py +63 -0
  126. lunchmoney_python-2.10.0/test/test_get_all_transactions200_response.py +210 -0
  127. lunchmoney_python-2.10.0/test/test_get_all_transactions_created_since_parameter.py +51 -0
  128. lunchmoney_python-2.10.0/test/test_get_budget_summary200_response.py +86 -0
  129. lunchmoney_python-2.10.0/test/test_get_transaction_attachment_url200_response.py +55 -0
  130. lunchmoney_python-2.10.0/test/test_group_transactions_request.py +67 -0
  131. lunchmoney_python-2.10.0/test/test_insert_transaction_object.py +68 -0
  132. lunchmoney_python-2.10.0/test/test_insert_transaction_object_amount.py +51 -0
  133. lunchmoney_python-2.10.0/test/test_insert_transactions_response_object.py +221 -0
  134. lunchmoney_python-2.10.0/test/test_manual_account_object.py +82 -0
  135. lunchmoney_python-2.10.0/test/test_manual_accounts_api.py +67 -0
  136. lunchmoney_python-2.10.0/test/test_me_api.py +39 -0
  137. lunchmoney_python-2.10.0/test/test_non_aligned_category_totals_object.py +59 -0
  138. lunchmoney_python-2.10.0/test/test_non_aligned_summary_category_object.py +63 -0
  139. lunchmoney_python-2.10.0/test/test_non_aligned_summary_response_object.py +86 -0
  140. lunchmoney_python-2.10.0/test/test_plaid_account_object.py +89 -0
  141. lunchmoney_python-2.10.0/test/test_plaid_accounts_api.py +53 -0
  142. lunchmoney_python-2.10.0/test/test_recurring_items_api.py +46 -0
  143. lunchmoney_python-2.10.0/test/test_recurring_object.py +125 -0
  144. lunchmoney_python-2.10.0/test/test_recurring_object_matches.py +64 -0
  145. lunchmoney_python-2.10.0/test/test_recurring_object_matches_found_transactions_inner.py +53 -0
  146. lunchmoney_python-2.10.0/test/test_recurring_object_overrides.py +54 -0
  147. lunchmoney_python-2.10.0/test/test_recurring_object_transaction_criteria.py +73 -0
  148. lunchmoney_python-2.10.0/test/test_skipped_existing_external_id_object.py +70 -0
  149. lunchmoney_python-2.10.0/test/test_split_transaction_object.py +57 -0
  150. lunchmoney_python-2.10.0/test/test_split_transaction_object_amount.py +51 -0
  151. lunchmoney_python-2.10.0/test/test_split_transaction_request.py +67 -0
  152. lunchmoney_python-2.10.0/test/test_summary_api.py +39 -0
  153. lunchmoney_python-2.10.0/test/test_summary_category_occurrence_object.py +69 -0
  154. lunchmoney_python-2.10.0/test/test_summary_recurring_transaction_object.py +63 -0
  155. lunchmoney_python-2.10.0/test/test_summary_rollover_pool_adjustment_object.py +61 -0
  156. lunchmoney_python-2.10.0/test/test_summary_rollover_pool_object.py +69 -0
  157. lunchmoney_python-2.10.0/test/test_summary_totals_breakdown_object.py +57 -0
  158. lunchmoney_python-2.10.0/test/test_summary_totals_object.py +65 -0
  159. lunchmoney_python-2.10.0/test/test_tag_object.py +69 -0
  160. lunchmoney_python-2.10.0/test/test_tags_api.py +67 -0
  161. lunchmoney_python-2.10.0/test/test_transaction_attachment_object.py +58 -0
  162. lunchmoney_python-2.10.0/test/test_transaction_object.py +149 -0
  163. lunchmoney_python-2.10.0/test/test_transactions_api.py +53 -0
  164. lunchmoney_python-2.10.0/test/test_transactions_bulk_api.py +60 -0
  165. lunchmoney_python-2.10.0/test/test_transactions_files_api.py +53 -0
  166. lunchmoney_python-2.10.0/test/test_transactions_group_api.py +46 -0
  167. lunchmoney_python-2.10.0/test/test_transactions_split_api.py +46 -0
  168. lunchmoney_python-2.10.0/test/test_update_category_request_object.py +68 -0
  169. lunchmoney_python-2.10.0/test/test_update_manual_account_request_object.py +67 -0
  170. lunchmoney_python-2.10.0/test/test_update_manual_account_request_object_balance.py +51 -0
  171. lunchmoney_python-2.10.0/test/test_update_tag_request_object.py +60 -0
  172. lunchmoney_python-2.10.0/test/test_update_transaction_object.py +119 -0
  173. lunchmoney_python-2.10.0/test/test_update_transaction_object_amount.py +51 -0
  174. lunchmoney_python-2.10.0/test/test_update_transactions200_response.py +207 -0
  175. lunchmoney_python-2.10.0/test/test_update_transactions_request.py +57 -0
  176. lunchmoney_python-2.10.0/test/test_update_transactions_request_transactions_inner.py +120 -0
  177. lunchmoney_python-2.10.0/test/test_user_object.py +65 -0
@@ -0,0 +1,285 @@
1
+ Metadata-Version: 2.4
2
+ Name: lunchmoney-python
3
+ Version: 2.10.0
4
+ Summary: Lunch Money API - v2
5
+ Home-page:
6
+ Author: OpenAPI Generator community
7
+ Author-email: OpenAPI Generator Community <devsupport@lunchmoney.app>
8
+ License: Apache 2.0
9
+ Project-URL: Repository, https://github.com/juftin/lunchmoney-clients
10
+ Keywords: OpenAPI,OpenAPI-Generator,Lunch Money API - v2
11
+ Requires-Python: >=3.9
12
+ Description-Content-Type: text/markdown
13
+ Requires-Dist: urllib3<3.0.0,>=2.1.0
14
+ Requires-Dist: python-dateutil>=2.8.2
15
+ Requires-Dist: pydantic>=2
16
+ Requires-Dist: typing-extensions>=4.7.1
17
+ Dynamic: author
18
+
19
+ # lunchmoney-python
20
+ Welcome to the Lunch Money v2 API.
21
+
22
+ A working version of this API is now available through these docs, or directly at:
23
+
24
+ `https://api.lunchmoney.dev/v2`
25
+
26
+ <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review
27
+ period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span>
28
+ See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>
29
+
30
+ If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).
31
+
32
+ ### Static Mock Server
33
+
34
+ You may also use these docs to explore the API using a static mock server endpoint.<p>
35
+ This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p>
36
+ To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br>
37
+ When using this server, set your Bearer token to any string with 11 or more characters.
38
+
39
+ ### Migrating from V1
40
+
41
+ The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.
42
+
43
+ ### Acknowledgments
44
+
45
+ If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.
46
+
47
+ ### Useful links:
48
+ - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started)
49
+ - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog)
50
+ - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
51
+ - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
52
+ - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev)
53
+ - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
54
+
55
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
56
+
57
+ - API version: 2.8.4
58
+ - Package version: 2.10.0
59
+ - Generator version: 7.17.0
60
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
61
+
62
+ ## Requirements.
63
+
64
+ Python 3.9+
65
+
66
+ ## Installation & Usage
67
+ ### pip install
68
+
69
+ If the python package is hosted on a repository, you can install directly using:
70
+
71
+ ```sh
72
+ pip install git+https://github.com/juftin/lunchmoney-clients.git
73
+ ```
74
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/juftin/lunchmoney-clients.git`)
75
+
76
+ Then import the package:
77
+ ```python
78
+ import lunchmoney
79
+ ```
80
+
81
+ ### Setuptools
82
+
83
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
84
+
85
+ ```sh
86
+ python setup.py install --user
87
+ ```
88
+ (or `sudo python setup.py install` to install the package for all users)
89
+
90
+ Then import the package:
91
+ ```python
92
+ import lunchmoney
93
+ ```
94
+
95
+ ### Tests
96
+
97
+ Execute `pytest` to run the tests.
98
+
99
+ ## Getting Started
100
+
101
+ Please follow the [installation procedure](#installation--usage) and then run the following:
102
+
103
+ ```python
104
+
105
+ import lunchmoney
106
+ from lunchmoney.rest import ApiException
107
+ from pprint import pprint
108
+
109
+ # Defining the host is optional and defaults to https://api.lunchmoney.dev/v2
110
+ # See configuration.py for a list of all supported configuration parameters.
111
+ configuration = lunchmoney.Configuration(
112
+ host = "https://api.lunchmoney.dev/v2"
113
+ )
114
+
115
+ # The client must configure the authentication and authorization parameters
116
+ # in accordance with the API server security policy.
117
+ # Examples for each auth method are provided below, use the example that
118
+ # satisfies your auth use case.
119
+
120
+ # Configure API key authorization: cookieAuth
121
+ configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
122
+
123
+ # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
124
+ # configuration.api_key_prefix['cookieAuth'] = 'Bearer'
125
+
126
+ # Configure Bearer authorization (JWT): bearerSecurity
127
+ configuration = lunchmoney.Configuration(
128
+ access_token = os.environ["BEARER_TOKEN"]
129
+ )
130
+
131
+
132
+ # Enter a context with an instance of the API client
133
+ with lunchmoney.ApiClient(configuration) as api_client:
134
+ # Create an instance of the API class
135
+ api_instance = lunchmoney.CategoriesApi(api_client)
136
+ create_category_request_object = {"name":"API Created Category","description":"Test description of created category","is_income":false,"exclude_from_budget":true,"exclude_from_totals":false,"is_group":false} # CreateCategoryRequestObject |
137
+
138
+ try:
139
+ # Create a new category or category group
140
+ api_response = api_instance.create_category(create_category_request_object)
141
+ print("The response of CategoriesApi->create_category:\n")
142
+ pprint(api_response)
143
+ except ApiException as e:
144
+ print("Exception when calling CategoriesApi->create_category: %s\n" % e)
145
+
146
+ ```
147
+
148
+ ## Documentation for API Endpoints
149
+
150
+ All URIs are relative to *https://api.lunchmoney.dev/v2*
151
+
152
+ Class | Method | HTTP request | Description
153
+ ------------ | ------------- | ------------- | -------------
154
+ *CategoriesApi* | [**create_category**](docs/CategoriesApi.md#create_category) | **POST** /categories | Create a new category or category group
155
+ *CategoriesApi* | [**delete_category**](docs/CategoriesApi.md#delete_category) | **DELETE** /categories/{id} | Delete a category or category group
156
+ *CategoriesApi* | [**get_all_categories**](docs/CategoriesApi.md#get_all_categories) | **GET** /categories | Get all categories
157
+ *CategoriesApi* | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | **GET** /categories/{id} | Get a single category
158
+ *CategoriesApi* | [**update_category**](docs/CategoriesApi.md#update_category) | **PUT** /categories/{id} | Update an existing category or category group
159
+ *ManualAccountsApi* | [**create_manual_account**](docs/ManualAccountsApi.md#create_manual_account) | **POST** /manual_accounts | Create a manual account
160
+ *ManualAccountsApi* | [**delete_manual_account**](docs/ManualAccountsApi.md#delete_manual_account) | **DELETE** /manual_accounts/{id} | Delete a manual account
161
+ *ManualAccountsApi* | [**get_all_manual_accounts**](docs/ManualAccountsApi.md#get_all_manual_accounts) | **GET** /manual_accounts | Get all manual accounts
162
+ *ManualAccountsApi* | [**get_manual_account_by_id**](docs/ManualAccountsApi.md#get_manual_account_by_id) | **GET** /manual_accounts/{id} | Get a single manual account
163
+ *ManualAccountsApi* | [**update_manual_account**](docs/ManualAccountsApi.md#update_manual_account) | **PUT** /manual_accounts/{id} | Update an existing manual account
164
+ *MeApi* | [**get_me**](docs/MeApi.md#get_me) | **GET** /me | Get current user
165
+ *PlaidAccountsApi* | [**get_all_plaid_accounts**](docs/PlaidAccountsApi.md#get_all_plaid_accounts) | **GET** /plaid_accounts | Get all accounts synced via Plaid
166
+ *PlaidAccountsApi* | [**get_plaid_account_by_id**](docs/PlaidAccountsApi.md#get_plaid_account_by_id) | **GET** /plaid_accounts/{id} | Get a single account that is synced via Plaid
167
+ *PlaidAccountsApi* | [**trigger_plaid_account_fetch**](docs/PlaidAccountsApi.md#trigger_plaid_account_fetch) | **POST** /plaid_accounts/fetch | Trigger Fetch from Plaid
168
+ *RecurringItemsApi* | [**get_all_recurring**](docs/RecurringItemsApi.md#get_all_recurring) | **GET** /recurring_items | Get all recurring items
169
+ *RecurringItemsApi* | [**get_recurring_by_id**](docs/RecurringItemsApi.md#get_recurring_by_id) | **GET** /recurring_items/{id} | Get a single recurring item
170
+ *SummaryApi* | [**get_budget_summary**](docs/SummaryApi.md#get_budget_summary) | **GET** /summary | Get summary
171
+ *TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /tags | Create a new tag
172
+ *TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id} | Delete a tag
173
+ *TagsApi* | [**get_all_tags**](docs/TagsApi.md#get_all_tags) | **GET** /tags | Get All Tags
174
+ *TagsApi* | [**get_tag_by_id**](docs/TagsApi.md#get_tag_by_id) | **GET** /tags/{id} | Get a single tag
175
+ *TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PUT** /tags/{id} | Update an existing tag
176
+ *TransactionsApi* | [**delete_transaction_by_id**](docs/TransactionsApi.md#delete_transaction_by_id) | **DELETE** /transactions/{id} | Delete a transaction
177
+ *TransactionsApi* | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | **GET** /transactions/{id} | Get a single transaction
178
+ *TransactionsApi* | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | **PUT** /transactions/{id} | Update an existing transaction
179
+ *TransactionsBulkApi* | [**create_new_transactions**](docs/TransactionsBulkApi.md#create_new_transactions) | **POST** /transactions | Insert one or more transactions.
180
+ *TransactionsBulkApi* | [**delete_transactions**](docs/TransactionsBulkApi.md#delete_transactions) | **DELETE** /transactions | Bulk delete existing transactions
181
+ *TransactionsBulkApi* | [**get_all_transactions**](docs/TransactionsBulkApi.md#get_all_transactions) | **GET** /transactions | Get all transactions
182
+ *TransactionsBulkApi* | [**update_transactions**](docs/TransactionsBulkApi.md#update_transactions) | **PUT** /transactions | Update multiple transactions
183
+ *TransactionsFilesApi* | [**attach_file_to_transaction**](docs/TransactionsFilesApi.md#attach_file_to_transaction) | **POST** /transactions/{transaction_id}/attachments | Attach a file to a transaction
184
+ *TransactionsFilesApi* | [**delete_transaction_attachment**](docs/TransactionsFilesApi.md#delete_transaction_attachment) | **DELETE** /transactions/attachments/{file_id} | Delete a file attachment
185
+ *TransactionsFilesApi* | [**get_transaction_attachment_url**](docs/TransactionsFilesApi.md#get_transaction_attachment_url) | **GET** /transactions/attachments/{file_id} | Get a url to download a file attachment
186
+ *TransactionsGroupApi* | [**group_transactions**](docs/TransactionsGroupApi.md#group_transactions) | **POST** /transactions/group | Create a transaction group
187
+ *TransactionsGroupApi* | [**ungroup_transactions**](docs/TransactionsGroupApi.md#ungroup_transactions) | **DELETE** /transactions/group/{id} | Delete a transaction group
188
+ *TransactionsSplitApi* | [**split_transaction**](docs/TransactionsSplitApi.md#split_transaction) | **POST** /transactions/split/{id} | Split a transaction
189
+ *TransactionsSplitApi* | [**unsplit_transaction**](docs/TransactionsSplitApi.md#unsplit_transaction) | **DELETE** /transactions/split/{id} | Unsplit a previously split transactions
190
+
191
+
192
+ ## Documentation For Models
193
+
194
+ - [AccountTypeEnum](docs/AccountTypeEnum.md)
195
+ - [AlignedCategoryTotalsObject](docs/AlignedCategoryTotalsObject.md)
196
+ - [AlignedSummaryCategoryObject](docs/AlignedSummaryCategoryObject.md)
197
+ - [AlignedSummaryResponseObject](docs/AlignedSummaryResponseObject.md)
198
+ - [CategoryObject](docs/CategoryObject.md)
199
+ - [ChildCategoryObject](docs/ChildCategoryObject.md)
200
+ - [ChildTransactionObject](docs/ChildTransactionObject.md)
201
+ - [CreateCategoryRequestObject](docs/CreateCategoryRequestObject.md)
202
+ - [CreateCategoryRequestObjectChildrenInner](docs/CreateCategoryRequestObjectChildrenInner.md)
203
+ - [CreateManualAccountRequestObject](docs/CreateManualAccountRequestObject.md)
204
+ - [CreateManualAccountRequestObjectBalance](docs/CreateManualAccountRequestObjectBalance.md)
205
+ - [CreateNewTransactionsRequest](docs/CreateNewTransactionsRequest.md)
206
+ - [CreateTagRequestObject](docs/CreateTagRequestObject.md)
207
+ - [CurrencyEnum](docs/CurrencyEnum.md)
208
+ - [DeleteCategoryResponseWithDependencies](docs/DeleteCategoryResponseWithDependencies.md)
209
+ - [DeleteCategoryResponseWithDependenciesDependents](docs/DeleteCategoryResponseWithDependenciesDependents.md)
210
+ - [DeleteTagResponseWithDependencies](docs/DeleteTagResponseWithDependencies.md)
211
+ - [DeleteTagResponseWithDependenciesDependents](docs/DeleteTagResponseWithDependenciesDependents.md)
212
+ - [DeleteTransactionsRequest](docs/DeleteTransactionsRequest.md)
213
+ - [ErrorResponseObject](docs/ErrorResponseObject.md)
214
+ - [ErrorResponseObjectErrorsInner](docs/ErrorResponseObjectErrorsInner.md)
215
+ - [GetAllCategories200Response](docs/GetAllCategories200Response.md)
216
+ - [GetAllManualAccounts200Response](docs/GetAllManualAccounts200Response.md)
217
+ - [GetAllPlaidAccounts200Response](docs/GetAllPlaidAccounts200Response.md)
218
+ - [GetAllRecurring200Response](docs/GetAllRecurring200Response.md)
219
+ - [GetAllTags200Response](docs/GetAllTags200Response.md)
220
+ - [GetAllTransactions200Response](docs/GetAllTransactions200Response.md)
221
+ - [GetAllTransactionsCreatedSinceParameter](docs/GetAllTransactionsCreatedSinceParameter.md)
222
+ - [GetBudgetSummary200Response](docs/GetBudgetSummary200Response.md)
223
+ - [GetTransactionAttachmentUrl200Response](docs/GetTransactionAttachmentUrl200Response.md)
224
+ - [GroupTransactionsRequest](docs/GroupTransactionsRequest.md)
225
+ - [InsertTransactionObject](docs/InsertTransactionObject.md)
226
+ - [InsertTransactionObjectAmount](docs/InsertTransactionObjectAmount.md)
227
+ - [InsertTransactionsResponseObject](docs/InsertTransactionsResponseObject.md)
228
+ - [ManualAccountObject](docs/ManualAccountObject.md)
229
+ - [NonAlignedCategoryTotalsObject](docs/NonAlignedCategoryTotalsObject.md)
230
+ - [NonAlignedSummaryCategoryObject](docs/NonAlignedSummaryCategoryObject.md)
231
+ - [NonAlignedSummaryResponseObject](docs/NonAlignedSummaryResponseObject.md)
232
+ - [PlaidAccountObject](docs/PlaidAccountObject.md)
233
+ - [RecurringObject](docs/RecurringObject.md)
234
+ - [RecurringObjectMatches](docs/RecurringObjectMatches.md)
235
+ - [RecurringObjectMatchesFoundTransactionsInner](docs/RecurringObjectMatchesFoundTransactionsInner.md)
236
+ - [RecurringObjectOverrides](docs/RecurringObjectOverrides.md)
237
+ - [RecurringObjectTransactionCriteria](docs/RecurringObjectTransactionCriteria.md)
238
+ - [SkippedExistingExternalIdObject](docs/SkippedExistingExternalIdObject.md)
239
+ - [SplitTransactionObject](docs/SplitTransactionObject.md)
240
+ - [SplitTransactionObjectAmount](docs/SplitTransactionObjectAmount.md)
241
+ - [SplitTransactionRequest](docs/SplitTransactionRequest.md)
242
+ - [SummaryCategoryOccurrenceObject](docs/SummaryCategoryOccurrenceObject.md)
243
+ - [SummaryRecurringTransactionObject](docs/SummaryRecurringTransactionObject.md)
244
+ - [SummaryRolloverPoolAdjustmentObject](docs/SummaryRolloverPoolAdjustmentObject.md)
245
+ - [SummaryRolloverPoolObject](docs/SummaryRolloverPoolObject.md)
246
+ - [SummaryTotalsBreakdownObject](docs/SummaryTotalsBreakdownObject.md)
247
+ - [SummaryTotalsObject](docs/SummaryTotalsObject.md)
248
+ - [TagObject](docs/TagObject.md)
249
+ - [TransactionAttachmentObject](docs/TransactionAttachmentObject.md)
250
+ - [TransactionObject](docs/TransactionObject.md)
251
+ - [UpdateCategoryRequestObject](docs/UpdateCategoryRequestObject.md)
252
+ - [UpdateManualAccountRequestObject](docs/UpdateManualAccountRequestObject.md)
253
+ - [UpdateManualAccountRequestObjectBalance](docs/UpdateManualAccountRequestObjectBalance.md)
254
+ - [UpdateTagRequestObject](docs/UpdateTagRequestObject.md)
255
+ - [UpdateTransactionObject](docs/UpdateTransactionObject.md)
256
+ - [UpdateTransactionObjectAmount](docs/UpdateTransactionObjectAmount.md)
257
+ - [UpdateTransactions200Response](docs/UpdateTransactions200Response.md)
258
+ - [UpdateTransactionsRequest](docs/UpdateTransactionsRequest.md)
259
+ - [UpdateTransactionsRequestTransactionsInner](docs/UpdateTransactionsRequestTransactionsInner.md)
260
+ - [UserObject](docs/UserObject.md)
261
+
262
+
263
+ <a id="documentation-for-authorization"></a>
264
+ ## Documentation For Authorization
265
+
266
+
267
+ Authentication schemes defined for the API:
268
+ <a id="bearerSecurity"></a>
269
+ ### bearerSecurity
270
+
271
+ - **Type**: Bearer authentication (JWT)
272
+
273
+ <a id="cookieAuth"></a>
274
+ ### cookieAuth
275
+
276
+ - **Type**: API key
277
+ - **API key parameter name**: _lm_access_token
278
+ - **Location**:
279
+
280
+
281
+ ## Author
282
+
283
+ devsupport@lunchmoney.app
284
+
285
+
@@ -0,0 +1,267 @@
1
+ # lunchmoney-python
2
+ Welcome to the Lunch Money v2 API.
3
+
4
+ A working version of this API is now available through these docs, or directly at:
5
+
6
+ `https://api.lunchmoney.dev/v2`
7
+
8
+ <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review
9
+ period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span>
10
+ See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>
11
+
12
+ If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).
13
+
14
+ ### Static Mock Server
15
+
16
+ You may also use these docs to explore the API using a static mock server endpoint.<p>
17
+ This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p>
18
+ To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br>
19
+ When using this server, set your Bearer token to any string with 11 or more characters.
20
+
21
+ ### Migrating from V1
22
+
23
+ The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.
24
+
25
+ ### Acknowledgments
26
+
27
+ If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.
28
+
29
+ ### Useful links:
30
+ - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started)
31
+ - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog)
32
+ - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
33
+ - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
34
+ - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev)
35
+ - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
36
+
37
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
38
+
39
+ - API version: 2.8.4
40
+ - Package version: 2.10.0
41
+ - Generator version: 7.17.0
42
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
43
+
44
+ ## Requirements.
45
+
46
+ Python 3.9+
47
+
48
+ ## Installation & Usage
49
+ ### pip install
50
+
51
+ If the python package is hosted on a repository, you can install directly using:
52
+
53
+ ```sh
54
+ pip install git+https://github.com/juftin/lunchmoney-clients.git
55
+ ```
56
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/juftin/lunchmoney-clients.git`)
57
+
58
+ Then import the package:
59
+ ```python
60
+ import lunchmoney
61
+ ```
62
+
63
+ ### Setuptools
64
+
65
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
66
+
67
+ ```sh
68
+ python setup.py install --user
69
+ ```
70
+ (or `sudo python setup.py install` to install the package for all users)
71
+
72
+ Then import the package:
73
+ ```python
74
+ import lunchmoney
75
+ ```
76
+
77
+ ### Tests
78
+
79
+ Execute `pytest` to run the tests.
80
+
81
+ ## Getting Started
82
+
83
+ Please follow the [installation procedure](#installation--usage) and then run the following:
84
+
85
+ ```python
86
+
87
+ import lunchmoney
88
+ from lunchmoney.rest import ApiException
89
+ from pprint import pprint
90
+
91
+ # Defining the host is optional and defaults to https://api.lunchmoney.dev/v2
92
+ # See configuration.py for a list of all supported configuration parameters.
93
+ configuration = lunchmoney.Configuration(
94
+ host = "https://api.lunchmoney.dev/v2"
95
+ )
96
+
97
+ # The client must configure the authentication and authorization parameters
98
+ # in accordance with the API server security policy.
99
+ # Examples for each auth method are provided below, use the example that
100
+ # satisfies your auth use case.
101
+
102
+ # Configure API key authorization: cookieAuth
103
+ configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
104
+
105
+ # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
106
+ # configuration.api_key_prefix['cookieAuth'] = 'Bearer'
107
+
108
+ # Configure Bearer authorization (JWT): bearerSecurity
109
+ configuration = lunchmoney.Configuration(
110
+ access_token = os.environ["BEARER_TOKEN"]
111
+ )
112
+
113
+
114
+ # Enter a context with an instance of the API client
115
+ with lunchmoney.ApiClient(configuration) as api_client:
116
+ # Create an instance of the API class
117
+ api_instance = lunchmoney.CategoriesApi(api_client)
118
+ create_category_request_object = {"name":"API Created Category","description":"Test description of created category","is_income":false,"exclude_from_budget":true,"exclude_from_totals":false,"is_group":false} # CreateCategoryRequestObject |
119
+
120
+ try:
121
+ # Create a new category or category group
122
+ api_response = api_instance.create_category(create_category_request_object)
123
+ print("The response of CategoriesApi->create_category:\n")
124
+ pprint(api_response)
125
+ except ApiException as e:
126
+ print("Exception when calling CategoriesApi->create_category: %s\n" % e)
127
+
128
+ ```
129
+
130
+ ## Documentation for API Endpoints
131
+
132
+ All URIs are relative to *https://api.lunchmoney.dev/v2*
133
+
134
+ Class | Method | HTTP request | Description
135
+ ------------ | ------------- | ------------- | -------------
136
+ *CategoriesApi* | [**create_category**](docs/CategoriesApi.md#create_category) | **POST** /categories | Create a new category or category group
137
+ *CategoriesApi* | [**delete_category**](docs/CategoriesApi.md#delete_category) | **DELETE** /categories/{id} | Delete a category or category group
138
+ *CategoriesApi* | [**get_all_categories**](docs/CategoriesApi.md#get_all_categories) | **GET** /categories | Get all categories
139
+ *CategoriesApi* | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | **GET** /categories/{id} | Get a single category
140
+ *CategoriesApi* | [**update_category**](docs/CategoriesApi.md#update_category) | **PUT** /categories/{id} | Update an existing category or category group
141
+ *ManualAccountsApi* | [**create_manual_account**](docs/ManualAccountsApi.md#create_manual_account) | **POST** /manual_accounts | Create a manual account
142
+ *ManualAccountsApi* | [**delete_manual_account**](docs/ManualAccountsApi.md#delete_manual_account) | **DELETE** /manual_accounts/{id} | Delete a manual account
143
+ *ManualAccountsApi* | [**get_all_manual_accounts**](docs/ManualAccountsApi.md#get_all_manual_accounts) | **GET** /manual_accounts | Get all manual accounts
144
+ *ManualAccountsApi* | [**get_manual_account_by_id**](docs/ManualAccountsApi.md#get_manual_account_by_id) | **GET** /manual_accounts/{id} | Get a single manual account
145
+ *ManualAccountsApi* | [**update_manual_account**](docs/ManualAccountsApi.md#update_manual_account) | **PUT** /manual_accounts/{id} | Update an existing manual account
146
+ *MeApi* | [**get_me**](docs/MeApi.md#get_me) | **GET** /me | Get current user
147
+ *PlaidAccountsApi* | [**get_all_plaid_accounts**](docs/PlaidAccountsApi.md#get_all_plaid_accounts) | **GET** /plaid_accounts | Get all accounts synced via Plaid
148
+ *PlaidAccountsApi* | [**get_plaid_account_by_id**](docs/PlaidAccountsApi.md#get_plaid_account_by_id) | **GET** /plaid_accounts/{id} | Get a single account that is synced via Plaid
149
+ *PlaidAccountsApi* | [**trigger_plaid_account_fetch**](docs/PlaidAccountsApi.md#trigger_plaid_account_fetch) | **POST** /plaid_accounts/fetch | Trigger Fetch from Plaid
150
+ *RecurringItemsApi* | [**get_all_recurring**](docs/RecurringItemsApi.md#get_all_recurring) | **GET** /recurring_items | Get all recurring items
151
+ *RecurringItemsApi* | [**get_recurring_by_id**](docs/RecurringItemsApi.md#get_recurring_by_id) | **GET** /recurring_items/{id} | Get a single recurring item
152
+ *SummaryApi* | [**get_budget_summary**](docs/SummaryApi.md#get_budget_summary) | **GET** /summary | Get summary
153
+ *TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /tags | Create a new tag
154
+ *TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /tags/{id} | Delete a tag
155
+ *TagsApi* | [**get_all_tags**](docs/TagsApi.md#get_all_tags) | **GET** /tags | Get All Tags
156
+ *TagsApi* | [**get_tag_by_id**](docs/TagsApi.md#get_tag_by_id) | **GET** /tags/{id} | Get a single tag
157
+ *TagsApi* | [**update_tag**](docs/TagsApi.md#update_tag) | **PUT** /tags/{id} | Update an existing tag
158
+ *TransactionsApi* | [**delete_transaction_by_id**](docs/TransactionsApi.md#delete_transaction_by_id) | **DELETE** /transactions/{id} | Delete a transaction
159
+ *TransactionsApi* | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | **GET** /transactions/{id} | Get a single transaction
160
+ *TransactionsApi* | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | **PUT** /transactions/{id} | Update an existing transaction
161
+ *TransactionsBulkApi* | [**create_new_transactions**](docs/TransactionsBulkApi.md#create_new_transactions) | **POST** /transactions | Insert one or more transactions.
162
+ *TransactionsBulkApi* | [**delete_transactions**](docs/TransactionsBulkApi.md#delete_transactions) | **DELETE** /transactions | Bulk delete existing transactions
163
+ *TransactionsBulkApi* | [**get_all_transactions**](docs/TransactionsBulkApi.md#get_all_transactions) | **GET** /transactions | Get all transactions
164
+ *TransactionsBulkApi* | [**update_transactions**](docs/TransactionsBulkApi.md#update_transactions) | **PUT** /transactions | Update multiple transactions
165
+ *TransactionsFilesApi* | [**attach_file_to_transaction**](docs/TransactionsFilesApi.md#attach_file_to_transaction) | **POST** /transactions/{transaction_id}/attachments | Attach a file to a transaction
166
+ *TransactionsFilesApi* | [**delete_transaction_attachment**](docs/TransactionsFilesApi.md#delete_transaction_attachment) | **DELETE** /transactions/attachments/{file_id} | Delete a file attachment
167
+ *TransactionsFilesApi* | [**get_transaction_attachment_url**](docs/TransactionsFilesApi.md#get_transaction_attachment_url) | **GET** /transactions/attachments/{file_id} | Get a url to download a file attachment
168
+ *TransactionsGroupApi* | [**group_transactions**](docs/TransactionsGroupApi.md#group_transactions) | **POST** /transactions/group | Create a transaction group
169
+ *TransactionsGroupApi* | [**ungroup_transactions**](docs/TransactionsGroupApi.md#ungroup_transactions) | **DELETE** /transactions/group/{id} | Delete a transaction group
170
+ *TransactionsSplitApi* | [**split_transaction**](docs/TransactionsSplitApi.md#split_transaction) | **POST** /transactions/split/{id} | Split a transaction
171
+ *TransactionsSplitApi* | [**unsplit_transaction**](docs/TransactionsSplitApi.md#unsplit_transaction) | **DELETE** /transactions/split/{id} | Unsplit a previously split transactions
172
+
173
+
174
+ ## Documentation For Models
175
+
176
+ - [AccountTypeEnum](docs/AccountTypeEnum.md)
177
+ - [AlignedCategoryTotalsObject](docs/AlignedCategoryTotalsObject.md)
178
+ - [AlignedSummaryCategoryObject](docs/AlignedSummaryCategoryObject.md)
179
+ - [AlignedSummaryResponseObject](docs/AlignedSummaryResponseObject.md)
180
+ - [CategoryObject](docs/CategoryObject.md)
181
+ - [ChildCategoryObject](docs/ChildCategoryObject.md)
182
+ - [ChildTransactionObject](docs/ChildTransactionObject.md)
183
+ - [CreateCategoryRequestObject](docs/CreateCategoryRequestObject.md)
184
+ - [CreateCategoryRequestObjectChildrenInner](docs/CreateCategoryRequestObjectChildrenInner.md)
185
+ - [CreateManualAccountRequestObject](docs/CreateManualAccountRequestObject.md)
186
+ - [CreateManualAccountRequestObjectBalance](docs/CreateManualAccountRequestObjectBalance.md)
187
+ - [CreateNewTransactionsRequest](docs/CreateNewTransactionsRequest.md)
188
+ - [CreateTagRequestObject](docs/CreateTagRequestObject.md)
189
+ - [CurrencyEnum](docs/CurrencyEnum.md)
190
+ - [DeleteCategoryResponseWithDependencies](docs/DeleteCategoryResponseWithDependencies.md)
191
+ - [DeleteCategoryResponseWithDependenciesDependents](docs/DeleteCategoryResponseWithDependenciesDependents.md)
192
+ - [DeleteTagResponseWithDependencies](docs/DeleteTagResponseWithDependencies.md)
193
+ - [DeleteTagResponseWithDependenciesDependents](docs/DeleteTagResponseWithDependenciesDependents.md)
194
+ - [DeleteTransactionsRequest](docs/DeleteTransactionsRequest.md)
195
+ - [ErrorResponseObject](docs/ErrorResponseObject.md)
196
+ - [ErrorResponseObjectErrorsInner](docs/ErrorResponseObjectErrorsInner.md)
197
+ - [GetAllCategories200Response](docs/GetAllCategories200Response.md)
198
+ - [GetAllManualAccounts200Response](docs/GetAllManualAccounts200Response.md)
199
+ - [GetAllPlaidAccounts200Response](docs/GetAllPlaidAccounts200Response.md)
200
+ - [GetAllRecurring200Response](docs/GetAllRecurring200Response.md)
201
+ - [GetAllTags200Response](docs/GetAllTags200Response.md)
202
+ - [GetAllTransactions200Response](docs/GetAllTransactions200Response.md)
203
+ - [GetAllTransactionsCreatedSinceParameter](docs/GetAllTransactionsCreatedSinceParameter.md)
204
+ - [GetBudgetSummary200Response](docs/GetBudgetSummary200Response.md)
205
+ - [GetTransactionAttachmentUrl200Response](docs/GetTransactionAttachmentUrl200Response.md)
206
+ - [GroupTransactionsRequest](docs/GroupTransactionsRequest.md)
207
+ - [InsertTransactionObject](docs/InsertTransactionObject.md)
208
+ - [InsertTransactionObjectAmount](docs/InsertTransactionObjectAmount.md)
209
+ - [InsertTransactionsResponseObject](docs/InsertTransactionsResponseObject.md)
210
+ - [ManualAccountObject](docs/ManualAccountObject.md)
211
+ - [NonAlignedCategoryTotalsObject](docs/NonAlignedCategoryTotalsObject.md)
212
+ - [NonAlignedSummaryCategoryObject](docs/NonAlignedSummaryCategoryObject.md)
213
+ - [NonAlignedSummaryResponseObject](docs/NonAlignedSummaryResponseObject.md)
214
+ - [PlaidAccountObject](docs/PlaidAccountObject.md)
215
+ - [RecurringObject](docs/RecurringObject.md)
216
+ - [RecurringObjectMatches](docs/RecurringObjectMatches.md)
217
+ - [RecurringObjectMatchesFoundTransactionsInner](docs/RecurringObjectMatchesFoundTransactionsInner.md)
218
+ - [RecurringObjectOverrides](docs/RecurringObjectOverrides.md)
219
+ - [RecurringObjectTransactionCriteria](docs/RecurringObjectTransactionCriteria.md)
220
+ - [SkippedExistingExternalIdObject](docs/SkippedExistingExternalIdObject.md)
221
+ - [SplitTransactionObject](docs/SplitTransactionObject.md)
222
+ - [SplitTransactionObjectAmount](docs/SplitTransactionObjectAmount.md)
223
+ - [SplitTransactionRequest](docs/SplitTransactionRequest.md)
224
+ - [SummaryCategoryOccurrenceObject](docs/SummaryCategoryOccurrenceObject.md)
225
+ - [SummaryRecurringTransactionObject](docs/SummaryRecurringTransactionObject.md)
226
+ - [SummaryRolloverPoolAdjustmentObject](docs/SummaryRolloverPoolAdjustmentObject.md)
227
+ - [SummaryRolloverPoolObject](docs/SummaryRolloverPoolObject.md)
228
+ - [SummaryTotalsBreakdownObject](docs/SummaryTotalsBreakdownObject.md)
229
+ - [SummaryTotalsObject](docs/SummaryTotalsObject.md)
230
+ - [TagObject](docs/TagObject.md)
231
+ - [TransactionAttachmentObject](docs/TransactionAttachmentObject.md)
232
+ - [TransactionObject](docs/TransactionObject.md)
233
+ - [UpdateCategoryRequestObject](docs/UpdateCategoryRequestObject.md)
234
+ - [UpdateManualAccountRequestObject](docs/UpdateManualAccountRequestObject.md)
235
+ - [UpdateManualAccountRequestObjectBalance](docs/UpdateManualAccountRequestObjectBalance.md)
236
+ - [UpdateTagRequestObject](docs/UpdateTagRequestObject.md)
237
+ - [UpdateTransactionObject](docs/UpdateTransactionObject.md)
238
+ - [UpdateTransactionObjectAmount](docs/UpdateTransactionObjectAmount.md)
239
+ - [UpdateTransactions200Response](docs/UpdateTransactions200Response.md)
240
+ - [UpdateTransactionsRequest](docs/UpdateTransactionsRequest.md)
241
+ - [UpdateTransactionsRequestTransactionsInner](docs/UpdateTransactionsRequestTransactionsInner.md)
242
+ - [UserObject](docs/UserObject.md)
243
+
244
+
245
+ <a id="documentation-for-authorization"></a>
246
+ ## Documentation For Authorization
247
+
248
+
249
+ Authentication schemes defined for the API:
250
+ <a id="bearerSecurity"></a>
251
+ ### bearerSecurity
252
+
253
+ - **Type**: Bearer authentication (JWT)
254
+
255
+ <a id="cookieAuth"></a>
256
+ ### cookieAuth
257
+
258
+ - **Type**: API key
259
+ - **API key parameter name**: _lm_access_token
260
+ - **Location**:
261
+
262
+
263
+ ## Author
264
+
265
+ devsupport@lunchmoney.app
266
+
267
+