budgea_client 1.0.0
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.
- checksums.yaml +7 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +89 -0
- data/README.md +619 -0
- data/Rakefile +13 -0
- data/budgea_client.gemspec +35 -0
- data/docs/Access.md +12 -0
- data/docs/Account.md +25 -0
- data/docs/AccountLog.md +15 -0
- data/docs/AccountType.md +15 -0
- data/docs/AdministrationApi.md +944 -0
- data/docs/Alert.md +15 -0
- data/docs/AuthenticationApi.md +398 -0
- data/docs/Bank.md +18 -0
- data/docs/BankCategory.md +9 -0
- data/docs/BanksApi.md +6558 -0
- data/docs/Category.md +17 -0
- data/docs/Client.md +18 -0
- data/docs/Connection.md +16 -0
- data/docs/ConnectionContact.md +17 -0
- data/docs/ConnectionLog.md +21 -0
- data/docs/ConnectionsApi.md +934 -0
- data/docs/ConnectorLogo.md +11 -0
- data/docs/Currency.md +10 -0
- data/docs/Device.md +14 -0
- data/docs/Document.md +29 -0
- data/docs/DocumentType.md +10 -0
- data/docs/DocumentsApi.md +5228 -0
- data/docs/Field.md +15 -0
- data/docs/File.md +11 -0
- data/docs/Group.md +15 -0
- data/docs/HashTable.md +11 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +9 -0
- data/docs/InlineResponse20010.md +8 -0
- data/docs/InlineResponse20011.md +8 -0
- data/docs/InlineResponse20012.md +8 -0
- data/docs/InlineResponse20013.md +8 -0
- data/docs/InlineResponse20014.md +8 -0
- data/docs/InlineResponse20015.md +8 -0
- data/docs/InlineResponse20016.md +8 -0
- data/docs/InlineResponse20017.md +8 -0
- data/docs/InlineResponse20018.md +8 -0
- data/docs/InlineResponse20019.md +8 -0
- data/docs/InlineResponse2002.md +10 -0
- data/docs/InlineResponse20020.md +8 -0
- data/docs/InlineResponse20021.md +8 -0
- data/docs/InlineResponse20022.md +8 -0
- data/docs/InlineResponse20023.md +8 -0
- data/docs/InlineResponse20024.md +8 -0
- data/docs/InlineResponse20025.md +8 -0
- data/docs/InlineResponse20026.md +8 -0
- data/docs/InlineResponse20027.md +8 -0
- data/docs/InlineResponse20028.md +8 -0
- data/docs/InlineResponse20029.md +8 -0
- data/docs/InlineResponse2003.md +10 -0
- data/docs/InlineResponse20030.md +8 -0
- data/docs/InlineResponse20031.md +8 -0
- data/docs/InlineResponse20032.md +8 -0
- data/docs/InlineResponse20033.md +8 -0
- data/docs/InlineResponse2004.md +12 -0
- data/docs/InlineResponse2005.md +9 -0
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +8 -0
- data/docs/InlineResponse2008.md +8 -0
- data/docs/InlineResponse2009.md +8 -0
- data/docs/Investment.md +32 -0
- data/docs/InvestmentValue.md +13 -0
- data/docs/Invite.md +13 -0
- data/docs/LockedUser.md +10 -0
- data/docs/OCRApi.md +117 -0
- data/docs/OIDCApi.md +167 -0
- data/docs/OidcWhitelist.md +9 -0
- data/docs/PFMApi.md +2204 -0
- data/docs/Pocket.md +17 -0
- data/docs/Profile.md +15 -0
- data/docs/Project.md +16 -0
- data/docs/ProjectType.md +10 -0
- data/docs/ProvidersApi.md +7014 -0
- data/docs/Recipient.md +22 -0
- data/docs/RecipientsApi.md +244 -0
- data/docs/Security.md +12 -0
- data/docs/Subscription.md +18 -0
- data/docs/TermsApi.md +218 -0
- data/docs/TermsOfService.md +12 -0
- data/docs/Transaction.md +33 -0
- data/docs/TransactionInformation.md +11 -0
- data/docs/TransactionsCluster.md +16 -0
- data/docs/Transfer.md +23 -0
- data/docs/TransfersApi.md +2404 -0
- data/docs/User.md +10 -0
- data/docs/UserAlert.md +21 -0
- data/docs/UsersManagementApi.md +608 -0
- data/docs/WealthApi.md +828 -0
- data/docs/Webhook.md +15 -0
- data/git_push.sh +55 -0
- data/lib/budgea_client.rb +118 -0
- data/lib/budgea_client/api/administration_api.rb +1059 -0
- data/lib/budgea_client/api/authentication_api.rb +467 -0
- data/lib/budgea_client/api/banks_api.rb +7837 -0
- data/lib/budgea_client/api/connections_api.rb +1088 -0
- data/lib/budgea_client/api/documents_api.rb +6637 -0
- data/lib/budgea_client/api/ocr_api.rb +141 -0
- data/lib/budgea_client/api/oidc_api.rb +195 -0
- data/lib/budgea_client/api/pfm_api.rb +2630 -0
- data/lib/budgea_client/api/providers_api.rb +8694 -0
- data/lib/budgea_client/api/recipients_api.rb +293 -0
- data/lib/budgea_client/api/terms_api.rb +245 -0
- data/lib/budgea_client/api/transfers_api.rb +2941 -0
- data/lib/budgea_client/api/users_management_api.rb +695 -0
- data/lib/budgea_client/api/wealth_api.rb +994 -0
- data/lib/budgea_client/api_client.rb +378 -0
- data/lib/budgea_client/api_error.rb +28 -0
- data/lib/budgea_client/configuration.rb +192 -0
- data/lib/budgea_client/models/access.rb +224 -0
- data/lib/budgea_client/models/account.rb +383 -0
- data/lib/budgea_client/models/account_log.rb +266 -0
- data/lib/budgea_client/models/account_type.rb +281 -0
- data/lib/budgea_client/models/alert.rb +273 -0
- data/lib/budgea_client/models/bank.rb +308 -0
- data/lib/budgea_client/models/bank_category.rb +201 -0
- data/lib/budgea_client/models/category.rb +299 -0
- data/lib/budgea_client/models/client.rb +305 -0
- data/lib/budgea_client/models/connection.rb +276 -0
- data/lib/budgea_client/models/connection_contact.rb +274 -0
- data/lib/budgea_client/models/connection_log.rb +324 -0
- data/lib/budgea_client/models/connector_logo.rb +223 -0
- data/lib/budgea_client/models/currency.rb +216 -0
- data/lib/budgea_client/models/device.rb +269 -0
- data/lib/budgea_client/models/document.rb +398 -0
- data/lib/budgea_client/models/document_type.rb +213 -0
- data/lib/budgea_client/models/field.rb +273 -0
- data/lib/budgea_client/models/file.rb +225 -0
- data/lib/budgea_client/models/group.rb +246 -0
- data/lib/budgea_client/models/hash_table.rb +227 -0
- data/lib/budgea_client/models/inline_response_200.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_1.rb +199 -0
- data/lib/budgea_client/models/inline_response_200_10.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_11.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_12.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_13.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_14.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_15.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_16.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_17.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_18.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_19.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_2.rb +209 -0
- data/lib/budgea_client/models/inline_response_200_20.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_21.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_22.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_23.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_24.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_25.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_26.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_27.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_28.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_29.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_3.rb +214 -0
- data/lib/budgea_client/models/inline_response_200_30.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_31.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_32.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_33.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_4.rb +239 -0
- data/lib/budgea_client/models/inline_response_200_5.rb +199 -0
- data/lib/budgea_client/models/inline_response_200_6.rb +214 -0
- data/lib/budgea_client/models/inline_response_200_7.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_8.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_9.rb +185 -0
- data/lib/budgea_client/models/investment.rb +449 -0
- data/lib/budgea_client/models/investment_value.rb +249 -0
- data/lib/budgea_client/models/invite.rb +233 -0
- data/lib/budgea_client/models/locked_user.rb +206 -0
- data/lib/budgea_client/models/oidc_whitelist.rb +198 -0
- data/lib/budgea_client/models/pocket.rb +298 -0
- data/lib/budgea_client/models/profile.rb +308 -0
- data/lib/budgea_client/models/project.rb +301 -0
- data/lib/budgea_client/models/project_type.rb +206 -0
- data/lib/budgea_client/models/recipient.rb +343 -0
- data/lib/budgea_client/models/security.rb +229 -0
- data/lib/budgea_client/models/subscription.rb +299 -0
- data/lib/budgea_client/models/terms_of_service.rb +229 -0
- data/lib/budgea_client/models/transaction.rb +507 -0
- data/lib/budgea_client/models/transaction_information.rb +224 -0
- data/lib/budgea_client/models/transactions_cluster.rb +277 -0
- data/lib/budgea_client/models/transfer.rb +354 -0
- data/lib/budgea_client/models/user.rb +244 -0
- data/lib/budgea_client/models/user_alert.rb +333 -0
- data/lib/budgea_client/models/webhook.rb +264 -0
- data/lib/budgea_client/version.rb +5 -0
- data/pkg/budgea_client-1.0.0.gem +0 -0
- data/spec/api/administration_api_spec.rb +271 -0
- data/spec/api/authentication_api_spec.rb +126 -0
- data/spec/api/banks_api_spec.rb +1787 -0
- data/spec/api/connections_api_spec.rb +279 -0
- data/spec/api/documents_api_spec.rb +1557 -0
- data/spec/api/ocr_api_spec.rb +54 -0
- data/spec/api/oidc_api_spec.rb +65 -0
- data/spec/api/pfm_api_spec.rb +613 -0
- data/spec/api/providers_api_spec.rb +2029 -0
- data/spec/api/recipients_api_spec.rb +89 -0
- data/spec/api/terms_api_spec.rb +79 -0
- data/spec/api/transfers_api_spec.rb +661 -0
- data/spec/api/users_management_api_spec.rb +177 -0
- data/spec/api/wealth_api_spec.rb +246 -0
- data/spec/api_client_spec.rb +216 -0
- data/spec/configuration_spec.rb +32 -0
- data/spec/models/access_spec.rb +56 -0
- data/spec/models/account_log_spec.rb +74 -0
- data/spec/models/account_spec.rb +134 -0
- data/spec/models/account_type_spec.rb +74 -0
- data/spec/models/alert_spec.rb +74 -0
- data/spec/models/bank_category_spec.rb +38 -0
- data/spec/models/bank_spec.rb +92 -0
- data/spec/models/category_spec.rb +86 -0
- data/spec/models/client_spec.rb +92 -0
- data/spec/models/connection_contact_spec.rb +86 -0
- data/spec/models/connection_log_spec.rb +110 -0
- data/spec/models/connection_spec.rb +80 -0
- data/spec/models/connector_logo_spec.rb +50 -0
- data/spec/models/currency_spec.rb +44 -0
- data/spec/models/device_spec.rb +68 -0
- data/spec/models/document_spec.rb +158 -0
- data/spec/models/document_type_spec.rb +44 -0
- data/spec/models/field_spec.rb +74 -0
- data/spec/models/file_spec.rb +50 -0
- data/spec/models/group_spec.rb +74 -0
- data/spec/models/hash_table_spec.rb +50 -0
- data/spec/models/inline_response_200_10_spec.rb +32 -0
- data/spec/models/inline_response_200_11_spec.rb +32 -0
- data/spec/models/inline_response_200_12_spec.rb +32 -0
- data/spec/models/inline_response_200_13_spec.rb +32 -0
- data/spec/models/inline_response_200_14_spec.rb +32 -0
- data/spec/models/inline_response_200_15_spec.rb +32 -0
- data/spec/models/inline_response_200_16_spec.rb +32 -0
- data/spec/models/inline_response_200_17_spec.rb +32 -0
- data/spec/models/inline_response_200_18_spec.rb +32 -0
- data/spec/models/inline_response_200_19_spec.rb +32 -0
- data/spec/models/inline_response_200_1_spec.rb +38 -0
- data/spec/models/inline_response_200_20_spec.rb +32 -0
- data/spec/models/inline_response_200_21_spec.rb +32 -0
- data/spec/models/inline_response_200_22_spec.rb +32 -0
- data/spec/models/inline_response_200_23_spec.rb +32 -0
- data/spec/models/inline_response_200_24_spec.rb +32 -0
- data/spec/models/inline_response_200_25_spec.rb +32 -0
- data/spec/models/inline_response_200_26_spec.rb +32 -0
- data/spec/models/inline_response_200_27_spec.rb +32 -0
- data/spec/models/inline_response_200_28_spec.rb +32 -0
- data/spec/models/inline_response_200_29_spec.rb +32 -0
- data/spec/models/inline_response_200_2_spec.rb +44 -0
- data/spec/models/inline_response_200_30_spec.rb +32 -0
- data/spec/models/inline_response_200_31_spec.rb +32 -0
- data/spec/models/inline_response_200_32_spec.rb +32 -0
- data/spec/models/inline_response_200_33_spec.rb +32 -0
- data/spec/models/inline_response_200_3_spec.rb +44 -0
- data/spec/models/inline_response_200_4_spec.rb +56 -0
- data/spec/models/inline_response_200_5_spec.rb +38 -0
- data/spec/models/inline_response_200_6_spec.rb +44 -0
- data/spec/models/inline_response_200_7_spec.rb +32 -0
- data/spec/models/inline_response_200_8_spec.rb +32 -0
- data/spec/models/inline_response_200_9_spec.rb +32 -0
- data/spec/models/inline_response_200_spec.rb +32 -0
- data/spec/models/investment_spec.rb +176 -0
- data/spec/models/investment_value_spec.rb +62 -0
- data/spec/models/invite_spec.rb +62 -0
- data/spec/models/locked_user_spec.rb +44 -0
- data/spec/models/oidc_whitelist_spec.rb +38 -0
- data/spec/models/pocket_spec.rb +86 -0
- data/spec/models/profile_spec.rb +78 -0
- data/spec/models/project_spec.rb +80 -0
- data/spec/models/project_type_spec.rb +44 -0
- data/spec/models/recipient_spec.rb +116 -0
- data/spec/models/security_spec.rb +56 -0
- data/spec/models/subscription_spec.rb +92 -0
- data/spec/models/terms_of_service_spec.rb +56 -0
- data/spec/models/transaction_information_spec.rb +50 -0
- data/spec/models/transaction_spec.rb +182 -0
- data/spec/models/transactions_cluster_spec.rb +80 -0
- data/spec/models/transfer_spec.rb +122 -0
- data/spec/models/user_alert_spec.rb +110 -0
- data/spec/models/user_spec.rb +48 -0
- data/spec/models/webhook_spec.rb +74 -0
- data/spec/spec_helper.rb +51 -0
- metadata +599 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# BudgeaClient::TermsOfService
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**version** | **String** | |
|
|
8
|
+
**id_file** | **Integer** | | [optional]
|
|
9
|
+
**created** | **DateTime** | |
|
|
10
|
+
**deleted** | **DateTime** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/Transaction.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# BudgeaClient::Transaction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of the transaction |
|
|
7
|
+
**id_account** | **Integer** | ID of the related account |
|
|
8
|
+
**webid** | **String** | Webid of the transaction | [optional]
|
|
9
|
+
**application_date** | **Date** | Date considered by PFM services. It is used to change the month of a transaction, for example. | [optional]
|
|
10
|
+
**date** | **Date** | Debit date |
|
|
11
|
+
**value** | **Float** | Value of the transaction |
|
|
12
|
+
**nature** | **String** | Type of transaction | [default to "inconnu"]
|
|
13
|
+
**original_wording** | **String** | Full label of the transaction |
|
|
14
|
+
**simplified_wording** | **String** | Simplified label of the transaction |
|
|
15
|
+
**stemmed_wording** | **String** | Do not use it |
|
|
16
|
+
**wording** | **String** | Label set by the user | [optional]
|
|
17
|
+
**id_category** | **Integer** | ID of the related category | [optional]
|
|
18
|
+
**state** | **String** | Internal state of the transaction | [default to "new"]
|
|
19
|
+
**date_scraped** | **DateTime** | Date when the transaction has been seen |
|
|
20
|
+
**rdate** | **Date** | Realization of the transaction |
|
|
21
|
+
**coming** | **BOOLEAN** | If true, this transaction hasn't been yet debited |
|
|
22
|
+
**active** | **BOOLEAN** | If false, PFM services will ignore this transaction | [default to true]
|
|
23
|
+
**id_cluster** | **Integer** | If the transaction is part of a cluster | [optional]
|
|
24
|
+
**comment** | **String** | User comment | [optional]
|
|
25
|
+
**last_update** | **DateTime** | Last update of the transaction | [optional]
|
|
26
|
+
**deleted** | **DateTime** | If set, this transaction has been removed from the bank | [optional]
|
|
27
|
+
**nopurge** | **BOOLEAN** | If set to true, this transaction will never be considered as deleted | [default to false]
|
|
28
|
+
**original_value** | **Float** | Value in the original currency | [optional]
|
|
29
|
+
**original_currency** | **Object** | Original currency | [optional]
|
|
30
|
+
**commission** | **Float** | Commission taken on the transaction | [optional]
|
|
31
|
+
**country** | **String** | Original country | [optional]
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# BudgeaClient::TransactionInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of this transaction information |
|
|
7
|
+
**id_transaction** | **Integer** | ID of the related transaction |
|
|
8
|
+
**key** | **String** | Key of the transaction information |
|
|
9
|
+
**value** | **String** | Value of the transaction information | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# BudgeaClient::TransactionsCluster
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**id_account** | **Integer** | |
|
|
8
|
+
**mean_amount** | **Float** | |
|
|
9
|
+
**median_increment** | **Integer** | | [optional]
|
|
10
|
+
**enabled** | **BOOLEAN** | | [default to true]
|
|
11
|
+
**next_date** | **Date** | | [optional]
|
|
12
|
+
**wording** | **String** | |
|
|
13
|
+
**id_category** | **Integer** | | [optional]
|
|
14
|
+
**created_by** | **String** | | [optional]
|
|
15
|
+
|
|
16
|
+
|
data/docs/Transfer.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BudgeaClient::Transfer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of transfer |
|
|
7
|
+
**id_account** | **Integer** | ID of the debited account | [optional]
|
|
8
|
+
**id_recipient** | **Integer** | ID of the recipient | [optional]
|
|
9
|
+
**account_iban** | **String** | IBAN of the debited account | [optional]
|
|
10
|
+
**recipient_iban** | **String** | IBAN of the recipient | [optional]
|
|
11
|
+
**exec_date** | **Date** | Date when the transfer will be operated by the bank |
|
|
12
|
+
**register_date** | **DateTime** | Date when the transfer has been registered |
|
|
13
|
+
**amount** | **Float** | Amount of the transfer |
|
|
14
|
+
**fees** | **Float** | Fees taken by the bank | [optional]
|
|
15
|
+
**webid** | **String** | WebID of the transfer | [optional]
|
|
16
|
+
**state** | **String** | State of the transfer (created, scheduled, validating, pending, done, canceled, error, bug) |
|
|
17
|
+
**error** | **String** | Error message during transfer, if any | [optional]
|
|
18
|
+
**label** | **String** | Label of the transfer | [optional]
|
|
19
|
+
**account_balance** | **Float** | Balance of the account just before the transfer | [optional]
|
|
20
|
+
**id_transaction** | **Integer** | If found, ID of the related transaction | [optional]
|
|
21
|
+
**currency** | **Object** | Currency of the object | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,2404 @@
|
|
|
1
|
+
# BudgeaClient::TransfersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**users_id_user_accounts_id_account_recipients_get**](TransfersApi.md#users_id_user_accounts_id_account_recipients_get) | **GET** /users/{id_user}/accounts/{id_account}/recipients | Returns the list of recipients
|
|
8
|
+
[**users_id_user_accounts_id_account_recipients_id_recipient_post**](TransfersApi.md#users_id_user_accounts_id_account_recipients_id_recipient_post) | **POST** /users/{id_user}/accounts/{id_account}/recipients/{id_recipient} | Continue addition of a recipient.
|
|
9
|
+
[**users_id_user_accounts_id_account_recipients_id_recipient_transfers_get**](TransfersApi.md#users_id_user_accounts_id_account_recipients_id_recipient_transfers_get) | **GET** /users/{id_user}/accounts/{id_account}/recipients/{id_recipient}/transfers | Get transfers
|
|
10
|
+
[**users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/recipients/{id_recipient}/transfers/{id_transfer} | Cancel a transfer.
|
|
11
|
+
[**users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post**](TransfersApi.md#users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post) | **POST** /users/{id_user}/accounts/{id_account}/recipients/{id_recipient}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
12
|
+
[**users_id_user_accounts_id_account_recipients_id_recipient_transfers_post**](TransfersApi.md#users_id_user_accounts_id_account_recipients_id_recipient_transfers_post) | **POST** /users/{id_user}/accounts/{id_account}/recipients/{id_recipient}/transfers | Create a transfer object.
|
|
13
|
+
[**users_id_user_accounts_id_account_transfers_get**](TransfersApi.md#users_id_user_accounts_id_account_transfers_get) | **GET** /users/{id_user}/accounts/{id_account}/transfers | Get transfers
|
|
14
|
+
[**users_id_user_accounts_id_account_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_accounts_id_account_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/transfers/{id_transfer} | Cancel a transfer.
|
|
15
|
+
[**users_id_user_accounts_id_account_transfers_id_transfer_post**](TransfersApi.md#users_id_user_accounts_id_account_transfers_id_transfer_post) | **POST** /users/{id_user}/accounts/{id_account}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
16
|
+
[**users_id_user_accounts_id_account_transfers_post**](TransfersApi.md#users_id_user_accounts_id_account_transfers_post) | **POST** /users/{id_user}/accounts/{id_account}/transfers | Create a transfer object.
|
|
17
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_get**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients | Returns the list of recipients
|
|
18
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients/{id_recipient} | Continue addition of a recipient.
|
|
19
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients/{id_recipient}/transfers | Get transfers
|
|
20
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients/{id_recipient}/transfers/{id_transfer} | Cancel a transfer.
|
|
21
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients/{id_recipient}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
22
|
+
[**users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients/{id_recipient}/transfers | Create a transfer object.
|
|
23
|
+
[**users_id_user_connections_id_connection_accounts_id_account_transfers_get**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_transfers_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transfers | Get transfers
|
|
24
|
+
[**users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transfers/{id_transfer} | Cancel a transfer.
|
|
25
|
+
[**users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
26
|
+
[**users_id_user_connections_id_connection_accounts_id_account_transfers_post**](TransfersApi.md#users_id_user_connections_id_connection_accounts_id_account_transfers_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transfers | Create a transfer object.
|
|
27
|
+
[**users_id_user_connections_id_connection_recipients_get**](TransfersApi.md#users_id_user_connections_id_connection_recipients_get) | **GET** /users/{id_user}/connections/{id_connection}/recipients | Returns the list of recipients
|
|
28
|
+
[**users_id_user_connections_id_connection_recipients_id_recipient_post**](TransfersApi.md#users_id_user_connections_id_connection_recipients_id_recipient_post) | **POST** /users/{id_user}/connections/{id_connection}/recipients/{id_recipient} | Continue addition of a recipient.
|
|
29
|
+
[**users_id_user_connections_id_connection_recipients_id_recipient_transfers_get**](TransfersApi.md#users_id_user_connections_id_connection_recipients_id_recipient_transfers_get) | **GET** /users/{id_user}/connections/{id_connection}/recipients/{id_recipient}/transfers | Get transfers
|
|
30
|
+
[**users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/recipients/{id_recipient}/transfers/{id_transfer} | Cancel a transfer.
|
|
31
|
+
[**users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post**](TransfersApi.md#users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post) | **POST** /users/{id_user}/connections/{id_connection}/recipients/{id_recipient}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
32
|
+
[**users_id_user_connections_id_connection_recipients_id_recipient_transfers_post**](TransfersApi.md#users_id_user_connections_id_connection_recipients_id_recipient_transfers_post) | **POST** /users/{id_user}/connections/{id_connection}/recipients/{id_recipient}/transfers | Create a transfer object.
|
|
33
|
+
[**users_id_user_connections_id_connection_transfers_get**](TransfersApi.md#users_id_user_connections_id_connection_transfers_get) | **GET** /users/{id_user}/connections/{id_connection}/transfers | Get transfers
|
|
34
|
+
[**users_id_user_connections_id_connection_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_connections_id_connection_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/transfers/{id_transfer} | Cancel a transfer.
|
|
35
|
+
[**users_id_user_connections_id_connection_transfers_id_transfer_post**](TransfersApi.md#users_id_user_connections_id_connection_transfers_id_transfer_post) | **POST** /users/{id_user}/connections/{id_connection}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
36
|
+
[**users_id_user_connections_id_connection_transfers_post**](TransfersApi.md#users_id_user_connections_id_connection_transfers_post) | **POST** /users/{id_user}/connections/{id_connection}/transfers | Create a transfer object.
|
|
37
|
+
[**users_id_user_recipients_get**](TransfersApi.md#users_id_user_recipients_get) | **GET** /users/{id_user}/recipients | Returns the list of recipients
|
|
38
|
+
[**users_id_user_recipients_id_recipient_post**](TransfersApi.md#users_id_user_recipients_id_recipient_post) | **POST** /users/{id_user}/recipients/{id_recipient} | Continue addition of a recipient.
|
|
39
|
+
[**users_id_user_recipients_id_recipient_transfers_get**](TransfersApi.md#users_id_user_recipients_id_recipient_transfers_get) | **GET** /users/{id_user}/recipients/{id_recipient}/transfers | Get transfers
|
|
40
|
+
[**users_id_user_recipients_id_recipient_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_recipients_id_recipient_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/recipients/{id_recipient}/transfers/{id_transfer} | Cancel a transfer.
|
|
41
|
+
[**users_id_user_recipients_id_recipient_transfers_id_transfer_post**](TransfersApi.md#users_id_user_recipients_id_recipient_transfers_id_transfer_post) | **POST** /users/{id_user}/recipients/{id_recipient}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
42
|
+
[**users_id_user_recipients_id_recipient_transfers_post**](TransfersApi.md#users_id_user_recipients_id_recipient_transfers_post) | **POST** /users/{id_user}/recipients/{id_recipient}/transfers | Create a transfer object.
|
|
43
|
+
[**users_id_user_transfers_get**](TransfersApi.md#users_id_user_transfers_get) | **GET** /users/{id_user}/transfers | Get transfers
|
|
44
|
+
[**users_id_user_transfers_id_transfer_delete**](TransfersApi.md#users_id_user_transfers_id_transfer_delete) | **DELETE** /users/{id_user}/transfers/{id_transfer} | Cancel a transfer.
|
|
45
|
+
[**users_id_user_transfers_id_transfer_post**](TransfersApi.md#users_id_user_transfers_id_transfer_post) | **POST** /users/{id_user}/transfers/{id_transfer} | Execute or edit a Transfer.
|
|
46
|
+
[**users_id_user_transfers_post**](TransfersApi.md#users_id_user_transfers_post) | **POST** /users/{id_user}/transfers | Create a transfer object.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
# **users_id_user_accounts_id_account_recipients_get**
|
|
50
|
+
> InlineResponse20023 users_id_user_accounts_id_account_recipients_get(id_user, id_account, opts)
|
|
51
|
+
|
|
52
|
+
Returns the list of recipients
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Example
|
|
57
|
+
```ruby
|
|
58
|
+
# load the gem
|
|
59
|
+
require 'budgea_client'
|
|
60
|
+
|
|
61
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
62
|
+
|
|
63
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
64
|
+
|
|
65
|
+
id_account = 56 # Integer |
|
|
66
|
+
|
|
67
|
+
opts = {
|
|
68
|
+
expand: "expand_example" # String |
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
#Returns the list of recipients
|
|
73
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_get(id_user, id_account, opts)
|
|
74
|
+
p result
|
|
75
|
+
rescue BudgeaClient::ApiError => e
|
|
76
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_get: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
Name | Type | Description | Notes
|
|
83
|
+
------------- | ------------- | ------------- | -------------
|
|
84
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
85
|
+
**id_account** | **Integer**| |
|
|
86
|
+
**expand** | **String**| | [optional]
|
|
87
|
+
|
|
88
|
+
### Return type
|
|
89
|
+
|
|
90
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
91
|
+
|
|
92
|
+
### Authorization
|
|
93
|
+
|
|
94
|
+
No authorization required
|
|
95
|
+
|
|
96
|
+
### HTTP request headers
|
|
97
|
+
|
|
98
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
99
|
+
- **Accept**: application/json
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
# **users_id_user_accounts_id_account_recipients_id_recipient_post**
|
|
104
|
+
> Recipient users_id_user_accounts_id_account_recipients_id_recipient_post(id_user, id_account, id_recipient, opts)
|
|
105
|
+
|
|
106
|
+
Continue addition of a recipient.
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### Example
|
|
111
|
+
```ruby
|
|
112
|
+
# load the gem
|
|
113
|
+
require 'budgea_client'
|
|
114
|
+
|
|
115
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
116
|
+
|
|
117
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
118
|
+
|
|
119
|
+
id_account = 56 # Integer |
|
|
120
|
+
|
|
121
|
+
id_recipient = 56 # Integer |
|
|
122
|
+
|
|
123
|
+
opts = {
|
|
124
|
+
expand: "expand_example" # String |
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
begin
|
|
128
|
+
#Continue addition of a recipient.
|
|
129
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_id_recipient_post(id_user, id_account, id_recipient, opts)
|
|
130
|
+
p result
|
|
131
|
+
rescue BudgeaClient::ApiError => e
|
|
132
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_id_recipient_post: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
Name | Type | Description | Notes
|
|
139
|
+
------------- | ------------- | ------------- | -------------
|
|
140
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
141
|
+
**id_account** | **Integer**| |
|
|
142
|
+
**id_recipient** | **Integer**| |
|
|
143
|
+
**expand** | **String**| | [optional]
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**Recipient**](Recipient.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
No authorization required
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
# **users_id_user_accounts_id_account_recipients_id_recipient_transfers_get**
|
|
161
|
+
> InlineResponse20024 users_id_user_accounts_id_account_recipients_id_recipient_transfers_get(id_user, id_account, id_recipient, opts)
|
|
162
|
+
|
|
163
|
+
Get transfers
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
### Example
|
|
168
|
+
```ruby
|
|
169
|
+
# load the gem
|
|
170
|
+
require 'budgea_client'
|
|
171
|
+
|
|
172
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
173
|
+
|
|
174
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
175
|
+
|
|
176
|
+
id_account = 56 # Integer |
|
|
177
|
+
|
|
178
|
+
id_recipient = 56 # Integer |
|
|
179
|
+
|
|
180
|
+
opts = {
|
|
181
|
+
period: "period_example", # String | period to group logs
|
|
182
|
+
expand: "expand_example" # String |
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
begin
|
|
186
|
+
#Get transfers
|
|
187
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_id_recipient_transfers_get(id_user, id_account, id_recipient, opts)
|
|
188
|
+
p result
|
|
189
|
+
rescue BudgeaClient::ApiError => e
|
|
190
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_id_recipient_transfers_get: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
Name | Type | Description | Notes
|
|
197
|
+
------------- | ------------- | ------------- | -------------
|
|
198
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
199
|
+
**id_account** | **Integer**| |
|
|
200
|
+
**id_recipient** | **Integer**| |
|
|
201
|
+
**period** | **String**| period to group logs | [optional]
|
|
202
|
+
**expand** | **String**| | [optional]
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
No authorization required
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
# **users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete**
|
|
220
|
+
> Transfer users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_account, id_recipient, id_transfer, opts)
|
|
221
|
+
|
|
222
|
+
Cancel a transfer.
|
|
223
|
+
|
|
224
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
225
|
+
|
|
226
|
+
### Example
|
|
227
|
+
```ruby
|
|
228
|
+
# load the gem
|
|
229
|
+
require 'budgea_client'
|
|
230
|
+
|
|
231
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
232
|
+
|
|
233
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
234
|
+
|
|
235
|
+
id_account = 56 # Integer |
|
|
236
|
+
|
|
237
|
+
id_recipient = 56 # Integer |
|
|
238
|
+
|
|
239
|
+
id_transfer = 56 # Integer |
|
|
240
|
+
|
|
241
|
+
opts = {
|
|
242
|
+
expand: "expand_example" # String |
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
begin
|
|
246
|
+
#Cancel a transfer.
|
|
247
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_account, id_recipient, id_transfer, opts)
|
|
248
|
+
p result
|
|
249
|
+
rescue BudgeaClient::ApiError => e
|
|
250
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete: #{e}"
|
|
251
|
+
end
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Parameters
|
|
255
|
+
|
|
256
|
+
Name | Type | Description | Notes
|
|
257
|
+
------------- | ------------- | ------------- | -------------
|
|
258
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
259
|
+
**id_account** | **Integer**| |
|
|
260
|
+
**id_recipient** | **Integer**| |
|
|
261
|
+
**id_transfer** | **Integer**| |
|
|
262
|
+
**expand** | **String**| | [optional]
|
|
263
|
+
|
|
264
|
+
### Return type
|
|
265
|
+
|
|
266
|
+
[**Transfer**](Transfer.md)
|
|
267
|
+
|
|
268
|
+
### Authorization
|
|
269
|
+
|
|
270
|
+
No authorization required
|
|
271
|
+
|
|
272
|
+
### HTTP request headers
|
|
273
|
+
|
|
274
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
275
|
+
- **Accept**: application/json
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
# **users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post**
|
|
280
|
+
> Transfer users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post(id_user, id_account, id_recipient, id_transfer, opts)
|
|
281
|
+
|
|
282
|
+
Execute or edit a Transfer.
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### Example
|
|
287
|
+
```ruby
|
|
288
|
+
# load the gem
|
|
289
|
+
require 'budgea_client'
|
|
290
|
+
|
|
291
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
292
|
+
|
|
293
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
294
|
+
|
|
295
|
+
id_account = 56 # Integer |
|
|
296
|
+
|
|
297
|
+
id_recipient = 56 # Integer |
|
|
298
|
+
|
|
299
|
+
id_transfer = 56 # Integer |
|
|
300
|
+
|
|
301
|
+
opts = {
|
|
302
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
303
|
+
expand: "expand_example" # String |
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
begin
|
|
307
|
+
#Execute or edit a Transfer.
|
|
308
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post(id_user, id_account, id_recipient, id_transfer, opts)
|
|
309
|
+
p result
|
|
310
|
+
rescue BudgeaClient::ApiError => e
|
|
311
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post: #{e}"
|
|
312
|
+
end
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Parameters
|
|
316
|
+
|
|
317
|
+
Name | Type | Description | Notes
|
|
318
|
+
------------- | ------------- | ------------- | -------------
|
|
319
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
320
|
+
**id_account** | **Integer**| |
|
|
321
|
+
**id_recipient** | **Integer**| |
|
|
322
|
+
**id_transfer** | **Integer**| |
|
|
323
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
324
|
+
**expand** | **String**| | [optional]
|
|
325
|
+
|
|
326
|
+
### Return type
|
|
327
|
+
|
|
328
|
+
[**Transfer**](Transfer.md)
|
|
329
|
+
|
|
330
|
+
### Authorization
|
|
331
|
+
|
|
332
|
+
No authorization required
|
|
333
|
+
|
|
334
|
+
### HTTP request headers
|
|
335
|
+
|
|
336
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
337
|
+
- **Accept**: application/json
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
# **users_id_user_accounts_id_account_recipients_id_recipient_transfers_post**
|
|
342
|
+
> Transfer users_id_user_accounts_id_account_recipients_id_recipient_transfers_post(id_user, id_account, id_recipient, amount, opts)
|
|
343
|
+
|
|
344
|
+
Create a transfer object.
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
### Example
|
|
349
|
+
```ruby
|
|
350
|
+
# load the gem
|
|
351
|
+
require 'budgea_client'
|
|
352
|
+
|
|
353
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
354
|
+
|
|
355
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
356
|
+
|
|
357
|
+
id_account = 56 # Integer |
|
|
358
|
+
|
|
359
|
+
id_recipient = 56 # Integer |
|
|
360
|
+
|
|
361
|
+
amount = 3.4 # Float | amount of transfer
|
|
362
|
+
|
|
363
|
+
opts = {
|
|
364
|
+
label: "label_example", # String | reason of transfer
|
|
365
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
366
|
+
expand: "expand_example" # String |
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
begin
|
|
370
|
+
#Create a transfer object.
|
|
371
|
+
result = api_instance.users_id_user_accounts_id_account_recipients_id_recipient_transfers_post(id_user, id_account, id_recipient, amount, opts)
|
|
372
|
+
p result
|
|
373
|
+
rescue BudgeaClient::ApiError => e
|
|
374
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_recipients_id_recipient_transfers_post: #{e}"
|
|
375
|
+
end
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### Parameters
|
|
379
|
+
|
|
380
|
+
Name | Type | Description | Notes
|
|
381
|
+
------------- | ------------- | ------------- | -------------
|
|
382
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
383
|
+
**id_account** | **Integer**| |
|
|
384
|
+
**id_recipient** | **Integer**| |
|
|
385
|
+
**amount** | **Float**| amount of transfer |
|
|
386
|
+
**label** | **String**| reason of transfer | [optional]
|
|
387
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
388
|
+
**expand** | **String**| | [optional]
|
|
389
|
+
|
|
390
|
+
### Return type
|
|
391
|
+
|
|
392
|
+
[**Transfer**](Transfer.md)
|
|
393
|
+
|
|
394
|
+
### Authorization
|
|
395
|
+
|
|
396
|
+
No authorization required
|
|
397
|
+
|
|
398
|
+
### HTTP request headers
|
|
399
|
+
|
|
400
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
401
|
+
- **Accept**: application/json
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
# **users_id_user_accounts_id_account_transfers_get**
|
|
406
|
+
> InlineResponse20024 users_id_user_accounts_id_account_transfers_get(id_user, id_account, opts)
|
|
407
|
+
|
|
408
|
+
Get transfers
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
### Example
|
|
413
|
+
```ruby
|
|
414
|
+
# load the gem
|
|
415
|
+
require 'budgea_client'
|
|
416
|
+
|
|
417
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
418
|
+
|
|
419
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
420
|
+
|
|
421
|
+
id_account = 56 # Integer |
|
|
422
|
+
|
|
423
|
+
opts = {
|
|
424
|
+
period: "period_example", # String | period to group logs
|
|
425
|
+
expand: "expand_example" # String |
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
begin
|
|
429
|
+
#Get transfers
|
|
430
|
+
result = api_instance.users_id_user_accounts_id_account_transfers_get(id_user, id_account, opts)
|
|
431
|
+
p result
|
|
432
|
+
rescue BudgeaClient::ApiError => e
|
|
433
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_transfers_get: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### Parameters
|
|
438
|
+
|
|
439
|
+
Name | Type | Description | Notes
|
|
440
|
+
------------- | ------------- | ------------- | -------------
|
|
441
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
442
|
+
**id_account** | **Integer**| |
|
|
443
|
+
**period** | **String**| period to group logs | [optional]
|
|
444
|
+
**expand** | **String**| | [optional]
|
|
445
|
+
|
|
446
|
+
### Return type
|
|
447
|
+
|
|
448
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
449
|
+
|
|
450
|
+
### Authorization
|
|
451
|
+
|
|
452
|
+
No authorization required
|
|
453
|
+
|
|
454
|
+
### HTTP request headers
|
|
455
|
+
|
|
456
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
457
|
+
- **Accept**: application/json
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
# **users_id_user_accounts_id_account_transfers_id_transfer_delete**
|
|
462
|
+
> Transfer users_id_user_accounts_id_account_transfers_id_transfer_delete(id_user, id_account, id_transfer, opts)
|
|
463
|
+
|
|
464
|
+
Cancel a transfer.
|
|
465
|
+
|
|
466
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
467
|
+
|
|
468
|
+
### Example
|
|
469
|
+
```ruby
|
|
470
|
+
# load the gem
|
|
471
|
+
require 'budgea_client'
|
|
472
|
+
|
|
473
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
474
|
+
|
|
475
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
476
|
+
|
|
477
|
+
id_account = 56 # Integer |
|
|
478
|
+
|
|
479
|
+
id_transfer = 56 # Integer |
|
|
480
|
+
|
|
481
|
+
opts = {
|
|
482
|
+
expand: "expand_example" # String |
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
begin
|
|
486
|
+
#Cancel a transfer.
|
|
487
|
+
result = api_instance.users_id_user_accounts_id_account_transfers_id_transfer_delete(id_user, id_account, id_transfer, opts)
|
|
488
|
+
p result
|
|
489
|
+
rescue BudgeaClient::ApiError => e
|
|
490
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_transfers_id_transfer_delete: #{e}"
|
|
491
|
+
end
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### Parameters
|
|
495
|
+
|
|
496
|
+
Name | Type | Description | Notes
|
|
497
|
+
------------- | ------------- | ------------- | -------------
|
|
498
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
499
|
+
**id_account** | **Integer**| |
|
|
500
|
+
**id_transfer** | **Integer**| |
|
|
501
|
+
**expand** | **String**| | [optional]
|
|
502
|
+
|
|
503
|
+
### Return type
|
|
504
|
+
|
|
505
|
+
[**Transfer**](Transfer.md)
|
|
506
|
+
|
|
507
|
+
### Authorization
|
|
508
|
+
|
|
509
|
+
No authorization required
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
514
|
+
- **Accept**: application/json
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
# **users_id_user_accounts_id_account_transfers_id_transfer_post**
|
|
519
|
+
> Transfer users_id_user_accounts_id_account_transfers_id_transfer_post(id_user, id_account, id_transfer, opts)
|
|
520
|
+
|
|
521
|
+
Execute or edit a Transfer.
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
### Example
|
|
526
|
+
```ruby
|
|
527
|
+
# load the gem
|
|
528
|
+
require 'budgea_client'
|
|
529
|
+
|
|
530
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
531
|
+
|
|
532
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
533
|
+
|
|
534
|
+
id_account = 56 # Integer |
|
|
535
|
+
|
|
536
|
+
id_transfer = 56 # Integer |
|
|
537
|
+
|
|
538
|
+
opts = {
|
|
539
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
540
|
+
expand: "expand_example" # String |
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
begin
|
|
544
|
+
#Execute or edit a Transfer.
|
|
545
|
+
result = api_instance.users_id_user_accounts_id_account_transfers_id_transfer_post(id_user, id_account, id_transfer, opts)
|
|
546
|
+
p result
|
|
547
|
+
rescue BudgeaClient::ApiError => e
|
|
548
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_transfers_id_transfer_post: #{e}"
|
|
549
|
+
end
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
### Parameters
|
|
553
|
+
|
|
554
|
+
Name | Type | Description | Notes
|
|
555
|
+
------------- | ------------- | ------------- | -------------
|
|
556
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
557
|
+
**id_account** | **Integer**| |
|
|
558
|
+
**id_transfer** | **Integer**| |
|
|
559
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
560
|
+
**expand** | **String**| | [optional]
|
|
561
|
+
|
|
562
|
+
### Return type
|
|
563
|
+
|
|
564
|
+
[**Transfer**](Transfer.md)
|
|
565
|
+
|
|
566
|
+
### Authorization
|
|
567
|
+
|
|
568
|
+
No authorization required
|
|
569
|
+
|
|
570
|
+
### HTTP request headers
|
|
571
|
+
|
|
572
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
573
|
+
- **Accept**: application/json
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
# **users_id_user_accounts_id_account_transfers_post**
|
|
578
|
+
> Transfer users_id_user_accounts_id_account_transfers_post(id_user, id_account, amount, opts)
|
|
579
|
+
|
|
580
|
+
Create a transfer object.
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
### Example
|
|
585
|
+
```ruby
|
|
586
|
+
# load the gem
|
|
587
|
+
require 'budgea_client'
|
|
588
|
+
|
|
589
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
590
|
+
|
|
591
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
592
|
+
|
|
593
|
+
id_account = 56 # Integer |
|
|
594
|
+
|
|
595
|
+
amount = 3.4 # Float | amount of transfer
|
|
596
|
+
|
|
597
|
+
opts = {
|
|
598
|
+
label: "label_example", # String | reason of transfer
|
|
599
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
600
|
+
expand: "expand_example" # String |
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
begin
|
|
604
|
+
#Create a transfer object.
|
|
605
|
+
result = api_instance.users_id_user_accounts_id_account_transfers_post(id_user, id_account, amount, opts)
|
|
606
|
+
p result
|
|
607
|
+
rescue BudgeaClient::ApiError => e
|
|
608
|
+
puts "Exception when calling TransfersApi->users_id_user_accounts_id_account_transfers_post: #{e}"
|
|
609
|
+
end
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
### Parameters
|
|
613
|
+
|
|
614
|
+
Name | Type | Description | Notes
|
|
615
|
+
------------- | ------------- | ------------- | -------------
|
|
616
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
617
|
+
**id_account** | **Integer**| |
|
|
618
|
+
**amount** | **Float**| amount of transfer |
|
|
619
|
+
**label** | **String**| reason of transfer | [optional]
|
|
620
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
621
|
+
**expand** | **String**| | [optional]
|
|
622
|
+
|
|
623
|
+
### Return type
|
|
624
|
+
|
|
625
|
+
[**Transfer**](Transfer.md)
|
|
626
|
+
|
|
627
|
+
### Authorization
|
|
628
|
+
|
|
629
|
+
No authorization required
|
|
630
|
+
|
|
631
|
+
### HTTP request headers
|
|
632
|
+
|
|
633
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
634
|
+
- **Accept**: application/json
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_get**
|
|
639
|
+
> InlineResponse20023 users_id_user_connections_id_connection_accounts_id_account_recipients_get(id_user, id_connection, id_account, opts)
|
|
640
|
+
|
|
641
|
+
Returns the list of recipients
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
### Example
|
|
646
|
+
```ruby
|
|
647
|
+
# load the gem
|
|
648
|
+
require 'budgea_client'
|
|
649
|
+
|
|
650
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
651
|
+
|
|
652
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
653
|
+
|
|
654
|
+
id_connection = 56 # Integer |
|
|
655
|
+
|
|
656
|
+
id_account = 56 # Integer |
|
|
657
|
+
|
|
658
|
+
opts = {
|
|
659
|
+
expand: "expand_example" # String |
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
begin
|
|
663
|
+
#Returns the list of recipients
|
|
664
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_get(id_user, id_connection, id_account, opts)
|
|
665
|
+
p result
|
|
666
|
+
rescue BudgeaClient::ApiError => e
|
|
667
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_get: #{e}"
|
|
668
|
+
end
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### Parameters
|
|
672
|
+
|
|
673
|
+
Name | Type | Description | Notes
|
|
674
|
+
------------- | ------------- | ------------- | -------------
|
|
675
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
676
|
+
**id_connection** | **Integer**| |
|
|
677
|
+
**id_account** | **Integer**| |
|
|
678
|
+
**expand** | **String**| | [optional]
|
|
679
|
+
|
|
680
|
+
### Return type
|
|
681
|
+
|
|
682
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
683
|
+
|
|
684
|
+
### Authorization
|
|
685
|
+
|
|
686
|
+
No authorization required
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post**
|
|
696
|
+
> Recipient users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post(id_user, id_connection, id_account, id_recipient, opts)
|
|
697
|
+
|
|
698
|
+
Continue addition of a recipient.
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
### Example
|
|
703
|
+
```ruby
|
|
704
|
+
# load the gem
|
|
705
|
+
require 'budgea_client'
|
|
706
|
+
|
|
707
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
708
|
+
|
|
709
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
710
|
+
|
|
711
|
+
id_connection = 56 # Integer |
|
|
712
|
+
|
|
713
|
+
id_account = 56 # Integer |
|
|
714
|
+
|
|
715
|
+
id_recipient = 56 # Integer |
|
|
716
|
+
|
|
717
|
+
opts = {
|
|
718
|
+
expand: "expand_example" # String |
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
begin
|
|
722
|
+
#Continue addition of a recipient.
|
|
723
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post(id_user, id_connection, id_account, id_recipient, opts)
|
|
724
|
+
p result
|
|
725
|
+
rescue BudgeaClient::ApiError => e
|
|
726
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_post: #{e}"
|
|
727
|
+
end
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
### Parameters
|
|
731
|
+
|
|
732
|
+
Name | Type | Description | Notes
|
|
733
|
+
------------- | ------------- | ------------- | -------------
|
|
734
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
735
|
+
**id_connection** | **Integer**| |
|
|
736
|
+
**id_account** | **Integer**| |
|
|
737
|
+
**id_recipient** | **Integer**| |
|
|
738
|
+
**expand** | **String**| | [optional]
|
|
739
|
+
|
|
740
|
+
### Return type
|
|
741
|
+
|
|
742
|
+
[**Recipient**](Recipient.md)
|
|
743
|
+
|
|
744
|
+
### Authorization
|
|
745
|
+
|
|
746
|
+
No authorization required
|
|
747
|
+
|
|
748
|
+
### HTTP request headers
|
|
749
|
+
|
|
750
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
751
|
+
- **Accept**: application/json
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get**
|
|
756
|
+
> InlineResponse20024 users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get(id_user, id_connection, id_account, id_recipient, opts)
|
|
757
|
+
|
|
758
|
+
Get transfers
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
### Example
|
|
763
|
+
```ruby
|
|
764
|
+
# load the gem
|
|
765
|
+
require 'budgea_client'
|
|
766
|
+
|
|
767
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
768
|
+
|
|
769
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
770
|
+
|
|
771
|
+
id_connection = 56 # Integer |
|
|
772
|
+
|
|
773
|
+
id_account = 56 # Integer |
|
|
774
|
+
|
|
775
|
+
id_recipient = 56 # Integer |
|
|
776
|
+
|
|
777
|
+
opts = {
|
|
778
|
+
period: "period_example", # String | period to group logs
|
|
779
|
+
expand: "expand_example" # String |
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
begin
|
|
783
|
+
#Get transfers
|
|
784
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get(id_user, id_connection, id_account, id_recipient, opts)
|
|
785
|
+
p result
|
|
786
|
+
rescue BudgeaClient::ApiError => e
|
|
787
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_get: #{e}"
|
|
788
|
+
end
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
### Parameters
|
|
792
|
+
|
|
793
|
+
Name | Type | Description | Notes
|
|
794
|
+
------------- | ------------- | ------------- | -------------
|
|
795
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
796
|
+
**id_connection** | **Integer**| |
|
|
797
|
+
**id_account** | **Integer**| |
|
|
798
|
+
**id_recipient** | **Integer**| |
|
|
799
|
+
**period** | **String**| period to group logs | [optional]
|
|
800
|
+
**expand** | **String**| | [optional]
|
|
801
|
+
|
|
802
|
+
### Return type
|
|
803
|
+
|
|
804
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
805
|
+
|
|
806
|
+
### Authorization
|
|
807
|
+
|
|
808
|
+
No authorization required
|
|
809
|
+
|
|
810
|
+
### HTTP request headers
|
|
811
|
+
|
|
812
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
813
|
+
- **Accept**: application/json
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete**
|
|
818
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_connection, id_account, id_recipient, id_transfer, opts)
|
|
819
|
+
|
|
820
|
+
Cancel a transfer.
|
|
821
|
+
|
|
822
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
823
|
+
|
|
824
|
+
### Example
|
|
825
|
+
```ruby
|
|
826
|
+
# load the gem
|
|
827
|
+
require 'budgea_client'
|
|
828
|
+
|
|
829
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
830
|
+
|
|
831
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
832
|
+
|
|
833
|
+
id_connection = 56 # Integer |
|
|
834
|
+
|
|
835
|
+
id_account = 56 # Integer |
|
|
836
|
+
|
|
837
|
+
id_recipient = 56 # Integer |
|
|
838
|
+
|
|
839
|
+
id_transfer = 56 # Integer |
|
|
840
|
+
|
|
841
|
+
opts = {
|
|
842
|
+
expand: "expand_example" # String |
|
|
843
|
+
}
|
|
844
|
+
|
|
845
|
+
begin
|
|
846
|
+
#Cancel a transfer.
|
|
847
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_connection, id_account, id_recipient, id_transfer, opts)
|
|
848
|
+
p result
|
|
849
|
+
rescue BudgeaClient::ApiError => e
|
|
850
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_delete: #{e}"
|
|
851
|
+
end
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
### Parameters
|
|
855
|
+
|
|
856
|
+
Name | Type | Description | Notes
|
|
857
|
+
------------- | ------------- | ------------- | -------------
|
|
858
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
859
|
+
**id_connection** | **Integer**| |
|
|
860
|
+
**id_account** | **Integer**| |
|
|
861
|
+
**id_recipient** | **Integer**| |
|
|
862
|
+
**id_transfer** | **Integer**| |
|
|
863
|
+
**expand** | **String**| | [optional]
|
|
864
|
+
|
|
865
|
+
### Return type
|
|
866
|
+
|
|
867
|
+
[**Transfer**](Transfer.md)
|
|
868
|
+
|
|
869
|
+
### Authorization
|
|
870
|
+
|
|
871
|
+
No authorization required
|
|
872
|
+
|
|
873
|
+
### HTTP request headers
|
|
874
|
+
|
|
875
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
876
|
+
- **Accept**: application/json
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post**
|
|
881
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post(id_user, id_connection, id_account, id_recipient, id_transfer, opts)
|
|
882
|
+
|
|
883
|
+
Execute or edit a Transfer.
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
### Example
|
|
888
|
+
```ruby
|
|
889
|
+
# load the gem
|
|
890
|
+
require 'budgea_client'
|
|
891
|
+
|
|
892
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
893
|
+
|
|
894
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
895
|
+
|
|
896
|
+
id_connection = 56 # Integer |
|
|
897
|
+
|
|
898
|
+
id_account = 56 # Integer |
|
|
899
|
+
|
|
900
|
+
id_recipient = 56 # Integer |
|
|
901
|
+
|
|
902
|
+
id_transfer = 56 # Integer |
|
|
903
|
+
|
|
904
|
+
opts = {
|
|
905
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
906
|
+
expand: "expand_example" # String |
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
begin
|
|
910
|
+
#Execute or edit a Transfer.
|
|
911
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post(id_user, id_connection, id_account, id_recipient, id_transfer, opts)
|
|
912
|
+
p result
|
|
913
|
+
rescue BudgeaClient::ApiError => e
|
|
914
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_id_transfer_post: #{e}"
|
|
915
|
+
end
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
### Parameters
|
|
919
|
+
|
|
920
|
+
Name | Type | Description | Notes
|
|
921
|
+
------------- | ------------- | ------------- | -------------
|
|
922
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
923
|
+
**id_connection** | **Integer**| |
|
|
924
|
+
**id_account** | **Integer**| |
|
|
925
|
+
**id_recipient** | **Integer**| |
|
|
926
|
+
**id_transfer** | **Integer**| |
|
|
927
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
928
|
+
**expand** | **String**| | [optional]
|
|
929
|
+
|
|
930
|
+
### Return type
|
|
931
|
+
|
|
932
|
+
[**Transfer**](Transfer.md)
|
|
933
|
+
|
|
934
|
+
### Authorization
|
|
935
|
+
|
|
936
|
+
No authorization required
|
|
937
|
+
|
|
938
|
+
### HTTP request headers
|
|
939
|
+
|
|
940
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
941
|
+
- **Accept**: application/json
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
# **users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post**
|
|
946
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post(id_user, id_connection, id_account, id_recipient, amount, opts)
|
|
947
|
+
|
|
948
|
+
Create a transfer object.
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
### Example
|
|
953
|
+
```ruby
|
|
954
|
+
# load the gem
|
|
955
|
+
require 'budgea_client'
|
|
956
|
+
|
|
957
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
958
|
+
|
|
959
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
960
|
+
|
|
961
|
+
id_connection = 56 # Integer |
|
|
962
|
+
|
|
963
|
+
id_account = 56 # Integer |
|
|
964
|
+
|
|
965
|
+
id_recipient = 56 # Integer |
|
|
966
|
+
|
|
967
|
+
amount = 3.4 # Float | amount of transfer
|
|
968
|
+
|
|
969
|
+
opts = {
|
|
970
|
+
label: "label_example", # String | reason of transfer
|
|
971
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
972
|
+
expand: "expand_example" # String |
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
begin
|
|
976
|
+
#Create a transfer object.
|
|
977
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post(id_user, id_connection, id_account, id_recipient, amount, opts)
|
|
978
|
+
p result
|
|
979
|
+
rescue BudgeaClient::ApiError => e
|
|
980
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_recipients_id_recipient_transfers_post: #{e}"
|
|
981
|
+
end
|
|
982
|
+
```
|
|
983
|
+
|
|
984
|
+
### Parameters
|
|
985
|
+
|
|
986
|
+
Name | Type | Description | Notes
|
|
987
|
+
------------- | ------------- | ------------- | -------------
|
|
988
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
989
|
+
**id_connection** | **Integer**| |
|
|
990
|
+
**id_account** | **Integer**| |
|
|
991
|
+
**id_recipient** | **Integer**| |
|
|
992
|
+
**amount** | **Float**| amount of transfer |
|
|
993
|
+
**label** | **String**| reason of transfer | [optional]
|
|
994
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
995
|
+
**expand** | **String**| | [optional]
|
|
996
|
+
|
|
997
|
+
### Return type
|
|
998
|
+
|
|
999
|
+
[**Transfer**](Transfer.md)
|
|
1000
|
+
|
|
1001
|
+
### Authorization
|
|
1002
|
+
|
|
1003
|
+
No authorization required
|
|
1004
|
+
|
|
1005
|
+
### HTTP request headers
|
|
1006
|
+
|
|
1007
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1008
|
+
- **Accept**: application/json
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
# **users_id_user_connections_id_connection_accounts_id_account_transfers_get**
|
|
1013
|
+
> InlineResponse20024 users_id_user_connections_id_connection_accounts_id_account_transfers_get(id_user, id_connection, id_account, opts)
|
|
1014
|
+
|
|
1015
|
+
Get transfers
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
### Example
|
|
1020
|
+
```ruby
|
|
1021
|
+
# load the gem
|
|
1022
|
+
require 'budgea_client'
|
|
1023
|
+
|
|
1024
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1025
|
+
|
|
1026
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1027
|
+
|
|
1028
|
+
id_connection = 56 # Integer |
|
|
1029
|
+
|
|
1030
|
+
id_account = 56 # Integer |
|
|
1031
|
+
|
|
1032
|
+
opts = {
|
|
1033
|
+
period: "period_example", # String | period to group logs
|
|
1034
|
+
expand: "expand_example" # String |
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
begin
|
|
1038
|
+
#Get transfers
|
|
1039
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transfers_get(id_user, id_connection, id_account, opts)
|
|
1040
|
+
p result
|
|
1041
|
+
rescue BudgeaClient::ApiError => e
|
|
1042
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_transfers_get: #{e}"
|
|
1043
|
+
end
|
|
1044
|
+
```
|
|
1045
|
+
|
|
1046
|
+
### Parameters
|
|
1047
|
+
|
|
1048
|
+
Name | Type | Description | Notes
|
|
1049
|
+
------------- | ------------- | ------------- | -------------
|
|
1050
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1051
|
+
**id_connection** | **Integer**| |
|
|
1052
|
+
**id_account** | **Integer**| |
|
|
1053
|
+
**period** | **String**| period to group logs | [optional]
|
|
1054
|
+
**expand** | **String**| | [optional]
|
|
1055
|
+
|
|
1056
|
+
### Return type
|
|
1057
|
+
|
|
1058
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
1059
|
+
|
|
1060
|
+
### Authorization
|
|
1061
|
+
|
|
1062
|
+
No authorization required
|
|
1063
|
+
|
|
1064
|
+
### HTTP request headers
|
|
1065
|
+
|
|
1066
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1067
|
+
- **Accept**: application/json
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
# **users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete**
|
|
1072
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete(id_user, id_connection, id_account, id_transfer, opts)
|
|
1073
|
+
|
|
1074
|
+
Cancel a transfer.
|
|
1075
|
+
|
|
1076
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
1077
|
+
|
|
1078
|
+
### Example
|
|
1079
|
+
```ruby
|
|
1080
|
+
# load the gem
|
|
1081
|
+
require 'budgea_client'
|
|
1082
|
+
|
|
1083
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1084
|
+
|
|
1085
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1086
|
+
|
|
1087
|
+
id_connection = 56 # Integer |
|
|
1088
|
+
|
|
1089
|
+
id_account = 56 # Integer |
|
|
1090
|
+
|
|
1091
|
+
id_transfer = 56 # Integer |
|
|
1092
|
+
|
|
1093
|
+
opts = {
|
|
1094
|
+
expand: "expand_example" # String |
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
begin
|
|
1098
|
+
#Cancel a transfer.
|
|
1099
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete(id_user, id_connection, id_account, id_transfer, opts)
|
|
1100
|
+
p result
|
|
1101
|
+
rescue BudgeaClient::ApiError => e
|
|
1102
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_delete: #{e}"
|
|
1103
|
+
end
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
### Parameters
|
|
1107
|
+
|
|
1108
|
+
Name | Type | Description | Notes
|
|
1109
|
+
------------- | ------------- | ------------- | -------------
|
|
1110
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1111
|
+
**id_connection** | **Integer**| |
|
|
1112
|
+
**id_account** | **Integer**| |
|
|
1113
|
+
**id_transfer** | **Integer**| |
|
|
1114
|
+
**expand** | **String**| | [optional]
|
|
1115
|
+
|
|
1116
|
+
### Return type
|
|
1117
|
+
|
|
1118
|
+
[**Transfer**](Transfer.md)
|
|
1119
|
+
|
|
1120
|
+
### Authorization
|
|
1121
|
+
|
|
1122
|
+
No authorization required
|
|
1123
|
+
|
|
1124
|
+
### HTTP request headers
|
|
1125
|
+
|
|
1126
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1127
|
+
- **Accept**: application/json
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
# **users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post**
|
|
1132
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post(id_user, id_connection, id_account, id_transfer, opts)
|
|
1133
|
+
|
|
1134
|
+
Execute or edit a Transfer.
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### Example
|
|
1139
|
+
```ruby
|
|
1140
|
+
# load the gem
|
|
1141
|
+
require 'budgea_client'
|
|
1142
|
+
|
|
1143
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1144
|
+
|
|
1145
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1146
|
+
|
|
1147
|
+
id_connection = 56 # Integer |
|
|
1148
|
+
|
|
1149
|
+
id_account = 56 # Integer |
|
|
1150
|
+
|
|
1151
|
+
id_transfer = 56 # Integer |
|
|
1152
|
+
|
|
1153
|
+
opts = {
|
|
1154
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
1155
|
+
expand: "expand_example" # String |
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1158
|
+
begin
|
|
1159
|
+
#Execute or edit a Transfer.
|
|
1160
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post(id_user, id_connection, id_account, id_transfer, opts)
|
|
1161
|
+
p result
|
|
1162
|
+
rescue BudgeaClient::ApiError => e
|
|
1163
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_transfers_id_transfer_post: #{e}"
|
|
1164
|
+
end
|
|
1165
|
+
```
|
|
1166
|
+
|
|
1167
|
+
### Parameters
|
|
1168
|
+
|
|
1169
|
+
Name | Type | Description | Notes
|
|
1170
|
+
------------- | ------------- | ------------- | -------------
|
|
1171
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1172
|
+
**id_connection** | **Integer**| |
|
|
1173
|
+
**id_account** | **Integer**| |
|
|
1174
|
+
**id_transfer** | **Integer**| |
|
|
1175
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
1176
|
+
**expand** | **String**| | [optional]
|
|
1177
|
+
|
|
1178
|
+
### Return type
|
|
1179
|
+
|
|
1180
|
+
[**Transfer**](Transfer.md)
|
|
1181
|
+
|
|
1182
|
+
### Authorization
|
|
1183
|
+
|
|
1184
|
+
No authorization required
|
|
1185
|
+
|
|
1186
|
+
### HTTP request headers
|
|
1187
|
+
|
|
1188
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1189
|
+
- **Accept**: application/json
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
# **users_id_user_connections_id_connection_accounts_id_account_transfers_post**
|
|
1194
|
+
> Transfer users_id_user_connections_id_connection_accounts_id_account_transfers_post(id_user, id_connection, id_account, amount, opts)
|
|
1195
|
+
|
|
1196
|
+
Create a transfer object.
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
### Example
|
|
1201
|
+
```ruby
|
|
1202
|
+
# load the gem
|
|
1203
|
+
require 'budgea_client'
|
|
1204
|
+
|
|
1205
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1206
|
+
|
|
1207
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1208
|
+
|
|
1209
|
+
id_connection = 56 # Integer |
|
|
1210
|
+
|
|
1211
|
+
id_account = 56 # Integer |
|
|
1212
|
+
|
|
1213
|
+
amount = 3.4 # Float | amount of transfer
|
|
1214
|
+
|
|
1215
|
+
opts = {
|
|
1216
|
+
label: "label_example", # String | reason of transfer
|
|
1217
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
1218
|
+
expand: "expand_example" # String |
|
|
1219
|
+
}
|
|
1220
|
+
|
|
1221
|
+
begin
|
|
1222
|
+
#Create a transfer object.
|
|
1223
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transfers_post(id_user, id_connection, id_account, amount, opts)
|
|
1224
|
+
p result
|
|
1225
|
+
rescue BudgeaClient::ApiError => e
|
|
1226
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_accounts_id_account_transfers_post: #{e}"
|
|
1227
|
+
end
|
|
1228
|
+
```
|
|
1229
|
+
|
|
1230
|
+
### Parameters
|
|
1231
|
+
|
|
1232
|
+
Name | Type | Description | Notes
|
|
1233
|
+
------------- | ------------- | ------------- | -------------
|
|
1234
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1235
|
+
**id_connection** | **Integer**| |
|
|
1236
|
+
**id_account** | **Integer**| |
|
|
1237
|
+
**amount** | **Float**| amount of transfer |
|
|
1238
|
+
**label** | **String**| reason of transfer | [optional]
|
|
1239
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
1240
|
+
**expand** | **String**| | [optional]
|
|
1241
|
+
|
|
1242
|
+
### Return type
|
|
1243
|
+
|
|
1244
|
+
[**Transfer**](Transfer.md)
|
|
1245
|
+
|
|
1246
|
+
### Authorization
|
|
1247
|
+
|
|
1248
|
+
No authorization required
|
|
1249
|
+
|
|
1250
|
+
### HTTP request headers
|
|
1251
|
+
|
|
1252
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1253
|
+
- **Accept**: application/json
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
# **users_id_user_connections_id_connection_recipients_get**
|
|
1258
|
+
> InlineResponse20023 users_id_user_connections_id_connection_recipients_get(id_user, id_connection, opts)
|
|
1259
|
+
|
|
1260
|
+
Returns the list of recipients
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
### Example
|
|
1265
|
+
```ruby
|
|
1266
|
+
# load the gem
|
|
1267
|
+
require 'budgea_client'
|
|
1268
|
+
|
|
1269
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1270
|
+
|
|
1271
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1272
|
+
|
|
1273
|
+
id_connection = 56 # Integer |
|
|
1274
|
+
|
|
1275
|
+
opts = {
|
|
1276
|
+
expand: "expand_example" # String |
|
|
1277
|
+
}
|
|
1278
|
+
|
|
1279
|
+
begin
|
|
1280
|
+
#Returns the list of recipients
|
|
1281
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_get(id_user, id_connection, opts)
|
|
1282
|
+
p result
|
|
1283
|
+
rescue BudgeaClient::ApiError => e
|
|
1284
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_get: #{e}"
|
|
1285
|
+
end
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1288
|
+
### Parameters
|
|
1289
|
+
|
|
1290
|
+
Name | Type | Description | Notes
|
|
1291
|
+
------------- | ------------- | ------------- | -------------
|
|
1292
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1293
|
+
**id_connection** | **Integer**| |
|
|
1294
|
+
**expand** | **String**| | [optional]
|
|
1295
|
+
|
|
1296
|
+
### Return type
|
|
1297
|
+
|
|
1298
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
1299
|
+
|
|
1300
|
+
### Authorization
|
|
1301
|
+
|
|
1302
|
+
No authorization required
|
|
1303
|
+
|
|
1304
|
+
### HTTP request headers
|
|
1305
|
+
|
|
1306
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1307
|
+
- **Accept**: application/json
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
# **users_id_user_connections_id_connection_recipients_id_recipient_post**
|
|
1312
|
+
> Recipient users_id_user_connections_id_connection_recipients_id_recipient_post(id_user, id_connection, id_recipient, opts)
|
|
1313
|
+
|
|
1314
|
+
Continue addition of a recipient.
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
### Example
|
|
1319
|
+
```ruby
|
|
1320
|
+
# load the gem
|
|
1321
|
+
require 'budgea_client'
|
|
1322
|
+
|
|
1323
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1324
|
+
|
|
1325
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1326
|
+
|
|
1327
|
+
id_connection = 56 # Integer |
|
|
1328
|
+
|
|
1329
|
+
id_recipient = 56 # Integer |
|
|
1330
|
+
|
|
1331
|
+
opts = {
|
|
1332
|
+
expand: "expand_example" # String |
|
|
1333
|
+
}
|
|
1334
|
+
|
|
1335
|
+
begin
|
|
1336
|
+
#Continue addition of a recipient.
|
|
1337
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_id_recipient_post(id_user, id_connection, id_recipient, opts)
|
|
1338
|
+
p result
|
|
1339
|
+
rescue BudgeaClient::ApiError => e
|
|
1340
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_id_recipient_post: #{e}"
|
|
1341
|
+
end
|
|
1342
|
+
```
|
|
1343
|
+
|
|
1344
|
+
### Parameters
|
|
1345
|
+
|
|
1346
|
+
Name | Type | Description | Notes
|
|
1347
|
+
------------- | ------------- | ------------- | -------------
|
|
1348
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1349
|
+
**id_connection** | **Integer**| |
|
|
1350
|
+
**id_recipient** | **Integer**| |
|
|
1351
|
+
**expand** | **String**| | [optional]
|
|
1352
|
+
|
|
1353
|
+
### Return type
|
|
1354
|
+
|
|
1355
|
+
[**Recipient**](Recipient.md)
|
|
1356
|
+
|
|
1357
|
+
### Authorization
|
|
1358
|
+
|
|
1359
|
+
No authorization required
|
|
1360
|
+
|
|
1361
|
+
### HTTP request headers
|
|
1362
|
+
|
|
1363
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1364
|
+
- **Accept**: application/json
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
# **users_id_user_connections_id_connection_recipients_id_recipient_transfers_get**
|
|
1369
|
+
> InlineResponse20024 users_id_user_connections_id_connection_recipients_id_recipient_transfers_get(id_user, id_connection, id_recipient, opts)
|
|
1370
|
+
|
|
1371
|
+
Get transfers
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
### Example
|
|
1376
|
+
```ruby
|
|
1377
|
+
# load the gem
|
|
1378
|
+
require 'budgea_client'
|
|
1379
|
+
|
|
1380
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1381
|
+
|
|
1382
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1383
|
+
|
|
1384
|
+
id_connection = 56 # Integer |
|
|
1385
|
+
|
|
1386
|
+
id_recipient = 56 # Integer |
|
|
1387
|
+
|
|
1388
|
+
opts = {
|
|
1389
|
+
period: "period_example", # String | period to group logs
|
|
1390
|
+
expand: "expand_example" # String |
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
begin
|
|
1394
|
+
#Get transfers
|
|
1395
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_id_recipient_transfers_get(id_user, id_connection, id_recipient, opts)
|
|
1396
|
+
p result
|
|
1397
|
+
rescue BudgeaClient::ApiError => e
|
|
1398
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_id_recipient_transfers_get: #{e}"
|
|
1399
|
+
end
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
### Parameters
|
|
1403
|
+
|
|
1404
|
+
Name | Type | Description | Notes
|
|
1405
|
+
------------- | ------------- | ------------- | -------------
|
|
1406
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1407
|
+
**id_connection** | **Integer**| |
|
|
1408
|
+
**id_recipient** | **Integer**| |
|
|
1409
|
+
**period** | **String**| period to group logs | [optional]
|
|
1410
|
+
**expand** | **String**| | [optional]
|
|
1411
|
+
|
|
1412
|
+
### Return type
|
|
1413
|
+
|
|
1414
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
1415
|
+
|
|
1416
|
+
### Authorization
|
|
1417
|
+
|
|
1418
|
+
No authorization required
|
|
1419
|
+
|
|
1420
|
+
### HTTP request headers
|
|
1421
|
+
|
|
1422
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1423
|
+
- **Accept**: application/json
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
# **users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete**
|
|
1428
|
+
> Transfer users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_connection, id_recipient, id_transfer, opts)
|
|
1429
|
+
|
|
1430
|
+
Cancel a transfer.
|
|
1431
|
+
|
|
1432
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
1433
|
+
|
|
1434
|
+
### Example
|
|
1435
|
+
```ruby
|
|
1436
|
+
# load the gem
|
|
1437
|
+
require 'budgea_client'
|
|
1438
|
+
|
|
1439
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1440
|
+
|
|
1441
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1442
|
+
|
|
1443
|
+
id_connection = 56 # Integer |
|
|
1444
|
+
|
|
1445
|
+
id_recipient = 56 # Integer |
|
|
1446
|
+
|
|
1447
|
+
id_transfer = 56 # Integer |
|
|
1448
|
+
|
|
1449
|
+
opts = {
|
|
1450
|
+
expand: "expand_example" # String |
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1453
|
+
begin
|
|
1454
|
+
#Cancel a transfer.
|
|
1455
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_connection, id_recipient, id_transfer, opts)
|
|
1456
|
+
p result
|
|
1457
|
+
rescue BudgeaClient::ApiError => e
|
|
1458
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_delete: #{e}"
|
|
1459
|
+
end
|
|
1460
|
+
```
|
|
1461
|
+
|
|
1462
|
+
### Parameters
|
|
1463
|
+
|
|
1464
|
+
Name | Type | Description | Notes
|
|
1465
|
+
------------- | ------------- | ------------- | -------------
|
|
1466
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1467
|
+
**id_connection** | **Integer**| |
|
|
1468
|
+
**id_recipient** | **Integer**| |
|
|
1469
|
+
**id_transfer** | **Integer**| |
|
|
1470
|
+
**expand** | **String**| | [optional]
|
|
1471
|
+
|
|
1472
|
+
### Return type
|
|
1473
|
+
|
|
1474
|
+
[**Transfer**](Transfer.md)
|
|
1475
|
+
|
|
1476
|
+
### Authorization
|
|
1477
|
+
|
|
1478
|
+
No authorization required
|
|
1479
|
+
|
|
1480
|
+
### HTTP request headers
|
|
1481
|
+
|
|
1482
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1483
|
+
- **Accept**: application/json
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
# **users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post**
|
|
1488
|
+
> Transfer users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post(id_user, id_connection, id_recipient, id_transfer, opts)
|
|
1489
|
+
|
|
1490
|
+
Execute or edit a Transfer.
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
### Example
|
|
1495
|
+
```ruby
|
|
1496
|
+
# load the gem
|
|
1497
|
+
require 'budgea_client'
|
|
1498
|
+
|
|
1499
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1500
|
+
|
|
1501
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1502
|
+
|
|
1503
|
+
id_connection = 56 # Integer |
|
|
1504
|
+
|
|
1505
|
+
id_recipient = 56 # Integer |
|
|
1506
|
+
|
|
1507
|
+
id_transfer = 56 # Integer |
|
|
1508
|
+
|
|
1509
|
+
opts = {
|
|
1510
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
1511
|
+
expand: "expand_example" # String |
|
|
1512
|
+
}
|
|
1513
|
+
|
|
1514
|
+
begin
|
|
1515
|
+
#Execute or edit a Transfer.
|
|
1516
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post(id_user, id_connection, id_recipient, id_transfer, opts)
|
|
1517
|
+
p result
|
|
1518
|
+
rescue BudgeaClient::ApiError => e
|
|
1519
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_id_recipient_transfers_id_transfer_post: #{e}"
|
|
1520
|
+
end
|
|
1521
|
+
```
|
|
1522
|
+
|
|
1523
|
+
### Parameters
|
|
1524
|
+
|
|
1525
|
+
Name | Type | Description | Notes
|
|
1526
|
+
------------- | ------------- | ------------- | -------------
|
|
1527
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1528
|
+
**id_connection** | **Integer**| |
|
|
1529
|
+
**id_recipient** | **Integer**| |
|
|
1530
|
+
**id_transfer** | **Integer**| |
|
|
1531
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
1532
|
+
**expand** | **String**| | [optional]
|
|
1533
|
+
|
|
1534
|
+
### Return type
|
|
1535
|
+
|
|
1536
|
+
[**Transfer**](Transfer.md)
|
|
1537
|
+
|
|
1538
|
+
### Authorization
|
|
1539
|
+
|
|
1540
|
+
No authorization required
|
|
1541
|
+
|
|
1542
|
+
### HTTP request headers
|
|
1543
|
+
|
|
1544
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1545
|
+
- **Accept**: application/json
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
# **users_id_user_connections_id_connection_recipients_id_recipient_transfers_post**
|
|
1550
|
+
> Transfer users_id_user_connections_id_connection_recipients_id_recipient_transfers_post(id_user, id_connection, id_recipient, amount, opts)
|
|
1551
|
+
|
|
1552
|
+
Create a transfer object.
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
### Example
|
|
1557
|
+
```ruby
|
|
1558
|
+
# load the gem
|
|
1559
|
+
require 'budgea_client'
|
|
1560
|
+
|
|
1561
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1562
|
+
|
|
1563
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1564
|
+
|
|
1565
|
+
id_connection = 56 # Integer |
|
|
1566
|
+
|
|
1567
|
+
id_recipient = 56 # Integer |
|
|
1568
|
+
|
|
1569
|
+
amount = 3.4 # Float | amount of transfer
|
|
1570
|
+
|
|
1571
|
+
opts = {
|
|
1572
|
+
label: "label_example", # String | reason of transfer
|
|
1573
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
1574
|
+
expand: "expand_example" # String |
|
|
1575
|
+
}
|
|
1576
|
+
|
|
1577
|
+
begin
|
|
1578
|
+
#Create a transfer object.
|
|
1579
|
+
result = api_instance.users_id_user_connections_id_connection_recipients_id_recipient_transfers_post(id_user, id_connection, id_recipient, amount, opts)
|
|
1580
|
+
p result
|
|
1581
|
+
rescue BudgeaClient::ApiError => e
|
|
1582
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_recipients_id_recipient_transfers_post: #{e}"
|
|
1583
|
+
end
|
|
1584
|
+
```
|
|
1585
|
+
|
|
1586
|
+
### Parameters
|
|
1587
|
+
|
|
1588
|
+
Name | Type | Description | Notes
|
|
1589
|
+
------------- | ------------- | ------------- | -------------
|
|
1590
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1591
|
+
**id_connection** | **Integer**| |
|
|
1592
|
+
**id_recipient** | **Integer**| |
|
|
1593
|
+
**amount** | **Float**| amount of transfer |
|
|
1594
|
+
**label** | **String**| reason of transfer | [optional]
|
|
1595
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
1596
|
+
**expand** | **String**| | [optional]
|
|
1597
|
+
|
|
1598
|
+
### Return type
|
|
1599
|
+
|
|
1600
|
+
[**Transfer**](Transfer.md)
|
|
1601
|
+
|
|
1602
|
+
### Authorization
|
|
1603
|
+
|
|
1604
|
+
No authorization required
|
|
1605
|
+
|
|
1606
|
+
### HTTP request headers
|
|
1607
|
+
|
|
1608
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1609
|
+
- **Accept**: application/json
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
# **users_id_user_connections_id_connection_transfers_get**
|
|
1614
|
+
> InlineResponse20024 users_id_user_connections_id_connection_transfers_get(id_user, id_connection, opts)
|
|
1615
|
+
|
|
1616
|
+
Get transfers
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
### Example
|
|
1621
|
+
```ruby
|
|
1622
|
+
# load the gem
|
|
1623
|
+
require 'budgea_client'
|
|
1624
|
+
|
|
1625
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1626
|
+
|
|
1627
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1628
|
+
|
|
1629
|
+
id_connection = 56 # Integer |
|
|
1630
|
+
|
|
1631
|
+
opts = {
|
|
1632
|
+
period: "period_example", # String | period to group logs
|
|
1633
|
+
expand: "expand_example" # String |
|
|
1634
|
+
}
|
|
1635
|
+
|
|
1636
|
+
begin
|
|
1637
|
+
#Get transfers
|
|
1638
|
+
result = api_instance.users_id_user_connections_id_connection_transfers_get(id_user, id_connection, opts)
|
|
1639
|
+
p result
|
|
1640
|
+
rescue BudgeaClient::ApiError => e
|
|
1641
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_transfers_get: #{e}"
|
|
1642
|
+
end
|
|
1643
|
+
```
|
|
1644
|
+
|
|
1645
|
+
### Parameters
|
|
1646
|
+
|
|
1647
|
+
Name | Type | Description | Notes
|
|
1648
|
+
------------- | ------------- | ------------- | -------------
|
|
1649
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1650
|
+
**id_connection** | **Integer**| |
|
|
1651
|
+
**period** | **String**| period to group logs | [optional]
|
|
1652
|
+
**expand** | **String**| | [optional]
|
|
1653
|
+
|
|
1654
|
+
### Return type
|
|
1655
|
+
|
|
1656
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
1657
|
+
|
|
1658
|
+
### Authorization
|
|
1659
|
+
|
|
1660
|
+
No authorization required
|
|
1661
|
+
|
|
1662
|
+
### HTTP request headers
|
|
1663
|
+
|
|
1664
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1665
|
+
- **Accept**: application/json
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
# **users_id_user_connections_id_connection_transfers_id_transfer_delete**
|
|
1670
|
+
> Transfer users_id_user_connections_id_connection_transfers_id_transfer_delete(id_user, id_connection, id_transfer, opts)
|
|
1671
|
+
|
|
1672
|
+
Cancel a transfer.
|
|
1673
|
+
|
|
1674
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
1675
|
+
|
|
1676
|
+
### Example
|
|
1677
|
+
```ruby
|
|
1678
|
+
# load the gem
|
|
1679
|
+
require 'budgea_client'
|
|
1680
|
+
|
|
1681
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1682
|
+
|
|
1683
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1684
|
+
|
|
1685
|
+
id_connection = 56 # Integer |
|
|
1686
|
+
|
|
1687
|
+
id_transfer = 56 # Integer |
|
|
1688
|
+
|
|
1689
|
+
opts = {
|
|
1690
|
+
expand: "expand_example" # String |
|
|
1691
|
+
}
|
|
1692
|
+
|
|
1693
|
+
begin
|
|
1694
|
+
#Cancel a transfer.
|
|
1695
|
+
result = api_instance.users_id_user_connections_id_connection_transfers_id_transfer_delete(id_user, id_connection, id_transfer, opts)
|
|
1696
|
+
p result
|
|
1697
|
+
rescue BudgeaClient::ApiError => e
|
|
1698
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_transfers_id_transfer_delete: #{e}"
|
|
1699
|
+
end
|
|
1700
|
+
```
|
|
1701
|
+
|
|
1702
|
+
### Parameters
|
|
1703
|
+
|
|
1704
|
+
Name | Type | Description | Notes
|
|
1705
|
+
------------- | ------------- | ------------- | -------------
|
|
1706
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1707
|
+
**id_connection** | **Integer**| |
|
|
1708
|
+
**id_transfer** | **Integer**| |
|
|
1709
|
+
**expand** | **String**| | [optional]
|
|
1710
|
+
|
|
1711
|
+
### Return type
|
|
1712
|
+
|
|
1713
|
+
[**Transfer**](Transfer.md)
|
|
1714
|
+
|
|
1715
|
+
### Authorization
|
|
1716
|
+
|
|
1717
|
+
No authorization required
|
|
1718
|
+
|
|
1719
|
+
### HTTP request headers
|
|
1720
|
+
|
|
1721
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1722
|
+
- **Accept**: application/json
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
# **users_id_user_connections_id_connection_transfers_id_transfer_post**
|
|
1727
|
+
> Transfer users_id_user_connections_id_connection_transfers_id_transfer_post(id_user, id_connection, id_transfer, opts)
|
|
1728
|
+
|
|
1729
|
+
Execute or edit a Transfer.
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
### Example
|
|
1734
|
+
```ruby
|
|
1735
|
+
# load the gem
|
|
1736
|
+
require 'budgea_client'
|
|
1737
|
+
|
|
1738
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1739
|
+
|
|
1740
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1741
|
+
|
|
1742
|
+
id_connection = 56 # Integer |
|
|
1743
|
+
|
|
1744
|
+
id_transfer = 56 # Integer |
|
|
1745
|
+
|
|
1746
|
+
opts = {
|
|
1747
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
1748
|
+
expand: "expand_example" # String |
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
begin
|
|
1752
|
+
#Execute or edit a Transfer.
|
|
1753
|
+
result = api_instance.users_id_user_connections_id_connection_transfers_id_transfer_post(id_user, id_connection, id_transfer, opts)
|
|
1754
|
+
p result
|
|
1755
|
+
rescue BudgeaClient::ApiError => e
|
|
1756
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_transfers_id_transfer_post: #{e}"
|
|
1757
|
+
end
|
|
1758
|
+
```
|
|
1759
|
+
|
|
1760
|
+
### Parameters
|
|
1761
|
+
|
|
1762
|
+
Name | Type | Description | Notes
|
|
1763
|
+
------------- | ------------- | ------------- | -------------
|
|
1764
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1765
|
+
**id_connection** | **Integer**| |
|
|
1766
|
+
**id_transfer** | **Integer**| |
|
|
1767
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
1768
|
+
**expand** | **String**| | [optional]
|
|
1769
|
+
|
|
1770
|
+
### Return type
|
|
1771
|
+
|
|
1772
|
+
[**Transfer**](Transfer.md)
|
|
1773
|
+
|
|
1774
|
+
### Authorization
|
|
1775
|
+
|
|
1776
|
+
No authorization required
|
|
1777
|
+
|
|
1778
|
+
### HTTP request headers
|
|
1779
|
+
|
|
1780
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1781
|
+
- **Accept**: application/json
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
# **users_id_user_connections_id_connection_transfers_post**
|
|
1786
|
+
> Transfer users_id_user_connections_id_connection_transfers_post(id_user, id_connection, amount, opts)
|
|
1787
|
+
|
|
1788
|
+
Create a transfer object.
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
### Example
|
|
1793
|
+
```ruby
|
|
1794
|
+
# load the gem
|
|
1795
|
+
require 'budgea_client'
|
|
1796
|
+
|
|
1797
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1798
|
+
|
|
1799
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1800
|
+
|
|
1801
|
+
id_connection = 56 # Integer |
|
|
1802
|
+
|
|
1803
|
+
amount = 3.4 # Float | amount of transfer
|
|
1804
|
+
|
|
1805
|
+
opts = {
|
|
1806
|
+
label: "label_example", # String | reason of transfer
|
|
1807
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
1808
|
+
expand: "expand_example" # String |
|
|
1809
|
+
}
|
|
1810
|
+
|
|
1811
|
+
begin
|
|
1812
|
+
#Create a transfer object.
|
|
1813
|
+
result = api_instance.users_id_user_connections_id_connection_transfers_post(id_user, id_connection, amount, opts)
|
|
1814
|
+
p result
|
|
1815
|
+
rescue BudgeaClient::ApiError => e
|
|
1816
|
+
puts "Exception when calling TransfersApi->users_id_user_connections_id_connection_transfers_post: #{e}"
|
|
1817
|
+
end
|
|
1818
|
+
```
|
|
1819
|
+
|
|
1820
|
+
### Parameters
|
|
1821
|
+
|
|
1822
|
+
Name | Type | Description | Notes
|
|
1823
|
+
------------- | ------------- | ------------- | -------------
|
|
1824
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1825
|
+
**id_connection** | **Integer**| |
|
|
1826
|
+
**amount** | **Float**| amount of transfer |
|
|
1827
|
+
**label** | **String**| reason of transfer | [optional]
|
|
1828
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
1829
|
+
**expand** | **String**| | [optional]
|
|
1830
|
+
|
|
1831
|
+
### Return type
|
|
1832
|
+
|
|
1833
|
+
[**Transfer**](Transfer.md)
|
|
1834
|
+
|
|
1835
|
+
### Authorization
|
|
1836
|
+
|
|
1837
|
+
No authorization required
|
|
1838
|
+
|
|
1839
|
+
### HTTP request headers
|
|
1840
|
+
|
|
1841
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1842
|
+
- **Accept**: application/json
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
# **users_id_user_recipients_get**
|
|
1847
|
+
> InlineResponse20023 users_id_user_recipients_get(id_user, opts)
|
|
1848
|
+
|
|
1849
|
+
Returns the list of recipients
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
### Example
|
|
1854
|
+
```ruby
|
|
1855
|
+
# load the gem
|
|
1856
|
+
require 'budgea_client'
|
|
1857
|
+
|
|
1858
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1859
|
+
|
|
1860
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1861
|
+
|
|
1862
|
+
opts = {
|
|
1863
|
+
expand: "expand_example" # String |
|
|
1864
|
+
}
|
|
1865
|
+
|
|
1866
|
+
begin
|
|
1867
|
+
#Returns the list of recipients
|
|
1868
|
+
result = api_instance.users_id_user_recipients_get(id_user, opts)
|
|
1869
|
+
p result
|
|
1870
|
+
rescue BudgeaClient::ApiError => e
|
|
1871
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_get: #{e}"
|
|
1872
|
+
end
|
|
1873
|
+
```
|
|
1874
|
+
|
|
1875
|
+
### Parameters
|
|
1876
|
+
|
|
1877
|
+
Name | Type | Description | Notes
|
|
1878
|
+
------------- | ------------- | ------------- | -------------
|
|
1879
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1880
|
+
**expand** | **String**| | [optional]
|
|
1881
|
+
|
|
1882
|
+
### Return type
|
|
1883
|
+
|
|
1884
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
1885
|
+
|
|
1886
|
+
### Authorization
|
|
1887
|
+
|
|
1888
|
+
No authorization required
|
|
1889
|
+
|
|
1890
|
+
### HTTP request headers
|
|
1891
|
+
|
|
1892
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1893
|
+
- **Accept**: application/json
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
# **users_id_user_recipients_id_recipient_post**
|
|
1898
|
+
> Recipient users_id_user_recipients_id_recipient_post(id_user, id_recipient, opts)
|
|
1899
|
+
|
|
1900
|
+
Continue addition of a recipient.
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
### Example
|
|
1905
|
+
```ruby
|
|
1906
|
+
# load the gem
|
|
1907
|
+
require 'budgea_client'
|
|
1908
|
+
|
|
1909
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1910
|
+
|
|
1911
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1912
|
+
|
|
1913
|
+
id_recipient = 56 # Integer |
|
|
1914
|
+
|
|
1915
|
+
opts = {
|
|
1916
|
+
expand: "expand_example" # String |
|
|
1917
|
+
}
|
|
1918
|
+
|
|
1919
|
+
begin
|
|
1920
|
+
#Continue addition of a recipient.
|
|
1921
|
+
result = api_instance.users_id_user_recipients_id_recipient_post(id_user, id_recipient, opts)
|
|
1922
|
+
p result
|
|
1923
|
+
rescue BudgeaClient::ApiError => e
|
|
1924
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_id_recipient_post: #{e}"
|
|
1925
|
+
end
|
|
1926
|
+
```
|
|
1927
|
+
|
|
1928
|
+
### Parameters
|
|
1929
|
+
|
|
1930
|
+
Name | Type | Description | Notes
|
|
1931
|
+
------------- | ------------- | ------------- | -------------
|
|
1932
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1933
|
+
**id_recipient** | **Integer**| |
|
|
1934
|
+
**expand** | **String**| | [optional]
|
|
1935
|
+
|
|
1936
|
+
### Return type
|
|
1937
|
+
|
|
1938
|
+
[**Recipient**](Recipient.md)
|
|
1939
|
+
|
|
1940
|
+
### Authorization
|
|
1941
|
+
|
|
1942
|
+
No authorization required
|
|
1943
|
+
|
|
1944
|
+
### HTTP request headers
|
|
1945
|
+
|
|
1946
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1947
|
+
- **Accept**: application/json
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
# **users_id_user_recipients_id_recipient_transfers_get**
|
|
1952
|
+
> InlineResponse20024 users_id_user_recipients_id_recipient_transfers_get(id_user, id_recipient, opts)
|
|
1953
|
+
|
|
1954
|
+
Get transfers
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
### Example
|
|
1959
|
+
```ruby
|
|
1960
|
+
# load the gem
|
|
1961
|
+
require 'budgea_client'
|
|
1962
|
+
|
|
1963
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
1964
|
+
|
|
1965
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1966
|
+
|
|
1967
|
+
id_recipient = 56 # Integer |
|
|
1968
|
+
|
|
1969
|
+
opts = {
|
|
1970
|
+
period: "period_example", # String | period to group logs
|
|
1971
|
+
expand: "expand_example" # String |
|
|
1972
|
+
}
|
|
1973
|
+
|
|
1974
|
+
begin
|
|
1975
|
+
#Get transfers
|
|
1976
|
+
result = api_instance.users_id_user_recipients_id_recipient_transfers_get(id_user, id_recipient, opts)
|
|
1977
|
+
p result
|
|
1978
|
+
rescue BudgeaClient::ApiError => e
|
|
1979
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_id_recipient_transfers_get: #{e}"
|
|
1980
|
+
end
|
|
1981
|
+
```
|
|
1982
|
+
|
|
1983
|
+
### Parameters
|
|
1984
|
+
|
|
1985
|
+
Name | Type | Description | Notes
|
|
1986
|
+
------------- | ------------- | ------------- | -------------
|
|
1987
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1988
|
+
**id_recipient** | **Integer**| |
|
|
1989
|
+
**period** | **String**| period to group logs | [optional]
|
|
1990
|
+
**expand** | **String**| | [optional]
|
|
1991
|
+
|
|
1992
|
+
### Return type
|
|
1993
|
+
|
|
1994
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
1995
|
+
|
|
1996
|
+
### Authorization
|
|
1997
|
+
|
|
1998
|
+
No authorization required
|
|
1999
|
+
|
|
2000
|
+
### HTTP request headers
|
|
2001
|
+
|
|
2002
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2003
|
+
- **Accept**: application/json
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
# **users_id_user_recipients_id_recipient_transfers_id_transfer_delete**
|
|
2008
|
+
> Transfer users_id_user_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_recipient, id_transfer, opts)
|
|
2009
|
+
|
|
2010
|
+
Cancel a transfer.
|
|
2011
|
+
|
|
2012
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
2013
|
+
|
|
2014
|
+
### Example
|
|
2015
|
+
```ruby
|
|
2016
|
+
# load the gem
|
|
2017
|
+
require 'budgea_client'
|
|
2018
|
+
|
|
2019
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2020
|
+
|
|
2021
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2022
|
+
|
|
2023
|
+
id_recipient = 56 # Integer |
|
|
2024
|
+
|
|
2025
|
+
id_transfer = 56 # Integer |
|
|
2026
|
+
|
|
2027
|
+
opts = {
|
|
2028
|
+
expand: "expand_example" # String |
|
|
2029
|
+
}
|
|
2030
|
+
|
|
2031
|
+
begin
|
|
2032
|
+
#Cancel a transfer.
|
|
2033
|
+
result = api_instance.users_id_user_recipients_id_recipient_transfers_id_transfer_delete(id_user, id_recipient, id_transfer, opts)
|
|
2034
|
+
p result
|
|
2035
|
+
rescue BudgeaClient::ApiError => e
|
|
2036
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_id_recipient_transfers_id_transfer_delete: #{e}"
|
|
2037
|
+
end
|
|
2038
|
+
```
|
|
2039
|
+
|
|
2040
|
+
### Parameters
|
|
2041
|
+
|
|
2042
|
+
Name | Type | Description | Notes
|
|
2043
|
+
------------- | ------------- | ------------- | -------------
|
|
2044
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2045
|
+
**id_recipient** | **Integer**| |
|
|
2046
|
+
**id_transfer** | **Integer**| |
|
|
2047
|
+
**expand** | **String**| | [optional]
|
|
2048
|
+
|
|
2049
|
+
### Return type
|
|
2050
|
+
|
|
2051
|
+
[**Transfer**](Transfer.md)
|
|
2052
|
+
|
|
2053
|
+
### Authorization
|
|
2054
|
+
|
|
2055
|
+
No authorization required
|
|
2056
|
+
|
|
2057
|
+
### HTTP request headers
|
|
2058
|
+
|
|
2059
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2060
|
+
- **Accept**: application/json
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
# **users_id_user_recipients_id_recipient_transfers_id_transfer_post**
|
|
2065
|
+
> Transfer users_id_user_recipients_id_recipient_transfers_id_transfer_post(id_user, id_recipient, id_transfer, opts)
|
|
2066
|
+
|
|
2067
|
+
Execute or edit a Transfer.
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
### Example
|
|
2072
|
+
```ruby
|
|
2073
|
+
# load the gem
|
|
2074
|
+
require 'budgea_client'
|
|
2075
|
+
|
|
2076
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2077
|
+
|
|
2078
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2079
|
+
|
|
2080
|
+
id_recipient = 56 # Integer |
|
|
2081
|
+
|
|
2082
|
+
id_transfer = 56 # Integer |
|
|
2083
|
+
|
|
2084
|
+
opts = {
|
|
2085
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
2086
|
+
expand: "expand_example" # String |
|
|
2087
|
+
}
|
|
2088
|
+
|
|
2089
|
+
begin
|
|
2090
|
+
#Execute or edit a Transfer.
|
|
2091
|
+
result = api_instance.users_id_user_recipients_id_recipient_transfers_id_transfer_post(id_user, id_recipient, id_transfer, opts)
|
|
2092
|
+
p result
|
|
2093
|
+
rescue BudgeaClient::ApiError => e
|
|
2094
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_id_recipient_transfers_id_transfer_post: #{e}"
|
|
2095
|
+
end
|
|
2096
|
+
```
|
|
2097
|
+
|
|
2098
|
+
### Parameters
|
|
2099
|
+
|
|
2100
|
+
Name | Type | Description | Notes
|
|
2101
|
+
------------- | ------------- | ------------- | -------------
|
|
2102
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2103
|
+
**id_recipient** | **Integer**| |
|
|
2104
|
+
**id_transfer** | **Integer**| |
|
|
2105
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
2106
|
+
**expand** | **String**| | [optional]
|
|
2107
|
+
|
|
2108
|
+
### Return type
|
|
2109
|
+
|
|
2110
|
+
[**Transfer**](Transfer.md)
|
|
2111
|
+
|
|
2112
|
+
### Authorization
|
|
2113
|
+
|
|
2114
|
+
No authorization required
|
|
2115
|
+
|
|
2116
|
+
### HTTP request headers
|
|
2117
|
+
|
|
2118
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2119
|
+
- **Accept**: application/json
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
# **users_id_user_recipients_id_recipient_transfers_post**
|
|
2124
|
+
> Transfer users_id_user_recipients_id_recipient_transfers_post(id_user, id_recipient, amount, opts)
|
|
2125
|
+
|
|
2126
|
+
Create a transfer object.
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
### Example
|
|
2131
|
+
```ruby
|
|
2132
|
+
# load the gem
|
|
2133
|
+
require 'budgea_client'
|
|
2134
|
+
|
|
2135
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2136
|
+
|
|
2137
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2138
|
+
|
|
2139
|
+
id_recipient = 56 # Integer |
|
|
2140
|
+
|
|
2141
|
+
amount = 3.4 # Float | amount of transfer
|
|
2142
|
+
|
|
2143
|
+
opts = {
|
|
2144
|
+
label: "label_example", # String | reason of transfer
|
|
2145
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
2146
|
+
expand: "expand_example" # String |
|
|
2147
|
+
}
|
|
2148
|
+
|
|
2149
|
+
begin
|
|
2150
|
+
#Create a transfer object.
|
|
2151
|
+
result = api_instance.users_id_user_recipients_id_recipient_transfers_post(id_user, id_recipient, amount, opts)
|
|
2152
|
+
p result
|
|
2153
|
+
rescue BudgeaClient::ApiError => e
|
|
2154
|
+
puts "Exception when calling TransfersApi->users_id_user_recipients_id_recipient_transfers_post: #{e}"
|
|
2155
|
+
end
|
|
2156
|
+
```
|
|
2157
|
+
|
|
2158
|
+
### Parameters
|
|
2159
|
+
|
|
2160
|
+
Name | Type | Description | Notes
|
|
2161
|
+
------------- | ------------- | ------------- | -------------
|
|
2162
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2163
|
+
**id_recipient** | **Integer**| |
|
|
2164
|
+
**amount** | **Float**| amount of transfer |
|
|
2165
|
+
**label** | **String**| reason of transfer | [optional]
|
|
2166
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
2167
|
+
**expand** | **String**| | [optional]
|
|
2168
|
+
|
|
2169
|
+
### Return type
|
|
2170
|
+
|
|
2171
|
+
[**Transfer**](Transfer.md)
|
|
2172
|
+
|
|
2173
|
+
### Authorization
|
|
2174
|
+
|
|
2175
|
+
No authorization required
|
|
2176
|
+
|
|
2177
|
+
### HTTP request headers
|
|
2178
|
+
|
|
2179
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2180
|
+
- **Accept**: application/json
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
# **users_id_user_transfers_get**
|
|
2185
|
+
> InlineResponse20024 users_id_user_transfers_get(id_user, opts)
|
|
2186
|
+
|
|
2187
|
+
Get transfers
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
### Example
|
|
2192
|
+
```ruby
|
|
2193
|
+
# load the gem
|
|
2194
|
+
require 'budgea_client'
|
|
2195
|
+
|
|
2196
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2197
|
+
|
|
2198
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2199
|
+
|
|
2200
|
+
opts = {
|
|
2201
|
+
period: "period_example", # String | period to group logs
|
|
2202
|
+
expand: "expand_example" # String |
|
|
2203
|
+
}
|
|
2204
|
+
|
|
2205
|
+
begin
|
|
2206
|
+
#Get transfers
|
|
2207
|
+
result = api_instance.users_id_user_transfers_get(id_user, opts)
|
|
2208
|
+
p result
|
|
2209
|
+
rescue BudgeaClient::ApiError => e
|
|
2210
|
+
puts "Exception when calling TransfersApi->users_id_user_transfers_get: #{e}"
|
|
2211
|
+
end
|
|
2212
|
+
```
|
|
2213
|
+
|
|
2214
|
+
### Parameters
|
|
2215
|
+
|
|
2216
|
+
Name | Type | Description | Notes
|
|
2217
|
+
------------- | ------------- | ------------- | -------------
|
|
2218
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2219
|
+
**period** | **String**| period to group logs | [optional]
|
|
2220
|
+
**expand** | **String**| | [optional]
|
|
2221
|
+
|
|
2222
|
+
### Return type
|
|
2223
|
+
|
|
2224
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
2225
|
+
|
|
2226
|
+
### Authorization
|
|
2227
|
+
|
|
2228
|
+
No authorization required
|
|
2229
|
+
|
|
2230
|
+
### HTTP request headers
|
|
2231
|
+
|
|
2232
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2233
|
+
- **Accept**: application/json
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
# **users_id_user_transfers_id_transfer_delete**
|
|
2238
|
+
> Transfer users_id_user_transfers_id_transfer_delete(id_user, id_transfer, opts)
|
|
2239
|
+
|
|
2240
|
+
Cancel a transfer.
|
|
2241
|
+
|
|
2242
|
+
It is possible to cancel only a transfer in state 'created'.<br><br>
|
|
2243
|
+
|
|
2244
|
+
### Example
|
|
2245
|
+
```ruby
|
|
2246
|
+
# load the gem
|
|
2247
|
+
require 'budgea_client'
|
|
2248
|
+
|
|
2249
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2250
|
+
|
|
2251
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2252
|
+
|
|
2253
|
+
id_transfer = 56 # Integer |
|
|
2254
|
+
|
|
2255
|
+
opts = {
|
|
2256
|
+
expand: "expand_example" # String |
|
|
2257
|
+
}
|
|
2258
|
+
|
|
2259
|
+
begin
|
|
2260
|
+
#Cancel a transfer.
|
|
2261
|
+
result = api_instance.users_id_user_transfers_id_transfer_delete(id_user, id_transfer, opts)
|
|
2262
|
+
p result
|
|
2263
|
+
rescue BudgeaClient::ApiError => e
|
|
2264
|
+
puts "Exception when calling TransfersApi->users_id_user_transfers_id_transfer_delete: #{e}"
|
|
2265
|
+
end
|
|
2266
|
+
```
|
|
2267
|
+
|
|
2268
|
+
### Parameters
|
|
2269
|
+
|
|
2270
|
+
Name | Type | Description | Notes
|
|
2271
|
+
------------- | ------------- | ------------- | -------------
|
|
2272
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2273
|
+
**id_transfer** | **Integer**| |
|
|
2274
|
+
**expand** | **String**| | [optional]
|
|
2275
|
+
|
|
2276
|
+
### Return type
|
|
2277
|
+
|
|
2278
|
+
[**Transfer**](Transfer.md)
|
|
2279
|
+
|
|
2280
|
+
### Authorization
|
|
2281
|
+
|
|
2282
|
+
No authorization required
|
|
2283
|
+
|
|
2284
|
+
### HTTP request headers
|
|
2285
|
+
|
|
2286
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2287
|
+
- **Accept**: application/json
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
# **users_id_user_transfers_id_transfer_post**
|
|
2292
|
+
> Transfer users_id_user_transfers_id_transfer_post(id_user, id_transfer, opts)
|
|
2293
|
+
|
|
2294
|
+
Execute or edit a Transfer.
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
### Example
|
|
2299
|
+
```ruby
|
|
2300
|
+
# load the gem
|
|
2301
|
+
require 'budgea_client'
|
|
2302
|
+
|
|
2303
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2304
|
+
|
|
2305
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2306
|
+
|
|
2307
|
+
id_transfer = 56 # Integer |
|
|
2308
|
+
|
|
2309
|
+
opts = {
|
|
2310
|
+
validated: true, # BOOLEAN | set it to initialize transfer on the bank website.
|
|
2311
|
+
expand: "expand_example" # String |
|
|
2312
|
+
}
|
|
2313
|
+
|
|
2314
|
+
begin
|
|
2315
|
+
#Execute or edit a Transfer.
|
|
2316
|
+
result = api_instance.users_id_user_transfers_id_transfer_post(id_user, id_transfer, opts)
|
|
2317
|
+
p result
|
|
2318
|
+
rescue BudgeaClient::ApiError => e
|
|
2319
|
+
puts "Exception when calling TransfersApi->users_id_user_transfers_id_transfer_post: #{e}"
|
|
2320
|
+
end
|
|
2321
|
+
```
|
|
2322
|
+
|
|
2323
|
+
### Parameters
|
|
2324
|
+
|
|
2325
|
+
Name | Type | Description | Notes
|
|
2326
|
+
------------- | ------------- | ------------- | -------------
|
|
2327
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2328
|
+
**id_transfer** | **Integer**| |
|
|
2329
|
+
**validated** | **BOOLEAN**| set it to initialize transfer on the bank website. | [optional]
|
|
2330
|
+
**expand** | **String**| | [optional]
|
|
2331
|
+
|
|
2332
|
+
### Return type
|
|
2333
|
+
|
|
2334
|
+
[**Transfer**](Transfer.md)
|
|
2335
|
+
|
|
2336
|
+
### Authorization
|
|
2337
|
+
|
|
2338
|
+
No authorization required
|
|
2339
|
+
|
|
2340
|
+
### HTTP request headers
|
|
2341
|
+
|
|
2342
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2343
|
+
- **Accept**: application/json
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
# **users_id_user_transfers_post**
|
|
2348
|
+
> Transfer users_id_user_transfers_post(id_user, amount, opts)
|
|
2349
|
+
|
|
2350
|
+
Create a transfer object.
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
### Example
|
|
2355
|
+
```ruby
|
|
2356
|
+
# load the gem
|
|
2357
|
+
require 'budgea_client'
|
|
2358
|
+
|
|
2359
|
+
api_instance = BudgeaClient::TransfersApi.new
|
|
2360
|
+
|
|
2361
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2362
|
+
|
|
2363
|
+
amount = 3.4 # Float | amount of transfer
|
|
2364
|
+
|
|
2365
|
+
opts = {
|
|
2366
|
+
label: "label_example", # String | reason of transfer
|
|
2367
|
+
exec_date: Date.parse("2013-10-20"), # Date | excution date of transfer
|
|
2368
|
+
expand: "expand_example" # String |
|
|
2369
|
+
}
|
|
2370
|
+
|
|
2371
|
+
begin
|
|
2372
|
+
#Create a transfer object.
|
|
2373
|
+
result = api_instance.users_id_user_transfers_post(id_user, amount, opts)
|
|
2374
|
+
p result
|
|
2375
|
+
rescue BudgeaClient::ApiError => e
|
|
2376
|
+
puts "Exception when calling TransfersApi->users_id_user_transfers_post: #{e}"
|
|
2377
|
+
end
|
|
2378
|
+
```
|
|
2379
|
+
|
|
2380
|
+
### Parameters
|
|
2381
|
+
|
|
2382
|
+
Name | Type | Description | Notes
|
|
2383
|
+
------------- | ------------- | ------------- | -------------
|
|
2384
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2385
|
+
**amount** | **Float**| amount of transfer |
|
|
2386
|
+
**label** | **String**| reason of transfer | [optional]
|
|
2387
|
+
**exec_date** | **Date**| excution date of transfer | [optional]
|
|
2388
|
+
**expand** | **String**| | [optional]
|
|
2389
|
+
|
|
2390
|
+
### Return type
|
|
2391
|
+
|
|
2392
|
+
[**Transfer**](Transfer.md)
|
|
2393
|
+
|
|
2394
|
+
### Authorization
|
|
2395
|
+
|
|
2396
|
+
No authorization required
|
|
2397
|
+
|
|
2398
|
+
### HTTP request headers
|
|
2399
|
+
|
|
2400
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2401
|
+
- **Accept**: application/json
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|