ynab 1.55.0 → 2.0.0-rc.1
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.
- package/README.md +31 -38
- package/dist/apis/AccountsApi.d.ts +60 -0
- package/dist/apis/AccountsApi.js +137 -0
- package/dist/apis/BudgetsApi.d.ts +58 -0
- package/dist/apis/BudgetsApi.js +129 -0
- package/dist/apis/CategoriesApi.d.ts +77 -0
- package/dist/apis/CategoriesApi.js +183 -0
- package/dist/{esm/transactionsApi.d.ts → apis/CustomTransactionsApi.d.ts} +19 -19
- package/dist/{transactionsApi.js → apis/CustomTransactionsApi.js} +24 -19
- package/dist/apis/DeprecatedApi.d.ts +32 -0
- package/dist/apis/DeprecatedApi.js +63 -0
- package/dist/apis/MonthsApi.d.ts +46 -0
- package/dist/apis/MonthsApi.js +98 -0
- package/dist/apis/PayeeLocationsApi.d.ts +59 -0
- package/dist/apis/PayeeLocationsApi.js +132 -0
- package/dist/apis/PayeesApi.d.ts +46 -0
- package/dist/apis/PayeesApi.js +98 -0
- package/dist/apis/ScheduledTransactionsApi.d.ts +46 -0
- package/dist/apis/ScheduledTransactionsApi.js +98 -0
- package/dist/apis/TransactionsApi.d.ts +201 -0
- package/dist/apis/TransactionsApi.js +461 -0
- package/dist/apis/UserApi.d.ts +28 -0
- package/dist/apis/UserApi.js +55 -0
- package/dist/apis/index.d.ts +10 -0
- package/dist/apis/index.js +24 -0
- package/dist/browser/ynab.js +1 -1
- package/dist/esm/apis/AccountsApi.d.ts +60 -0
- package/dist/esm/apis/AccountsApi.js +256 -0
- package/dist/esm/apis/BudgetsApi.d.ts +58 -0
- package/dist/esm/apis/BudgetsApi.js +248 -0
- package/dist/esm/apis/CategoriesApi.d.ts +77 -0
- package/dist/esm/apis/CategoriesApi.js +324 -0
- package/dist/{transactionsApi.d.ts → esm/apis/CustomTransactionsApi.d.ts} +19 -19
- package/dist/esm/{transactionsApi.js → apis/CustomTransactionsApi.js} +27 -22
- package/dist/esm/apis/DeprecatedApi.d.ts +32 -0
- package/dist/esm/apis/DeprecatedApi.js +138 -0
- package/dist/esm/apis/MonthsApi.d.ts +46 -0
- package/dist/esm/apis/MonthsApi.js +195 -0
- package/dist/esm/apis/PayeeLocationsApi.d.ts +59 -0
- package/dist/esm/apis/PayeeLocationsApi.js +251 -0
- package/dist/esm/apis/PayeesApi.d.ts +46 -0
- package/dist/esm/apis/PayeesApi.js +195 -0
- package/dist/esm/apis/ScheduledTransactionsApi.d.ts +46 -0
- package/dist/esm/apis/ScheduledTransactionsApi.js +195 -0
- package/dist/esm/apis/TransactionsApi.d.ts +201 -0
- package/dist/esm/apis/TransactionsApi.js +734 -0
- package/dist/esm/apis/UserApi.d.ts +28 -0
- package/dist/esm/apis/UserApi.js +130 -0
- package/dist/esm/apis/index.d.ts +10 -0
- package/dist/esm/apis/index.js +12 -0
- package/dist/esm/index.d.ts +24 -36
- package/dist/esm/index.js +22 -30
- package/dist/esm/models/Account.d.ts +140 -0
- package/dist/esm/models/Account.js +88 -0
- package/dist/esm/models/AccountResponse.d.ts +32 -0
- package/dist/esm/models/AccountResponse.js +44 -0
- package/dist/esm/models/AccountResponseData.d.ts +32 -0
- package/dist/esm/models/AccountResponseData.js +44 -0
- package/dist/esm/models/AccountType.d.ts +34 -0
- package/dist/esm/models/AccountType.js +41 -0
- package/dist/esm/models/AccountsResponse.d.ts +32 -0
- package/dist/esm/models/AccountsResponse.js +44 -0
- package/dist/esm/models/AccountsResponseData.d.ts +38 -0
- package/dist/esm/models/AccountsResponseData.js +47 -0
- package/dist/esm/models/BudgetDetail.d.ts +139 -0
- package/dist/esm/models/BudgetDetail.js +89 -0
- package/dist/esm/models/BudgetDetailAllOf.d.ts +95 -0
- package/dist/esm/models/BudgetDetailAllOf.js +71 -0
- package/dist/esm/models/BudgetDetailResponse.d.ts +32 -0
- package/dist/esm/models/BudgetDetailResponse.js +44 -0
- package/dist/esm/models/BudgetDetailResponseData.d.ts +38 -0
- package/dist/esm/models/BudgetDetailResponseData.js +47 -0
- package/dist/esm/models/BudgetSettings.d.ts +39 -0
- package/dist/esm/models/BudgetSettings.js +48 -0
- package/dist/esm/models/BudgetSettingsResponse.d.ts +32 -0
- package/dist/esm/models/BudgetSettingsResponse.js +44 -0
- package/dist/esm/models/BudgetSettingsResponseData.d.ts +32 -0
- package/dist/esm/models/BudgetSettingsResponseData.js +44 -0
- package/dist/esm/models/BudgetSummary.d.ts +76 -0
- package/dist/esm/models/BudgetSummary.js +62 -0
- package/dist/esm/models/BudgetSummaryResponse.d.ts +32 -0
- package/dist/esm/models/BudgetSummaryResponse.js +44 -0
- package/dist/esm/models/BudgetSummaryResponseData.d.ts +38 -0
- package/dist/esm/models/BudgetSummaryResponseData.js +47 -0
- package/dist/esm/models/BulkResponse.d.ts +32 -0
- package/dist/esm/models/BulkResponse.js +44 -0
- package/dist/esm/models/BulkResponseData.d.ts +32 -0
- package/dist/esm/models/BulkResponseData.js +44 -0
- package/dist/esm/models/BulkResponseDataBulk.d.ts +37 -0
- package/dist/esm/models/BulkResponseDataBulk.js +46 -0
- package/dist/esm/models/BulkTransactions.d.ts +32 -0
- package/dist/esm/models/BulkTransactions.js +44 -0
- package/dist/esm/models/CategoriesResponse.d.ts +32 -0
- package/dist/esm/models/CategoriesResponse.js +44 -0
- package/dist/esm/models/CategoriesResponseData.d.ts +38 -0
- package/dist/esm/models/CategoriesResponseData.js +47 -0
- package/dist/esm/models/Category.d.ts +175 -0
- package/dist/esm/models/Category.js +106 -0
- package/dist/esm/models/CategoryGroup.d.ts +49 -0
- package/dist/esm/models/CategoryGroup.js +52 -0
- package/dist/esm/models/CategoryGroupWithCategories.d.ts +56 -0
- package/dist/esm/models/CategoryGroupWithCategories.js +56 -0
- package/dist/esm/models/CategoryGroupWithCategoriesAllOf.d.ts +32 -0
- package/dist/esm/models/CategoryGroupWithCategoriesAllOf.js +44 -0
- package/dist/esm/models/CategoryResponse.d.ts +32 -0
- package/dist/esm/models/CategoryResponse.js +44 -0
- package/dist/esm/models/CategoryResponseData.d.ts +32 -0
- package/dist/esm/models/CategoryResponseData.js +44 -0
- package/dist/esm/models/CurrencyFormat.d.ts +73 -0
- package/dist/esm/models/CurrencyFormat.js +64 -0
- package/dist/esm/models/DateFormat.d.ts +31 -0
- package/dist/esm/models/DateFormat.js +43 -0
- package/dist/esm/models/ErrorDetail.d.ts +43 -0
- package/dist/esm/models/ErrorDetail.js +49 -0
- package/dist/esm/models/ErrorResponse.d.ts +32 -0
- package/dist/esm/models/ErrorResponse.js +44 -0
- package/dist/esm/models/HybridTransaction.d.ts +208 -0
- package/dist/esm/models/HybridTransaction.js +137 -0
- package/dist/esm/models/HybridTransactionAllOf.d.ts +63 -0
- package/dist/esm/models/HybridTransactionAllOf.js +60 -0
- package/dist/esm/models/HybridTransactionsResponse.d.ts +32 -0
- package/dist/esm/models/HybridTransactionsResponse.js +44 -0
- package/dist/esm/models/HybridTransactionsResponseData.d.ts +38 -0
- package/dist/esm/models/HybridTransactionsResponseData.js +47 -0
- package/dist/esm/models/MonthDetail.d.ts +80 -0
- package/dist/esm/models/MonthDetail.js +67 -0
- package/dist/esm/models/MonthDetailAllOf.d.ts +32 -0
- package/dist/esm/models/MonthDetailAllOf.js +44 -0
- package/dist/esm/models/MonthDetailResponse.d.ts +32 -0
- package/dist/esm/models/MonthDetailResponse.js +44 -0
- package/dist/esm/models/MonthDetailResponseData.d.ts +32 -0
- package/dist/esm/models/MonthDetailResponseData.js +44 -0
- package/dist/esm/models/MonthSummariesResponse.d.ts +32 -0
- package/dist/esm/models/MonthSummariesResponse.js +44 -0
- package/dist/esm/models/MonthSummariesResponseData.d.ts +38 -0
- package/dist/esm/models/MonthSummariesResponseData.js +47 -0
- package/dist/esm/models/MonthSummary.d.ts +73 -0
- package/dist/esm/models/MonthSummary.js +63 -0
- package/dist/esm/models/PatchMonthCategoryWrapper.d.ts +32 -0
- package/dist/esm/models/PatchMonthCategoryWrapper.js +44 -0
- package/dist/esm/models/PatchTransactionsWrapper.d.ts +32 -0
- package/dist/esm/models/PatchTransactionsWrapper.js +44 -0
- package/dist/esm/models/Payee.d.ts +49 -0
- package/dist/esm/models/Payee.js +52 -0
- package/dist/esm/models/PayeeLocation.d.ts +55 -0
- package/dist/esm/models/PayeeLocation.js +55 -0
- package/dist/esm/models/PayeeLocationResponse.d.ts +32 -0
- package/dist/esm/models/PayeeLocationResponse.js +44 -0
- package/dist/esm/models/PayeeLocationResponseData.d.ts +32 -0
- package/dist/esm/models/PayeeLocationResponseData.js +44 -0
- package/dist/esm/models/PayeeLocationsResponse.d.ts +32 -0
- package/dist/esm/models/PayeeLocationsResponse.js +44 -0
- package/dist/esm/models/PayeeLocationsResponseData.d.ts +32 -0
- package/dist/esm/models/PayeeLocationsResponseData.js +44 -0
- package/dist/esm/models/PayeeResponse.d.ts +32 -0
- package/dist/esm/models/PayeeResponse.js +44 -0
- package/dist/esm/models/PayeeResponseData.d.ts +32 -0
- package/dist/esm/models/PayeeResponseData.js +44 -0
- package/dist/esm/models/PayeesResponse.d.ts +32 -0
- package/dist/esm/models/PayeesResponse.js +44 -0
- package/dist/esm/models/PayeesResponseData.d.ts +38 -0
- package/dist/esm/models/PayeesResponseData.js +47 -0
- package/dist/esm/models/PostAccountWrapper.d.ts +32 -0
- package/dist/esm/models/PostAccountWrapper.js +44 -0
- package/dist/esm/models/PostTransactionsWrapper.d.ts +38 -0
- package/dist/esm/models/PostTransactionsWrapper.js +46 -0
- package/dist/esm/models/PutTransactionWrapper.d.ts +32 -0
- package/dist/esm/models/PutTransactionWrapper.js +44 -0
- package/dist/esm/models/SaveAccount.d.ts +44 -0
- package/dist/esm/models/SaveAccount.js +50 -0
- package/dist/esm/models/SaveCategoryResponse.d.ts +32 -0
- package/dist/esm/models/SaveCategoryResponse.js +44 -0
- package/dist/esm/models/SaveCategoryResponseData.d.ts +38 -0
- package/dist/esm/models/SaveCategoryResponseData.js +47 -0
- package/dist/esm/models/SaveMonthCategory.d.ts +31 -0
- package/dist/esm/models/SaveMonthCategory.js +43 -0
- package/dist/esm/models/SaveSubTransaction.d.ts +55 -0
- package/dist/esm/models/SaveSubTransaction.js +52 -0
- package/dist/esm/models/SaveTransaction.d.ts +120 -0
- package/dist/esm/models/SaveTransaction.js +86 -0
- package/dist/esm/models/SaveTransactionWithId.d.ts +126 -0
- package/dist/esm/models/SaveTransactionWithId.js +88 -0
- package/dist/esm/models/SaveTransactionWithIdAllOf.d.ts +31 -0
- package/dist/esm/models/SaveTransactionWithIdAllOf.js +43 -0
- package/dist/esm/models/SaveTransactionWithOptionalFields.d.ts +120 -0
- package/dist/esm/models/SaveTransactionWithOptionalFields.js +86 -0
- package/dist/esm/models/SaveTransactionsResponse.d.ts +32 -0
- package/dist/esm/models/SaveTransactionsResponse.js +44 -0
- package/dist/esm/models/SaveTransactionsResponseData.d.ts +56 -0
- package/dist/esm/models/SaveTransactionsResponseData.js +54 -0
- package/dist/esm/models/ScheduledSubTransaction.d.ts +73 -0
- package/dist/esm/models/ScheduledSubTransaction.js +61 -0
- package/dist/esm/models/ScheduledTransactionDetail.d.ts +154 -0
- package/dist/esm/models/ScheduledTransactionDetail.js +113 -0
- package/dist/esm/models/ScheduledTransactionDetailAllOf.d.ts +50 -0
- package/dist/esm/models/ScheduledTransactionDetailAllOf.js +52 -0
- package/dist/esm/models/ScheduledTransactionResponse.d.ts +32 -0
- package/dist/esm/models/ScheduledTransactionResponse.js +44 -0
- package/dist/esm/models/ScheduledTransactionResponseData.d.ts +32 -0
- package/dist/esm/models/ScheduledTransactionResponseData.js +44 -0
- package/dist/esm/models/ScheduledTransactionSummary.d.ts +129 -0
- package/dist/esm/models/ScheduledTransactionSummary.js +102 -0
- package/dist/esm/models/ScheduledTransactionsResponse.d.ts +32 -0
- package/dist/esm/models/ScheduledTransactionsResponse.js +44 -0
- package/dist/esm/models/ScheduledTransactionsResponseData.d.ts +38 -0
- package/dist/esm/models/ScheduledTransactionsResponseData.js +47 -0
- package/dist/esm/models/SubTransaction.d.ts +91 -0
- package/dist/esm/models/SubTransaction.js +67 -0
- package/dist/esm/models/TransactionDetail.d.ts +195 -0
- package/dist/esm/models/TransactionDetail.js +129 -0
- package/dist/esm/models/TransactionDetailAllOf.d.ts +50 -0
- package/dist/esm/models/TransactionDetailAllOf.js +52 -0
- package/dist/esm/models/TransactionResponse.d.ts +32 -0
- package/dist/esm/models/TransactionResponse.js +44 -0
- package/dist/esm/models/TransactionResponseData.d.ts +32 -0
- package/dist/esm/models/TransactionResponseData.js +44 -0
- package/dist/esm/models/TransactionSummary.d.ts +170 -0
- package/dist/esm/models/TransactionSummary.js +118 -0
- package/dist/esm/models/TransactionsImportResponse.d.ts +32 -0
- package/dist/esm/models/TransactionsImportResponse.js +44 -0
- package/dist/esm/models/TransactionsImportResponseData.d.ts +31 -0
- package/dist/esm/models/TransactionsImportResponseData.js +43 -0
- package/dist/esm/models/TransactionsResponse.d.ts +32 -0
- package/dist/esm/models/TransactionsResponse.js +44 -0
- package/dist/esm/models/TransactionsResponseData.d.ts +38 -0
- package/dist/esm/models/TransactionsResponseData.js +47 -0
- package/dist/esm/models/User.d.ts +31 -0
- package/dist/esm/models/User.js +43 -0
- package/dist/esm/models/UserResponse.d.ts +32 -0
- package/dist/esm/models/UserResponse.js +44 -0
- package/dist/esm/models/UserResponseData.d.ts +32 -0
- package/dist/esm/models/UserResponseData.js +44 -0
- package/dist/esm/models/index.d.ts +90 -0
- package/dist/esm/models/index.js +92 -0
- package/dist/esm/runtime.d.ts +182 -0
- package/dist/esm/runtime.js +563 -0
- package/dist/index.d.ts +24 -36
- package/dist/index.js +22 -30
- package/dist/models/Account.d.ts +140 -0
- package/dist/models/Account.js +95 -0
- package/dist/models/AccountResponse.d.ts +32 -0
- package/dist/models/AccountResponse.js +51 -0
- package/dist/models/AccountResponseData.d.ts +32 -0
- package/dist/models/AccountResponseData.js +51 -0
- package/dist/models/AccountType.d.ts +34 -0
- package/dist/models/AccountType.js +47 -0
- package/dist/models/AccountsResponse.d.ts +32 -0
- package/dist/models/AccountsResponse.js +51 -0
- package/dist/models/AccountsResponseData.d.ts +38 -0
- package/dist/models/AccountsResponseData.js +54 -0
- package/dist/models/BudgetDetail.d.ts +139 -0
- package/dist/models/BudgetDetail.js +96 -0
- package/dist/models/BudgetDetailAllOf.d.ts +95 -0
- package/dist/models/BudgetDetailAllOf.js +78 -0
- package/dist/models/BudgetDetailResponse.d.ts +32 -0
- package/dist/models/BudgetDetailResponse.js +51 -0
- package/dist/models/BudgetDetailResponseData.d.ts +38 -0
- package/dist/models/BudgetDetailResponseData.js +54 -0
- package/dist/models/BudgetSettings.d.ts +39 -0
- package/dist/models/BudgetSettings.js +55 -0
- package/dist/models/BudgetSettingsResponse.d.ts +32 -0
- package/dist/models/BudgetSettingsResponse.js +51 -0
- package/dist/models/BudgetSettingsResponseData.d.ts +32 -0
- package/dist/models/BudgetSettingsResponseData.js +51 -0
- package/dist/models/BudgetSummary.d.ts +76 -0
- package/dist/models/BudgetSummary.js +69 -0
- package/dist/models/BudgetSummaryResponse.d.ts +32 -0
- package/dist/models/BudgetSummaryResponse.js +51 -0
- package/dist/models/BudgetSummaryResponseData.d.ts +38 -0
- package/dist/models/BudgetSummaryResponseData.js +54 -0
- package/dist/models/BulkResponse.d.ts +32 -0
- package/dist/models/BulkResponse.js +51 -0
- package/dist/models/BulkResponseData.d.ts +32 -0
- package/dist/models/BulkResponseData.js +51 -0
- package/dist/models/BulkResponseDataBulk.d.ts +37 -0
- package/dist/models/BulkResponseDataBulk.js +53 -0
- package/dist/models/BulkTransactions.d.ts +32 -0
- package/dist/models/BulkTransactions.js +51 -0
- package/dist/models/CategoriesResponse.d.ts +32 -0
- package/dist/models/CategoriesResponse.js +51 -0
- package/dist/models/CategoriesResponseData.d.ts +38 -0
- package/dist/models/CategoriesResponseData.js +54 -0
- package/dist/models/Category.d.ts +175 -0
- package/dist/models/Category.js +113 -0
- package/dist/models/CategoryGroup.d.ts +49 -0
- package/dist/models/CategoryGroup.js +59 -0
- package/dist/models/CategoryGroupWithCategories.d.ts +56 -0
- package/dist/models/CategoryGroupWithCategories.js +63 -0
- package/dist/models/CategoryGroupWithCategoriesAllOf.d.ts +32 -0
- package/dist/models/CategoryGroupWithCategoriesAllOf.js +51 -0
- package/dist/models/CategoryResponse.d.ts +32 -0
- package/dist/models/CategoryResponse.js +51 -0
- package/dist/models/CategoryResponseData.d.ts +32 -0
- package/dist/models/CategoryResponseData.js +51 -0
- package/dist/models/CurrencyFormat.d.ts +73 -0
- package/dist/models/CurrencyFormat.js +71 -0
- package/dist/models/DateFormat.d.ts +31 -0
- package/dist/models/DateFormat.js +50 -0
- package/dist/models/ErrorDetail.d.ts +43 -0
- package/dist/models/ErrorDetail.js +56 -0
- package/dist/models/ErrorResponse.d.ts +32 -0
- package/dist/models/ErrorResponse.js +51 -0
- package/dist/models/HybridTransaction.d.ts +208 -0
- package/dist/models/HybridTransaction.js +144 -0
- package/dist/models/HybridTransactionAllOf.d.ts +63 -0
- package/dist/models/HybridTransactionAllOf.js +67 -0
- package/dist/models/HybridTransactionsResponse.d.ts +32 -0
- package/dist/models/HybridTransactionsResponse.js +51 -0
- package/dist/models/HybridTransactionsResponseData.d.ts +38 -0
- package/dist/models/HybridTransactionsResponseData.js +54 -0
- package/dist/models/MonthDetail.d.ts +80 -0
- package/dist/models/MonthDetail.js +74 -0
- package/dist/models/MonthDetailAllOf.d.ts +32 -0
- package/dist/models/MonthDetailAllOf.js +51 -0
- package/dist/models/MonthDetailResponse.d.ts +32 -0
- package/dist/models/MonthDetailResponse.js +51 -0
- package/dist/models/MonthDetailResponseData.d.ts +32 -0
- package/dist/models/MonthDetailResponseData.js +51 -0
- package/dist/models/MonthSummariesResponse.d.ts +32 -0
- package/dist/models/MonthSummariesResponse.js +51 -0
- package/dist/models/MonthSummariesResponseData.d.ts +38 -0
- package/dist/models/MonthSummariesResponseData.js +54 -0
- package/dist/models/MonthSummary.d.ts +73 -0
- package/dist/models/MonthSummary.js +70 -0
- package/dist/models/PatchMonthCategoryWrapper.d.ts +32 -0
- package/dist/models/PatchMonthCategoryWrapper.js +51 -0
- package/dist/models/PatchTransactionsWrapper.d.ts +32 -0
- package/dist/models/PatchTransactionsWrapper.js +51 -0
- package/dist/models/Payee.d.ts +49 -0
- package/dist/models/Payee.js +59 -0
- package/dist/models/PayeeLocation.d.ts +55 -0
- package/dist/models/PayeeLocation.js +62 -0
- package/dist/models/PayeeLocationResponse.d.ts +32 -0
- package/dist/models/PayeeLocationResponse.js +51 -0
- package/dist/models/PayeeLocationResponseData.d.ts +32 -0
- package/dist/models/PayeeLocationResponseData.js +51 -0
- package/dist/models/PayeeLocationsResponse.d.ts +32 -0
- package/dist/models/PayeeLocationsResponse.js +51 -0
- package/dist/models/PayeeLocationsResponseData.d.ts +32 -0
- package/dist/models/PayeeLocationsResponseData.js +51 -0
- package/dist/models/PayeeResponse.d.ts +32 -0
- package/dist/models/PayeeResponse.js +51 -0
- package/dist/models/PayeeResponseData.d.ts +32 -0
- package/dist/models/PayeeResponseData.js +51 -0
- package/dist/models/PayeesResponse.d.ts +32 -0
- package/dist/models/PayeesResponse.js +51 -0
- package/dist/models/PayeesResponseData.d.ts +38 -0
- package/dist/models/PayeesResponseData.js +54 -0
- package/dist/models/PostAccountWrapper.d.ts +32 -0
- package/dist/models/PostAccountWrapper.js +51 -0
- package/dist/models/PostTransactionsWrapper.d.ts +38 -0
- package/dist/models/PostTransactionsWrapper.js +53 -0
- package/dist/models/PutTransactionWrapper.d.ts +32 -0
- package/dist/models/PutTransactionWrapper.js +51 -0
- package/dist/models/SaveAccount.d.ts +44 -0
- package/dist/models/SaveAccount.js +57 -0
- package/dist/models/SaveCategoryResponse.d.ts +32 -0
- package/dist/models/SaveCategoryResponse.js +51 -0
- package/dist/models/SaveCategoryResponseData.d.ts +38 -0
- package/dist/models/SaveCategoryResponseData.js +54 -0
- package/dist/models/SaveMonthCategory.d.ts +31 -0
- package/dist/models/SaveMonthCategory.js +50 -0
- package/dist/models/SaveSubTransaction.d.ts +55 -0
- package/dist/models/SaveSubTransaction.js +59 -0
- package/dist/models/SaveTransaction.d.ts +120 -0
- package/dist/models/SaveTransaction.js +93 -0
- package/dist/models/SaveTransactionWithId.d.ts +126 -0
- package/dist/models/SaveTransactionWithId.js +95 -0
- package/dist/models/SaveTransactionWithIdAllOf.d.ts +31 -0
- package/dist/models/SaveTransactionWithIdAllOf.js +50 -0
- package/dist/models/SaveTransactionWithOptionalFields.d.ts +120 -0
- package/dist/models/SaveTransactionWithOptionalFields.js +93 -0
- package/dist/models/SaveTransactionsResponse.d.ts +32 -0
- package/dist/models/SaveTransactionsResponse.js +51 -0
- package/dist/models/SaveTransactionsResponseData.d.ts +56 -0
- package/dist/models/SaveTransactionsResponseData.js +61 -0
- package/dist/models/ScheduledSubTransaction.d.ts +73 -0
- package/dist/models/ScheduledSubTransaction.js +68 -0
- package/dist/models/ScheduledTransactionDetail.d.ts +154 -0
- package/dist/models/ScheduledTransactionDetail.js +120 -0
- package/dist/models/ScheduledTransactionDetailAllOf.d.ts +50 -0
- package/dist/models/ScheduledTransactionDetailAllOf.js +59 -0
- package/dist/models/ScheduledTransactionResponse.d.ts +32 -0
- package/dist/models/ScheduledTransactionResponse.js +51 -0
- package/dist/models/ScheduledTransactionResponseData.d.ts +32 -0
- package/dist/models/ScheduledTransactionResponseData.js +51 -0
- package/dist/models/ScheduledTransactionSummary.d.ts +129 -0
- package/dist/models/ScheduledTransactionSummary.js +109 -0
- package/dist/models/ScheduledTransactionsResponse.d.ts +32 -0
- package/dist/models/ScheduledTransactionsResponse.js +51 -0
- package/dist/models/ScheduledTransactionsResponseData.d.ts +38 -0
- package/dist/models/ScheduledTransactionsResponseData.js +54 -0
- package/dist/models/SubTransaction.d.ts +91 -0
- package/dist/models/SubTransaction.js +74 -0
- package/dist/models/TransactionDetail.d.ts +195 -0
- package/dist/models/TransactionDetail.js +136 -0
- package/dist/models/TransactionDetailAllOf.d.ts +50 -0
- package/dist/models/TransactionDetailAllOf.js +59 -0
- package/dist/models/TransactionResponse.d.ts +32 -0
- package/dist/models/TransactionResponse.js +51 -0
- package/dist/models/TransactionResponseData.d.ts +32 -0
- package/dist/models/TransactionResponseData.js +51 -0
- package/dist/models/TransactionSummary.d.ts +170 -0
- package/dist/models/TransactionSummary.js +125 -0
- package/dist/models/TransactionsImportResponse.d.ts +32 -0
- package/dist/models/TransactionsImportResponse.js +51 -0
- package/dist/models/TransactionsImportResponseData.d.ts +31 -0
- package/dist/models/TransactionsImportResponseData.js +50 -0
- package/dist/models/TransactionsResponse.d.ts +32 -0
- package/dist/models/TransactionsResponse.js +51 -0
- package/dist/models/TransactionsResponseData.d.ts +38 -0
- package/dist/models/TransactionsResponseData.js +54 -0
- package/dist/models/User.d.ts +31 -0
- package/dist/models/User.js +50 -0
- package/dist/models/UserResponse.d.ts +32 -0
- package/dist/models/UserResponse.js +51 -0
- package/dist/models/UserResponseData.d.ts +32 -0
- package/dist/models/UserResponseData.js +51 -0
- package/dist/models/index.d.ts +90 -0
- package/dist/models/index.js +104 -0
- package/dist/runtime.d.ts +182 -0
- package/dist/runtime.js +344 -0
- package/package.json +4 -4
- package/dist/api.d.ts +0 -4639
- package/dist/api.js +0 -3757
- package/dist/browser/ynab.js.LICENSE.txt +0 -1
- package/dist/configuration.d.ts +0 -26
- package/dist/configuration.js +0 -22
- package/dist/esm/api.d.ts +0 -4639
- package/dist/esm/api.js +0 -4067
- package/dist/esm/configuration.d.ts +0 -26
- package/dist/esm/configuration.js +0 -20
package/dist/api.d.ts
DELETED
|
@@ -1,4639 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* YNAB API Endpoints
|
|
3
|
-
* Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com
|
|
4
|
-
*
|
|
5
|
-
* OpenAPI spec version: 1.0.0
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by the swagger code generator program.
|
|
9
|
-
* https://github.com/swagger-api/swagger-codegen.git
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { Configuration } from "./configuration";
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* @export
|
|
16
|
-
*/
|
|
17
|
-
export declare const COLLECTION_FORMATS: {
|
|
18
|
-
csv: string;
|
|
19
|
-
ssv: string;
|
|
20
|
-
tsv: string;
|
|
21
|
-
pipes: string;
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
*
|
|
25
|
-
* @export
|
|
26
|
-
* @interface FetchAPI
|
|
27
|
-
*/
|
|
28
|
-
export interface FetchAPI {
|
|
29
|
-
(url: string, init?: any): Promise<Response>;
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
* @interface FetchArgs
|
|
35
|
-
*/
|
|
36
|
-
export interface FetchArgs {
|
|
37
|
-
url: string;
|
|
38
|
-
options: any;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
* @export
|
|
43
|
-
* @class BaseAPI
|
|
44
|
-
*/
|
|
45
|
-
export declare class BaseAPI {
|
|
46
|
-
protected configuration: Configuration;
|
|
47
|
-
constructor(configuration: Configuration);
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
*
|
|
51
|
-
* @export
|
|
52
|
-
* @class RequiredError
|
|
53
|
-
* @extends {Error}
|
|
54
|
-
*/
|
|
55
|
-
export declare class RequiredError extends Error {
|
|
56
|
-
field: string;
|
|
57
|
-
name: "RequiredError";
|
|
58
|
-
constructor(field: string, msg?: string);
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @export
|
|
63
|
-
* @interface Account
|
|
64
|
-
*/
|
|
65
|
-
export interface Account {
|
|
66
|
-
/**
|
|
67
|
-
*
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof Account
|
|
70
|
-
*/
|
|
71
|
-
id: string;
|
|
72
|
-
/**
|
|
73
|
-
*
|
|
74
|
-
* @type {string}
|
|
75
|
-
* @memberof Account
|
|
76
|
-
*/
|
|
77
|
-
name: string;
|
|
78
|
-
/**
|
|
79
|
-
*
|
|
80
|
-
* @type {AccountType}
|
|
81
|
-
* @memberof Account
|
|
82
|
-
*/
|
|
83
|
-
type: AccountType;
|
|
84
|
-
/**
|
|
85
|
-
* Whether this account is on budget or not
|
|
86
|
-
* @type {boolean}
|
|
87
|
-
* @memberof Account
|
|
88
|
-
*/
|
|
89
|
-
on_budget: boolean;
|
|
90
|
-
/**
|
|
91
|
-
* Whether this account is closed or not
|
|
92
|
-
* @type {boolean}
|
|
93
|
-
* @memberof Account
|
|
94
|
-
*/
|
|
95
|
-
closed: boolean;
|
|
96
|
-
/**
|
|
97
|
-
*
|
|
98
|
-
* @type {string}
|
|
99
|
-
* @memberof Account
|
|
100
|
-
*/
|
|
101
|
-
note?: string | null;
|
|
102
|
-
/**
|
|
103
|
-
* The current balance of the account in milliunits format
|
|
104
|
-
* @type {number}
|
|
105
|
-
* @memberof Account
|
|
106
|
-
*/
|
|
107
|
-
balance: number;
|
|
108
|
-
/**
|
|
109
|
-
* The current cleared balance of the account in milliunits format
|
|
110
|
-
* @type {number}
|
|
111
|
-
* @memberof Account
|
|
112
|
-
*/
|
|
113
|
-
cleared_balance: number;
|
|
114
|
-
/**
|
|
115
|
-
* The current uncleared balance of the account in milliunits format
|
|
116
|
-
* @type {number}
|
|
117
|
-
* @memberof Account
|
|
118
|
-
*/
|
|
119
|
-
uncleared_balance: number;
|
|
120
|
-
/**
|
|
121
|
-
* The payee id which should be used when transferring to this account
|
|
122
|
-
* @type {string}
|
|
123
|
-
* @memberof Account
|
|
124
|
-
*/
|
|
125
|
-
transfer_payee_id: string;
|
|
126
|
-
/**
|
|
127
|
-
* Whether or not the account is linked to a financial institution for automatic transaction import.
|
|
128
|
-
* @type {boolean}
|
|
129
|
-
* @memberof Account
|
|
130
|
-
*/
|
|
131
|
-
direct_import_linked?: boolean | null;
|
|
132
|
-
/**
|
|
133
|
-
* If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
|
|
134
|
-
* @type {boolean}
|
|
135
|
-
* @memberof Account
|
|
136
|
-
*/
|
|
137
|
-
direct_import_in_error?: boolean | null;
|
|
138
|
-
/**
|
|
139
|
-
* A date/time specifying when the account was last reconciled.
|
|
140
|
-
* @type {string}
|
|
141
|
-
* @memberof Account
|
|
142
|
-
*/
|
|
143
|
-
last_reconciled_at?: string | null;
|
|
144
|
-
/**
|
|
145
|
-
* The original debt/loan account balance, specified in milliunits format.
|
|
146
|
-
* @type {number}
|
|
147
|
-
* @memberof Account
|
|
148
|
-
*/
|
|
149
|
-
debt_original_balance?: number | null;
|
|
150
|
-
/**
|
|
151
|
-
* The debt/loan account interest rate(s), by effective date.
|
|
152
|
-
* @type {LoanAccountPeriodicValue}
|
|
153
|
-
* @memberof Account
|
|
154
|
-
*/
|
|
155
|
-
debt_interest_rates?: LoanAccountPeriodicValue | null;
|
|
156
|
-
/**
|
|
157
|
-
* The minimum payment amount(s) for the debt/loan account, by effective date. The amounts are specified in milliunits format.
|
|
158
|
-
* @type {LoanAccountPeriodicValue}
|
|
159
|
-
* @memberof Account
|
|
160
|
-
*/
|
|
161
|
-
debt_minimum_payments?: LoanAccountPeriodicValue | null;
|
|
162
|
-
/**
|
|
163
|
-
* The escrow value(s) for the debt/loan account, by effective date. The amounts are specified in milliunits format.
|
|
164
|
-
* @type {LoanAccountPeriodicValue}
|
|
165
|
-
* @memberof Account
|
|
166
|
-
*/
|
|
167
|
-
debt_escrow_amounts?: LoanAccountPeriodicValue | null;
|
|
168
|
-
/**
|
|
169
|
-
* Whether or not the account has been deleted. Deleted accounts will only be included in delta requests.
|
|
170
|
-
* @type {boolean}
|
|
171
|
-
* @memberof Account
|
|
172
|
-
*/
|
|
173
|
-
deleted: boolean;
|
|
174
|
-
}
|
|
175
|
-
/**
|
|
176
|
-
*
|
|
177
|
-
* @export
|
|
178
|
-
* @interface AccountResponse
|
|
179
|
-
*/
|
|
180
|
-
export interface AccountResponse {
|
|
181
|
-
/**
|
|
182
|
-
*
|
|
183
|
-
* @type {AccountResponseData}
|
|
184
|
-
* @memberof AccountResponse
|
|
185
|
-
*/
|
|
186
|
-
data: AccountResponseData;
|
|
187
|
-
}
|
|
188
|
-
/**
|
|
189
|
-
*
|
|
190
|
-
* @export
|
|
191
|
-
* @interface AccountResponseData
|
|
192
|
-
*/
|
|
193
|
-
export interface AccountResponseData {
|
|
194
|
-
/**
|
|
195
|
-
*
|
|
196
|
-
* @type {Account}
|
|
197
|
-
* @memberof AccountResponseData
|
|
198
|
-
*/
|
|
199
|
-
account: Account;
|
|
200
|
-
}
|
|
201
|
-
/**
|
|
202
|
-
* The type of account
|
|
203
|
-
* @export
|
|
204
|
-
* @enum {string}
|
|
205
|
-
*/
|
|
206
|
-
export declare enum AccountType {
|
|
207
|
-
Checking,
|
|
208
|
-
Savings,
|
|
209
|
-
Cash,
|
|
210
|
-
CreditCard,
|
|
211
|
-
LineOfCredit,
|
|
212
|
-
OtherAsset,
|
|
213
|
-
OtherLiability,
|
|
214
|
-
Mortgage,
|
|
215
|
-
AutoLoan,
|
|
216
|
-
StudentLoan,
|
|
217
|
-
PersonalLoan,
|
|
218
|
-
MedicalDebt,
|
|
219
|
-
OtherDebt
|
|
220
|
-
}
|
|
221
|
-
/**
|
|
222
|
-
*
|
|
223
|
-
* @export
|
|
224
|
-
* @interface AccountsResponse
|
|
225
|
-
*/
|
|
226
|
-
export interface AccountsResponse {
|
|
227
|
-
/**
|
|
228
|
-
*
|
|
229
|
-
* @type {AccountsResponseData}
|
|
230
|
-
* @memberof AccountsResponse
|
|
231
|
-
*/
|
|
232
|
-
data: AccountsResponseData;
|
|
233
|
-
}
|
|
234
|
-
/**
|
|
235
|
-
*
|
|
236
|
-
* @export
|
|
237
|
-
* @interface AccountsResponseData
|
|
238
|
-
*/
|
|
239
|
-
export interface AccountsResponseData {
|
|
240
|
-
/**
|
|
241
|
-
*
|
|
242
|
-
* @type {Array<Account>}
|
|
243
|
-
* @memberof AccountsResponseData
|
|
244
|
-
*/
|
|
245
|
-
accounts: Array<Account>;
|
|
246
|
-
/**
|
|
247
|
-
* The knowledge of the server
|
|
248
|
-
* @type {number}
|
|
249
|
-
* @memberof AccountsResponseData
|
|
250
|
-
*/
|
|
251
|
-
server_knowledge: number;
|
|
252
|
-
}
|
|
253
|
-
/**
|
|
254
|
-
*
|
|
255
|
-
* @export
|
|
256
|
-
* @interface BudgetDetailResponse
|
|
257
|
-
*/
|
|
258
|
-
export interface BudgetDetailResponse {
|
|
259
|
-
/**
|
|
260
|
-
*
|
|
261
|
-
* @type {BudgetDetailResponseData}
|
|
262
|
-
* @memberof BudgetDetailResponse
|
|
263
|
-
*/
|
|
264
|
-
data: BudgetDetailResponseData;
|
|
265
|
-
}
|
|
266
|
-
/**
|
|
267
|
-
*
|
|
268
|
-
* @export
|
|
269
|
-
* @interface BudgetDetailResponseData
|
|
270
|
-
*/
|
|
271
|
-
export interface BudgetDetailResponseData {
|
|
272
|
-
/**
|
|
273
|
-
*
|
|
274
|
-
* @type {BudgetDetail}
|
|
275
|
-
* @memberof BudgetDetailResponseData
|
|
276
|
-
*/
|
|
277
|
-
budget: BudgetDetail;
|
|
278
|
-
/**
|
|
279
|
-
* The knowledge of the server
|
|
280
|
-
* @type {number}
|
|
281
|
-
* @memberof BudgetDetailResponseData
|
|
282
|
-
*/
|
|
283
|
-
server_knowledge: number;
|
|
284
|
-
}
|
|
285
|
-
/**
|
|
286
|
-
*
|
|
287
|
-
* @export
|
|
288
|
-
* @interface BudgetSettings
|
|
289
|
-
*/
|
|
290
|
-
export interface BudgetSettings {
|
|
291
|
-
/**
|
|
292
|
-
*
|
|
293
|
-
* @type {DateFormat}
|
|
294
|
-
* @memberof BudgetSettings
|
|
295
|
-
*/
|
|
296
|
-
date_format: DateFormat;
|
|
297
|
-
/**
|
|
298
|
-
*
|
|
299
|
-
* @type {CurrencyFormat}
|
|
300
|
-
* @memberof BudgetSettings
|
|
301
|
-
*/
|
|
302
|
-
currency_format: CurrencyFormat;
|
|
303
|
-
}
|
|
304
|
-
/**
|
|
305
|
-
*
|
|
306
|
-
* @export
|
|
307
|
-
* @interface BudgetSettingsResponse
|
|
308
|
-
*/
|
|
309
|
-
export interface BudgetSettingsResponse {
|
|
310
|
-
/**
|
|
311
|
-
*
|
|
312
|
-
* @type {BudgetSettingsResponseData}
|
|
313
|
-
* @memberof BudgetSettingsResponse
|
|
314
|
-
*/
|
|
315
|
-
data: BudgetSettingsResponseData;
|
|
316
|
-
}
|
|
317
|
-
/**
|
|
318
|
-
*
|
|
319
|
-
* @export
|
|
320
|
-
* @interface BudgetSettingsResponseData
|
|
321
|
-
*/
|
|
322
|
-
export interface BudgetSettingsResponseData {
|
|
323
|
-
/**
|
|
324
|
-
*
|
|
325
|
-
* @type {BudgetSettings}
|
|
326
|
-
* @memberof BudgetSettingsResponseData
|
|
327
|
-
*/
|
|
328
|
-
settings: BudgetSettings;
|
|
329
|
-
}
|
|
330
|
-
/**
|
|
331
|
-
*
|
|
332
|
-
* @export
|
|
333
|
-
* @interface BudgetSummary
|
|
334
|
-
*/
|
|
335
|
-
export interface BudgetSummary {
|
|
336
|
-
/**
|
|
337
|
-
*
|
|
338
|
-
* @type {string}
|
|
339
|
-
* @memberof BudgetSummary
|
|
340
|
-
*/
|
|
341
|
-
id: string;
|
|
342
|
-
/**
|
|
343
|
-
*
|
|
344
|
-
* @type {string}
|
|
345
|
-
* @memberof BudgetSummary
|
|
346
|
-
*/
|
|
347
|
-
name: string;
|
|
348
|
-
/**
|
|
349
|
-
* The last time any changes were made to the budget from either a web or mobile client
|
|
350
|
-
* @type {string}
|
|
351
|
-
* @memberof BudgetSummary
|
|
352
|
-
*/
|
|
353
|
-
last_modified_on?: string | null;
|
|
354
|
-
/**
|
|
355
|
-
* The earliest budget month
|
|
356
|
-
* @type {string}
|
|
357
|
-
* @memberof BudgetSummary
|
|
358
|
-
*/
|
|
359
|
-
first_month?: string | null;
|
|
360
|
-
/**
|
|
361
|
-
* The latest budget month
|
|
362
|
-
* @type {string}
|
|
363
|
-
* @memberof BudgetSummary
|
|
364
|
-
*/
|
|
365
|
-
last_month?: string | null;
|
|
366
|
-
/**
|
|
367
|
-
*
|
|
368
|
-
* @type {DateFormat}
|
|
369
|
-
* @memberof BudgetSummary
|
|
370
|
-
*/
|
|
371
|
-
date_format?: DateFormat | null;
|
|
372
|
-
/**
|
|
373
|
-
*
|
|
374
|
-
* @type {CurrencyFormat}
|
|
375
|
-
* @memberof BudgetSummary
|
|
376
|
-
*/
|
|
377
|
-
currency_format?: CurrencyFormat | null;
|
|
378
|
-
/**
|
|
379
|
-
* The budget accounts (only included if `include_accounts=true` specified as query parameter)
|
|
380
|
-
* @type {Array<Account>}
|
|
381
|
-
* @memberof BudgetSummary
|
|
382
|
-
*/
|
|
383
|
-
accounts?: Array<Account> | null;
|
|
384
|
-
}
|
|
385
|
-
/**
|
|
386
|
-
*
|
|
387
|
-
* @export
|
|
388
|
-
* @interface BudgetSummaryResponse
|
|
389
|
-
*/
|
|
390
|
-
export interface BudgetSummaryResponse {
|
|
391
|
-
/**
|
|
392
|
-
*
|
|
393
|
-
* @type {BudgetSummaryResponseData}
|
|
394
|
-
* @memberof BudgetSummaryResponse
|
|
395
|
-
*/
|
|
396
|
-
data: BudgetSummaryResponseData;
|
|
397
|
-
}
|
|
398
|
-
/**
|
|
399
|
-
*
|
|
400
|
-
* @export
|
|
401
|
-
* @interface BudgetSummaryResponseData
|
|
402
|
-
*/
|
|
403
|
-
export interface BudgetSummaryResponseData {
|
|
404
|
-
/**
|
|
405
|
-
*
|
|
406
|
-
* @type {Array<BudgetSummary>}
|
|
407
|
-
* @memberof BudgetSummaryResponseData
|
|
408
|
-
*/
|
|
409
|
-
budgets: Array<BudgetSummary>;
|
|
410
|
-
/**
|
|
411
|
-
* The default budget, if the associated application is configured to support specifying it
|
|
412
|
-
* @type {BudgetSummary}
|
|
413
|
-
* @memberof BudgetSummaryResponseData
|
|
414
|
-
*/
|
|
415
|
-
default_budget?: BudgetSummary | null;
|
|
416
|
-
}
|
|
417
|
-
/**
|
|
418
|
-
*
|
|
419
|
-
* @export
|
|
420
|
-
* @interface BulkResponse
|
|
421
|
-
*/
|
|
422
|
-
export interface BulkResponse {
|
|
423
|
-
/**
|
|
424
|
-
*
|
|
425
|
-
* @type {BulkResponseData}
|
|
426
|
-
* @memberof BulkResponse
|
|
427
|
-
*/
|
|
428
|
-
data: BulkResponseData;
|
|
429
|
-
}
|
|
430
|
-
/**
|
|
431
|
-
*
|
|
432
|
-
* @export
|
|
433
|
-
* @interface BulkResponseData
|
|
434
|
-
*/
|
|
435
|
-
export interface BulkResponseData {
|
|
436
|
-
/**
|
|
437
|
-
*
|
|
438
|
-
* @type {BulkResponseDataBulk}
|
|
439
|
-
* @memberof BulkResponseData
|
|
440
|
-
*/
|
|
441
|
-
bulk: BulkResponseDataBulk;
|
|
442
|
-
}
|
|
443
|
-
/**
|
|
444
|
-
*
|
|
445
|
-
* @export
|
|
446
|
-
* @interface BulkResponseDataBulk
|
|
447
|
-
*/
|
|
448
|
-
export interface BulkResponseDataBulk {
|
|
449
|
-
/**
|
|
450
|
-
* The list of Transaction ids that were created.
|
|
451
|
-
* @type {Array<string>}
|
|
452
|
-
* @memberof BulkResponseDataBulk
|
|
453
|
-
*/
|
|
454
|
-
transaction_ids: Array<string>;
|
|
455
|
-
/**
|
|
456
|
-
* If any Transactions were not created because they had an `import_id` matching a transaction already on the same account, the specified import_id(s) will be included in this list.
|
|
457
|
-
* @type {Array<string>}
|
|
458
|
-
* @memberof BulkResponseDataBulk
|
|
459
|
-
*/
|
|
460
|
-
duplicate_import_ids: Array<string>;
|
|
461
|
-
}
|
|
462
|
-
/**
|
|
463
|
-
*
|
|
464
|
-
* @export
|
|
465
|
-
* @interface BulkTransactions
|
|
466
|
-
*/
|
|
467
|
-
export interface BulkTransactions {
|
|
468
|
-
/**
|
|
469
|
-
*
|
|
470
|
-
* @type {Array<SaveTransaction>}
|
|
471
|
-
* @memberof BulkTransactions
|
|
472
|
-
*/
|
|
473
|
-
transactions: Array<SaveTransaction>;
|
|
474
|
-
}
|
|
475
|
-
/**
|
|
476
|
-
*
|
|
477
|
-
* @export
|
|
478
|
-
* @interface CategoriesResponse
|
|
479
|
-
*/
|
|
480
|
-
export interface CategoriesResponse {
|
|
481
|
-
/**
|
|
482
|
-
*
|
|
483
|
-
* @type {CategoriesResponseData}
|
|
484
|
-
* @memberof CategoriesResponse
|
|
485
|
-
*/
|
|
486
|
-
data: CategoriesResponseData;
|
|
487
|
-
}
|
|
488
|
-
/**
|
|
489
|
-
*
|
|
490
|
-
* @export
|
|
491
|
-
* @interface CategoriesResponseData
|
|
492
|
-
*/
|
|
493
|
-
export interface CategoriesResponseData {
|
|
494
|
-
/**
|
|
495
|
-
*
|
|
496
|
-
* @type {Array<CategoryGroupWithCategories>}
|
|
497
|
-
* @memberof CategoriesResponseData
|
|
498
|
-
*/
|
|
499
|
-
category_groups: Array<CategoryGroupWithCategories>;
|
|
500
|
-
/**
|
|
501
|
-
* The knowledge of the server
|
|
502
|
-
* @type {number}
|
|
503
|
-
* @memberof CategoriesResponseData
|
|
504
|
-
*/
|
|
505
|
-
server_knowledge: number;
|
|
506
|
-
}
|
|
507
|
-
/**
|
|
508
|
-
*
|
|
509
|
-
* @export
|
|
510
|
-
* @interface Category
|
|
511
|
-
*/
|
|
512
|
-
export interface Category {
|
|
513
|
-
/**
|
|
514
|
-
*
|
|
515
|
-
* @type {string}
|
|
516
|
-
* @memberof Category
|
|
517
|
-
*/
|
|
518
|
-
id: string;
|
|
519
|
-
/**
|
|
520
|
-
*
|
|
521
|
-
* @type {string}
|
|
522
|
-
* @memberof Category
|
|
523
|
-
*/
|
|
524
|
-
category_group_id: string;
|
|
525
|
-
/**
|
|
526
|
-
*
|
|
527
|
-
* @type {string}
|
|
528
|
-
* @memberof Category
|
|
529
|
-
*/
|
|
530
|
-
name: string;
|
|
531
|
-
/**
|
|
532
|
-
* Whether or not the category is hidden
|
|
533
|
-
* @type {boolean}
|
|
534
|
-
* @memberof Category
|
|
535
|
-
*/
|
|
536
|
-
hidden: boolean;
|
|
537
|
-
/**
|
|
538
|
-
* If category is hidden this is the id of the category group it originally belonged to before it was hidden.
|
|
539
|
-
* @type {string}
|
|
540
|
-
* @memberof Category
|
|
541
|
-
*/
|
|
542
|
-
original_category_group_id?: string | null;
|
|
543
|
-
/**
|
|
544
|
-
*
|
|
545
|
-
* @type {string}
|
|
546
|
-
* @memberof Category
|
|
547
|
-
*/
|
|
548
|
-
note?: string | null;
|
|
549
|
-
/**
|
|
550
|
-
* Budgeted amount in milliunits format
|
|
551
|
-
* @type {number}
|
|
552
|
-
* @memberof Category
|
|
553
|
-
*/
|
|
554
|
-
budgeted: number;
|
|
555
|
-
/**
|
|
556
|
-
* Activity amount in milliunits format
|
|
557
|
-
* @type {number}
|
|
558
|
-
* @memberof Category
|
|
559
|
-
*/
|
|
560
|
-
activity: number;
|
|
561
|
-
/**
|
|
562
|
-
* Balance in milliunits format
|
|
563
|
-
* @type {number}
|
|
564
|
-
* @memberof Category
|
|
565
|
-
*/
|
|
566
|
-
balance: number;
|
|
567
|
-
/**
|
|
568
|
-
* The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
|
|
569
|
-
* @type {string}
|
|
570
|
-
* @memberof Category
|
|
571
|
-
*/
|
|
572
|
-
goal_type?: Category.GoalTypeEnum | null;
|
|
573
|
-
/**
|
|
574
|
-
* The day of the goal
|
|
575
|
-
* @type {number}
|
|
576
|
-
* @memberof Category
|
|
577
|
-
*/
|
|
578
|
-
goal_day?: number | null;
|
|
579
|
-
/**
|
|
580
|
-
* The goal cadence
|
|
581
|
-
* @type {number}
|
|
582
|
-
* @memberof Category
|
|
583
|
-
*/
|
|
584
|
-
goal_cadence?: number | null;
|
|
585
|
-
/**
|
|
586
|
-
* The goal cadence frequency
|
|
587
|
-
* @type {number}
|
|
588
|
-
* @memberof Category
|
|
589
|
-
*/
|
|
590
|
-
goal_cadence_frequency?: number | null;
|
|
591
|
-
/**
|
|
592
|
-
* The month a goal was created
|
|
593
|
-
* @type {string}
|
|
594
|
-
* @memberof Category
|
|
595
|
-
*/
|
|
596
|
-
goal_creation_month?: string | null;
|
|
597
|
-
/**
|
|
598
|
-
* The goal target amount in milliunits
|
|
599
|
-
* @type {number}
|
|
600
|
-
* @memberof Category
|
|
601
|
-
*/
|
|
602
|
-
goal_target?: number | null;
|
|
603
|
-
/**
|
|
604
|
-
* The original target month for the goal to be completed. Only some goal types specify this date.
|
|
605
|
-
* @type {string}
|
|
606
|
-
* @memberof Category
|
|
607
|
-
*/
|
|
608
|
-
goal_target_month?: string | null;
|
|
609
|
-
/**
|
|
610
|
-
* The percentage completion of the goal
|
|
611
|
-
* @type {number}
|
|
612
|
-
* @memberof Category
|
|
613
|
-
*/
|
|
614
|
-
goal_percentage_complete?: number | null;
|
|
615
|
-
/**
|
|
616
|
-
* The number of months, including the current month, left in the current goal period.
|
|
617
|
-
* @type {number}
|
|
618
|
-
* @memberof Category
|
|
619
|
-
*/
|
|
620
|
-
goal_months_to_budget?: number | null;
|
|
621
|
-
/**
|
|
622
|
-
* The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month. The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month.
|
|
623
|
-
* @type {number}
|
|
624
|
-
* @memberof Category
|
|
625
|
-
*/
|
|
626
|
-
goal_under_funded?: number | null;
|
|
627
|
-
/**
|
|
628
|
-
* The total amount funded towards the goal within the current goal period.
|
|
629
|
-
* @type {number}
|
|
630
|
-
* @memberof Category
|
|
631
|
-
*/
|
|
632
|
-
goal_overall_funded?: number | null;
|
|
633
|
-
/**
|
|
634
|
-
* The amount of funding still needed to complete the goal within the current goal period.
|
|
635
|
-
* @type {number}
|
|
636
|
-
* @memberof Category
|
|
637
|
-
*/
|
|
638
|
-
goal_overall_left?: number | null;
|
|
639
|
-
/**
|
|
640
|
-
* Whether or not the category has been deleted. Deleted categories will only be included in delta requests.
|
|
641
|
-
* @type {boolean}
|
|
642
|
-
* @memberof Category
|
|
643
|
-
*/
|
|
644
|
-
deleted: boolean;
|
|
645
|
-
}
|
|
646
|
-
/**
|
|
647
|
-
* @export
|
|
648
|
-
* @namespace Category
|
|
649
|
-
*/
|
|
650
|
-
export declare namespace Category {
|
|
651
|
-
/**
|
|
652
|
-
* @export
|
|
653
|
-
* @enum {string}
|
|
654
|
-
*/
|
|
655
|
-
enum GoalTypeEnum {
|
|
656
|
-
TB,
|
|
657
|
-
TBD,
|
|
658
|
-
MF,
|
|
659
|
-
NEED,
|
|
660
|
-
DEBT
|
|
661
|
-
}
|
|
662
|
-
}
|
|
663
|
-
/**
|
|
664
|
-
*
|
|
665
|
-
* @export
|
|
666
|
-
* @interface CategoryGroup
|
|
667
|
-
*/
|
|
668
|
-
export interface CategoryGroup {
|
|
669
|
-
/**
|
|
670
|
-
*
|
|
671
|
-
* @type {string}
|
|
672
|
-
* @memberof CategoryGroup
|
|
673
|
-
*/
|
|
674
|
-
id: string;
|
|
675
|
-
/**
|
|
676
|
-
*
|
|
677
|
-
* @type {string}
|
|
678
|
-
* @memberof CategoryGroup
|
|
679
|
-
*/
|
|
680
|
-
name: string;
|
|
681
|
-
/**
|
|
682
|
-
* Whether or not the category group is hidden
|
|
683
|
-
* @type {boolean}
|
|
684
|
-
* @memberof CategoryGroup
|
|
685
|
-
*/
|
|
686
|
-
hidden: boolean;
|
|
687
|
-
/**
|
|
688
|
-
* Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.
|
|
689
|
-
* @type {boolean}
|
|
690
|
-
* @memberof CategoryGroup
|
|
691
|
-
*/
|
|
692
|
-
deleted: boolean;
|
|
693
|
-
}
|
|
694
|
-
/**
|
|
695
|
-
*
|
|
696
|
-
* @export
|
|
697
|
-
* @interface CategoryResponse
|
|
698
|
-
*/
|
|
699
|
-
export interface CategoryResponse {
|
|
700
|
-
/**
|
|
701
|
-
*
|
|
702
|
-
* @type {CategoryResponseData}
|
|
703
|
-
* @memberof CategoryResponse
|
|
704
|
-
*/
|
|
705
|
-
data: CategoryResponseData;
|
|
706
|
-
}
|
|
707
|
-
/**
|
|
708
|
-
*
|
|
709
|
-
* @export
|
|
710
|
-
* @interface CategoryResponseData
|
|
711
|
-
*/
|
|
712
|
-
export interface CategoryResponseData {
|
|
713
|
-
/**
|
|
714
|
-
*
|
|
715
|
-
* @type {Category}
|
|
716
|
-
* @memberof CategoryResponseData
|
|
717
|
-
*/
|
|
718
|
-
category: Category;
|
|
719
|
-
}
|
|
720
|
-
/**
|
|
721
|
-
* The currency format setting for the budget. In some cases the format will not be available and will be specified as null.
|
|
722
|
-
* @export
|
|
723
|
-
* @interface CurrencyFormat
|
|
724
|
-
*/
|
|
725
|
-
export interface CurrencyFormat {
|
|
726
|
-
/**
|
|
727
|
-
*
|
|
728
|
-
* @type {string}
|
|
729
|
-
* @memberof CurrencyFormat
|
|
730
|
-
*/
|
|
731
|
-
iso_code: string;
|
|
732
|
-
/**
|
|
733
|
-
*
|
|
734
|
-
* @type {string}
|
|
735
|
-
* @memberof CurrencyFormat
|
|
736
|
-
*/
|
|
737
|
-
example_format: string;
|
|
738
|
-
/**
|
|
739
|
-
*
|
|
740
|
-
* @type {number}
|
|
741
|
-
* @memberof CurrencyFormat
|
|
742
|
-
*/
|
|
743
|
-
decimal_digits: number;
|
|
744
|
-
/**
|
|
745
|
-
*
|
|
746
|
-
* @type {string}
|
|
747
|
-
* @memberof CurrencyFormat
|
|
748
|
-
*/
|
|
749
|
-
decimal_separator: string;
|
|
750
|
-
/**
|
|
751
|
-
*
|
|
752
|
-
* @type {boolean}
|
|
753
|
-
* @memberof CurrencyFormat
|
|
754
|
-
*/
|
|
755
|
-
symbol_first: boolean;
|
|
756
|
-
/**
|
|
757
|
-
*
|
|
758
|
-
* @type {string}
|
|
759
|
-
* @memberof CurrencyFormat
|
|
760
|
-
*/
|
|
761
|
-
group_separator: string;
|
|
762
|
-
/**
|
|
763
|
-
*
|
|
764
|
-
* @type {string}
|
|
765
|
-
* @memberof CurrencyFormat
|
|
766
|
-
*/
|
|
767
|
-
currency_symbol: string;
|
|
768
|
-
/**
|
|
769
|
-
*
|
|
770
|
-
* @type {boolean}
|
|
771
|
-
* @memberof CurrencyFormat
|
|
772
|
-
*/
|
|
773
|
-
display_symbol: boolean;
|
|
774
|
-
}
|
|
775
|
-
/**
|
|
776
|
-
* The date format setting for the budget. In some cases the format will not be available and will be specified as null.
|
|
777
|
-
* @export
|
|
778
|
-
* @interface DateFormat
|
|
779
|
-
*/
|
|
780
|
-
export interface DateFormat {
|
|
781
|
-
/**
|
|
782
|
-
*
|
|
783
|
-
* @type {string}
|
|
784
|
-
* @memberof DateFormat
|
|
785
|
-
*/
|
|
786
|
-
format: string;
|
|
787
|
-
}
|
|
788
|
-
/**
|
|
789
|
-
*
|
|
790
|
-
* @export
|
|
791
|
-
* @interface ErrorDetail
|
|
792
|
-
*/
|
|
793
|
-
export interface ErrorDetail {
|
|
794
|
-
/**
|
|
795
|
-
*
|
|
796
|
-
* @type {string}
|
|
797
|
-
* @memberof ErrorDetail
|
|
798
|
-
*/
|
|
799
|
-
id: string;
|
|
800
|
-
/**
|
|
801
|
-
*
|
|
802
|
-
* @type {string}
|
|
803
|
-
* @memberof ErrorDetail
|
|
804
|
-
*/
|
|
805
|
-
name: string;
|
|
806
|
-
/**
|
|
807
|
-
*
|
|
808
|
-
* @type {string}
|
|
809
|
-
* @memberof ErrorDetail
|
|
810
|
-
*/
|
|
811
|
-
detail: string;
|
|
812
|
-
}
|
|
813
|
-
/**
|
|
814
|
-
*
|
|
815
|
-
* @export
|
|
816
|
-
* @interface ErrorResponse
|
|
817
|
-
*/
|
|
818
|
-
export interface ErrorResponse {
|
|
819
|
-
/**
|
|
820
|
-
*
|
|
821
|
-
* @type {ErrorDetail}
|
|
822
|
-
* @memberof ErrorResponse
|
|
823
|
-
*/
|
|
824
|
-
error: ErrorDetail;
|
|
825
|
-
}
|
|
826
|
-
/**
|
|
827
|
-
*
|
|
828
|
-
* @export
|
|
829
|
-
* @interface HybridTransactionsResponse
|
|
830
|
-
*/
|
|
831
|
-
export interface HybridTransactionsResponse {
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {HybridTransactionsResponseData}
|
|
835
|
-
* @memberof HybridTransactionsResponse
|
|
836
|
-
*/
|
|
837
|
-
data: HybridTransactionsResponseData;
|
|
838
|
-
}
|
|
839
|
-
/**
|
|
840
|
-
*
|
|
841
|
-
* @export
|
|
842
|
-
* @interface HybridTransactionsResponseData
|
|
843
|
-
*/
|
|
844
|
-
export interface HybridTransactionsResponseData {
|
|
845
|
-
/**
|
|
846
|
-
*
|
|
847
|
-
* @type {Array<HybridTransaction>}
|
|
848
|
-
* @memberof HybridTransactionsResponseData
|
|
849
|
-
*/
|
|
850
|
-
transactions: Array<HybridTransaction>;
|
|
851
|
-
/**
|
|
852
|
-
* The knowledge of the server
|
|
853
|
-
* @type {number}
|
|
854
|
-
* @memberof HybridTransactionsResponseData
|
|
855
|
-
*/
|
|
856
|
-
server_knowledge?: number | null;
|
|
857
|
-
}
|
|
858
|
-
/**
|
|
859
|
-
*
|
|
860
|
-
* @export
|
|
861
|
-
* @interface LoanAccountPeriodicValue
|
|
862
|
-
*/
|
|
863
|
-
export interface LoanAccountPeriodicValue {
|
|
864
|
-
[key: string]: number;
|
|
865
|
-
}
|
|
866
|
-
/**
|
|
867
|
-
*
|
|
868
|
-
* @export
|
|
869
|
-
* @interface MonthDetailResponse
|
|
870
|
-
*/
|
|
871
|
-
export interface MonthDetailResponse {
|
|
872
|
-
/**
|
|
873
|
-
*
|
|
874
|
-
* @type {MonthDetailResponseData}
|
|
875
|
-
* @memberof MonthDetailResponse
|
|
876
|
-
*/
|
|
877
|
-
data: MonthDetailResponseData;
|
|
878
|
-
}
|
|
879
|
-
/**
|
|
880
|
-
*
|
|
881
|
-
* @export
|
|
882
|
-
* @interface MonthDetailResponseData
|
|
883
|
-
*/
|
|
884
|
-
export interface MonthDetailResponseData {
|
|
885
|
-
/**
|
|
886
|
-
*
|
|
887
|
-
* @type {MonthDetail}
|
|
888
|
-
* @memberof MonthDetailResponseData
|
|
889
|
-
*/
|
|
890
|
-
month: MonthDetail;
|
|
891
|
-
}
|
|
892
|
-
/**
|
|
893
|
-
*
|
|
894
|
-
* @export
|
|
895
|
-
* @interface MonthSummariesResponse
|
|
896
|
-
*/
|
|
897
|
-
export interface MonthSummariesResponse {
|
|
898
|
-
/**
|
|
899
|
-
*
|
|
900
|
-
* @type {MonthSummariesResponseData}
|
|
901
|
-
* @memberof MonthSummariesResponse
|
|
902
|
-
*/
|
|
903
|
-
data: MonthSummariesResponseData;
|
|
904
|
-
}
|
|
905
|
-
/**
|
|
906
|
-
*
|
|
907
|
-
* @export
|
|
908
|
-
* @interface MonthSummariesResponseData
|
|
909
|
-
*/
|
|
910
|
-
export interface MonthSummariesResponseData {
|
|
911
|
-
/**
|
|
912
|
-
*
|
|
913
|
-
* @type {Array<MonthSummary>}
|
|
914
|
-
* @memberof MonthSummariesResponseData
|
|
915
|
-
*/
|
|
916
|
-
months: Array<MonthSummary>;
|
|
917
|
-
/**
|
|
918
|
-
* The knowledge of the server
|
|
919
|
-
* @type {number}
|
|
920
|
-
* @memberof MonthSummariesResponseData
|
|
921
|
-
*/
|
|
922
|
-
server_knowledge: number;
|
|
923
|
-
}
|
|
924
|
-
/**
|
|
925
|
-
*
|
|
926
|
-
* @export
|
|
927
|
-
* @interface MonthSummary
|
|
928
|
-
*/
|
|
929
|
-
export interface MonthSummary {
|
|
930
|
-
/**
|
|
931
|
-
*
|
|
932
|
-
* @type {string}
|
|
933
|
-
* @memberof MonthSummary
|
|
934
|
-
*/
|
|
935
|
-
month: string;
|
|
936
|
-
/**
|
|
937
|
-
*
|
|
938
|
-
* @type {string}
|
|
939
|
-
* @memberof MonthSummary
|
|
940
|
-
*/
|
|
941
|
-
note?: string | null;
|
|
942
|
-
/**
|
|
943
|
-
* The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
|
|
944
|
-
* @type {number}
|
|
945
|
-
* @memberof MonthSummary
|
|
946
|
-
*/
|
|
947
|
-
income: number;
|
|
948
|
-
/**
|
|
949
|
-
* The total amount budgeted in the month
|
|
950
|
-
* @type {number}
|
|
951
|
-
* @memberof MonthSummary
|
|
952
|
-
*/
|
|
953
|
-
budgeted: number;
|
|
954
|
-
/**
|
|
955
|
-
* The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
|
|
956
|
-
* @type {number}
|
|
957
|
-
* @memberof MonthSummary
|
|
958
|
-
*/
|
|
959
|
-
activity: number;
|
|
960
|
-
/**
|
|
961
|
-
* The available amount for 'Ready to Assign'
|
|
962
|
-
* @type {number}
|
|
963
|
-
* @memberof MonthSummary
|
|
964
|
-
*/
|
|
965
|
-
to_be_budgeted: number;
|
|
966
|
-
/**
|
|
967
|
-
* The Age of Money as of the month
|
|
968
|
-
* @type {number}
|
|
969
|
-
* @memberof MonthSummary
|
|
970
|
-
*/
|
|
971
|
-
age_of_money?: number | null;
|
|
972
|
-
/**
|
|
973
|
-
* Whether or not the month has been deleted. Deleted months will only be included in delta requests.
|
|
974
|
-
* @type {boolean}
|
|
975
|
-
* @memberof MonthSummary
|
|
976
|
-
*/
|
|
977
|
-
deleted: boolean;
|
|
978
|
-
}
|
|
979
|
-
/**
|
|
980
|
-
*
|
|
981
|
-
* @export
|
|
982
|
-
* @interface PatchMonthCategoryWrapper
|
|
983
|
-
*/
|
|
984
|
-
export interface PatchMonthCategoryWrapper {
|
|
985
|
-
/**
|
|
986
|
-
*
|
|
987
|
-
* @type {SaveMonthCategory}
|
|
988
|
-
* @memberof PatchMonthCategoryWrapper
|
|
989
|
-
*/
|
|
990
|
-
category: SaveMonthCategory;
|
|
991
|
-
}
|
|
992
|
-
/**
|
|
993
|
-
*
|
|
994
|
-
* @export
|
|
995
|
-
* @interface PatchTransactionsWrapper
|
|
996
|
-
*/
|
|
997
|
-
export interface PatchTransactionsWrapper {
|
|
998
|
-
/**
|
|
999
|
-
*
|
|
1000
|
-
* @type {Array<SaveTransactionWithId>}
|
|
1001
|
-
* @memberof PatchTransactionsWrapper
|
|
1002
|
-
*/
|
|
1003
|
-
transactions: Array<SaveTransactionWithId>;
|
|
1004
|
-
}
|
|
1005
|
-
/**
|
|
1006
|
-
*
|
|
1007
|
-
* @export
|
|
1008
|
-
* @interface Payee
|
|
1009
|
-
*/
|
|
1010
|
-
export interface Payee {
|
|
1011
|
-
/**
|
|
1012
|
-
*
|
|
1013
|
-
* @type {string}
|
|
1014
|
-
* @memberof Payee
|
|
1015
|
-
*/
|
|
1016
|
-
id: string;
|
|
1017
|
-
/**
|
|
1018
|
-
*
|
|
1019
|
-
* @type {string}
|
|
1020
|
-
* @memberof Payee
|
|
1021
|
-
*/
|
|
1022
|
-
name: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* If a transfer payee, the `account_id` to which this payee transfers to
|
|
1025
|
-
* @type {string}
|
|
1026
|
-
* @memberof Payee
|
|
1027
|
-
*/
|
|
1028
|
-
transfer_account_id?: string | null;
|
|
1029
|
-
/**
|
|
1030
|
-
* Whether or not the payee has been deleted. Deleted payees will only be included in delta requests.
|
|
1031
|
-
* @type {boolean}
|
|
1032
|
-
* @memberof Payee
|
|
1033
|
-
*/
|
|
1034
|
-
deleted: boolean;
|
|
1035
|
-
}
|
|
1036
|
-
/**
|
|
1037
|
-
*
|
|
1038
|
-
* @export
|
|
1039
|
-
* @interface PayeeLocation
|
|
1040
|
-
*/
|
|
1041
|
-
export interface PayeeLocation {
|
|
1042
|
-
/**
|
|
1043
|
-
*
|
|
1044
|
-
* @type {string}
|
|
1045
|
-
* @memberof PayeeLocation
|
|
1046
|
-
*/
|
|
1047
|
-
id: string;
|
|
1048
|
-
/**
|
|
1049
|
-
*
|
|
1050
|
-
* @type {string}
|
|
1051
|
-
* @memberof PayeeLocation
|
|
1052
|
-
*/
|
|
1053
|
-
payee_id: string;
|
|
1054
|
-
/**
|
|
1055
|
-
*
|
|
1056
|
-
* @type {string}
|
|
1057
|
-
* @memberof PayeeLocation
|
|
1058
|
-
*/
|
|
1059
|
-
latitude: string;
|
|
1060
|
-
/**
|
|
1061
|
-
*
|
|
1062
|
-
* @type {string}
|
|
1063
|
-
* @memberof PayeeLocation
|
|
1064
|
-
*/
|
|
1065
|
-
longitude: string;
|
|
1066
|
-
/**
|
|
1067
|
-
* Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests.
|
|
1068
|
-
* @type {boolean}
|
|
1069
|
-
* @memberof PayeeLocation
|
|
1070
|
-
*/
|
|
1071
|
-
deleted: boolean;
|
|
1072
|
-
}
|
|
1073
|
-
/**
|
|
1074
|
-
*
|
|
1075
|
-
* @export
|
|
1076
|
-
* @interface PayeeLocationResponse
|
|
1077
|
-
*/
|
|
1078
|
-
export interface PayeeLocationResponse {
|
|
1079
|
-
/**
|
|
1080
|
-
*
|
|
1081
|
-
* @type {PayeeLocationResponseData}
|
|
1082
|
-
* @memberof PayeeLocationResponse
|
|
1083
|
-
*/
|
|
1084
|
-
data: PayeeLocationResponseData;
|
|
1085
|
-
}
|
|
1086
|
-
/**
|
|
1087
|
-
*
|
|
1088
|
-
* @export
|
|
1089
|
-
* @interface PayeeLocationResponseData
|
|
1090
|
-
*/
|
|
1091
|
-
export interface PayeeLocationResponseData {
|
|
1092
|
-
/**
|
|
1093
|
-
*
|
|
1094
|
-
* @type {PayeeLocation}
|
|
1095
|
-
* @memberof PayeeLocationResponseData
|
|
1096
|
-
*/
|
|
1097
|
-
payee_location: PayeeLocation;
|
|
1098
|
-
}
|
|
1099
|
-
/**
|
|
1100
|
-
*
|
|
1101
|
-
* @export
|
|
1102
|
-
* @interface PayeeLocationsResponse
|
|
1103
|
-
*/
|
|
1104
|
-
export interface PayeeLocationsResponse {
|
|
1105
|
-
/**
|
|
1106
|
-
*
|
|
1107
|
-
* @type {PayeeLocationsResponseData}
|
|
1108
|
-
* @memberof PayeeLocationsResponse
|
|
1109
|
-
*/
|
|
1110
|
-
data: PayeeLocationsResponseData;
|
|
1111
|
-
}
|
|
1112
|
-
/**
|
|
1113
|
-
*
|
|
1114
|
-
* @export
|
|
1115
|
-
* @interface PayeeLocationsResponseData
|
|
1116
|
-
*/
|
|
1117
|
-
export interface PayeeLocationsResponseData {
|
|
1118
|
-
/**
|
|
1119
|
-
*
|
|
1120
|
-
* @type {Array<PayeeLocation>}
|
|
1121
|
-
* @memberof PayeeLocationsResponseData
|
|
1122
|
-
*/
|
|
1123
|
-
payee_locations: Array<PayeeLocation>;
|
|
1124
|
-
}
|
|
1125
|
-
/**
|
|
1126
|
-
*
|
|
1127
|
-
* @export
|
|
1128
|
-
* @interface PayeeResponse
|
|
1129
|
-
*/
|
|
1130
|
-
export interface PayeeResponse {
|
|
1131
|
-
/**
|
|
1132
|
-
*
|
|
1133
|
-
* @type {PayeeResponseData}
|
|
1134
|
-
* @memberof PayeeResponse
|
|
1135
|
-
*/
|
|
1136
|
-
data: PayeeResponseData;
|
|
1137
|
-
}
|
|
1138
|
-
/**
|
|
1139
|
-
*
|
|
1140
|
-
* @export
|
|
1141
|
-
* @interface PayeeResponseData
|
|
1142
|
-
*/
|
|
1143
|
-
export interface PayeeResponseData {
|
|
1144
|
-
/**
|
|
1145
|
-
*
|
|
1146
|
-
* @type {Payee}
|
|
1147
|
-
* @memberof PayeeResponseData
|
|
1148
|
-
*/
|
|
1149
|
-
payee: Payee;
|
|
1150
|
-
}
|
|
1151
|
-
/**
|
|
1152
|
-
*
|
|
1153
|
-
* @export
|
|
1154
|
-
* @interface PayeesResponse
|
|
1155
|
-
*/
|
|
1156
|
-
export interface PayeesResponse {
|
|
1157
|
-
/**
|
|
1158
|
-
*
|
|
1159
|
-
* @type {PayeesResponseData}
|
|
1160
|
-
* @memberof PayeesResponse
|
|
1161
|
-
*/
|
|
1162
|
-
data: PayeesResponseData;
|
|
1163
|
-
}
|
|
1164
|
-
/**
|
|
1165
|
-
*
|
|
1166
|
-
* @export
|
|
1167
|
-
* @interface PayeesResponseData
|
|
1168
|
-
*/
|
|
1169
|
-
export interface PayeesResponseData {
|
|
1170
|
-
/**
|
|
1171
|
-
*
|
|
1172
|
-
* @type {Array<Payee>}
|
|
1173
|
-
* @memberof PayeesResponseData
|
|
1174
|
-
*/
|
|
1175
|
-
payees: Array<Payee>;
|
|
1176
|
-
/**
|
|
1177
|
-
* The knowledge of the server
|
|
1178
|
-
* @type {number}
|
|
1179
|
-
* @memberof PayeesResponseData
|
|
1180
|
-
*/
|
|
1181
|
-
server_knowledge: number;
|
|
1182
|
-
}
|
|
1183
|
-
/**
|
|
1184
|
-
*
|
|
1185
|
-
* @export
|
|
1186
|
-
* @interface PostAccountWrapper
|
|
1187
|
-
*/
|
|
1188
|
-
export interface PostAccountWrapper {
|
|
1189
|
-
/**
|
|
1190
|
-
*
|
|
1191
|
-
* @type {SaveAccount}
|
|
1192
|
-
* @memberof PostAccountWrapper
|
|
1193
|
-
*/
|
|
1194
|
-
account: SaveAccount;
|
|
1195
|
-
}
|
|
1196
|
-
/**
|
|
1197
|
-
*
|
|
1198
|
-
* @export
|
|
1199
|
-
* @interface PostTransactionsWrapper
|
|
1200
|
-
*/
|
|
1201
|
-
export interface PostTransactionsWrapper {
|
|
1202
|
-
/**
|
|
1203
|
-
*
|
|
1204
|
-
* @type {SaveTransaction}
|
|
1205
|
-
* @memberof PostTransactionsWrapper
|
|
1206
|
-
*/
|
|
1207
|
-
transaction?: SaveTransaction | null;
|
|
1208
|
-
/**
|
|
1209
|
-
*
|
|
1210
|
-
* @type {Array<SaveTransaction>}
|
|
1211
|
-
* @memberof PostTransactionsWrapper
|
|
1212
|
-
*/
|
|
1213
|
-
transactions?: Array<SaveTransaction> | null;
|
|
1214
|
-
}
|
|
1215
|
-
/**
|
|
1216
|
-
*
|
|
1217
|
-
* @export
|
|
1218
|
-
* @interface PutTransactionWrapper
|
|
1219
|
-
*/
|
|
1220
|
-
export interface PutTransactionWrapper {
|
|
1221
|
-
/**
|
|
1222
|
-
*
|
|
1223
|
-
* @type {SaveTransaction}
|
|
1224
|
-
* @memberof PutTransactionWrapper
|
|
1225
|
-
*/
|
|
1226
|
-
transaction: SaveTransaction;
|
|
1227
|
-
}
|
|
1228
|
-
/**
|
|
1229
|
-
*
|
|
1230
|
-
* @export
|
|
1231
|
-
* @interface SaveAccount
|
|
1232
|
-
*/
|
|
1233
|
-
export interface SaveAccount {
|
|
1234
|
-
/**
|
|
1235
|
-
* The name of the account
|
|
1236
|
-
* @type {string}
|
|
1237
|
-
* @memberof SaveAccount
|
|
1238
|
-
*/
|
|
1239
|
-
name: string;
|
|
1240
|
-
/**
|
|
1241
|
-
*
|
|
1242
|
-
* @type {AccountType}
|
|
1243
|
-
* @memberof SaveAccount
|
|
1244
|
-
*/
|
|
1245
|
-
type: AccountType;
|
|
1246
|
-
/**
|
|
1247
|
-
* The current balance of the account in milliunits format
|
|
1248
|
-
* @type {number}
|
|
1249
|
-
* @memberof SaveAccount
|
|
1250
|
-
*/
|
|
1251
|
-
balance: number;
|
|
1252
|
-
}
|
|
1253
|
-
/**
|
|
1254
|
-
*
|
|
1255
|
-
* @export
|
|
1256
|
-
* @interface SaveCategoryResponse
|
|
1257
|
-
*/
|
|
1258
|
-
export interface SaveCategoryResponse {
|
|
1259
|
-
/**
|
|
1260
|
-
*
|
|
1261
|
-
* @type {SaveCategoryResponseData}
|
|
1262
|
-
* @memberof SaveCategoryResponse
|
|
1263
|
-
*/
|
|
1264
|
-
data: SaveCategoryResponseData;
|
|
1265
|
-
}
|
|
1266
|
-
/**
|
|
1267
|
-
*
|
|
1268
|
-
* @export
|
|
1269
|
-
* @interface SaveCategoryResponseData
|
|
1270
|
-
*/
|
|
1271
|
-
export interface SaveCategoryResponseData {
|
|
1272
|
-
/**
|
|
1273
|
-
*
|
|
1274
|
-
* @type {Category}
|
|
1275
|
-
* @memberof SaveCategoryResponseData
|
|
1276
|
-
*/
|
|
1277
|
-
category: Category;
|
|
1278
|
-
/**
|
|
1279
|
-
* The knowledge of the server
|
|
1280
|
-
* @type {number}
|
|
1281
|
-
* @memberof SaveCategoryResponseData
|
|
1282
|
-
*/
|
|
1283
|
-
server_knowledge: number;
|
|
1284
|
-
}
|
|
1285
|
-
/**
|
|
1286
|
-
*
|
|
1287
|
-
* @export
|
|
1288
|
-
* @interface SaveMonthCategory
|
|
1289
|
-
*/
|
|
1290
|
-
export interface SaveMonthCategory {
|
|
1291
|
-
/**
|
|
1292
|
-
* Budgeted amount in milliunits format
|
|
1293
|
-
* @type {number}
|
|
1294
|
-
* @memberof SaveMonthCategory
|
|
1295
|
-
*/
|
|
1296
|
-
budgeted: number;
|
|
1297
|
-
}
|
|
1298
|
-
/**
|
|
1299
|
-
*
|
|
1300
|
-
* @export
|
|
1301
|
-
* @interface SaveSubTransaction
|
|
1302
|
-
*/
|
|
1303
|
-
export interface SaveSubTransaction {
|
|
1304
|
-
/**
|
|
1305
|
-
* The subtransaction amount in milliunits format.
|
|
1306
|
-
* @type {number}
|
|
1307
|
-
* @memberof SaveSubTransaction
|
|
1308
|
-
*/
|
|
1309
|
-
amount: number;
|
|
1310
|
-
/**
|
|
1311
|
-
* The payee for the subtransaction.
|
|
1312
|
-
* @type {string}
|
|
1313
|
-
* @memberof SaveSubTransaction
|
|
1314
|
-
*/
|
|
1315
|
-
payee_id?: string | null;
|
|
1316
|
-
/**
|
|
1317
|
-
* The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
|
|
1318
|
-
* @type {string}
|
|
1319
|
-
* @memberof SaveSubTransaction
|
|
1320
|
-
*/
|
|
1321
|
-
payee_name?: string | null;
|
|
1322
|
-
/**
|
|
1323
|
-
* The category for the subtransaction. Credit Card Payment categories are not permitted and will be ignored if supplied.
|
|
1324
|
-
* @type {string}
|
|
1325
|
-
* @memberof SaveSubTransaction
|
|
1326
|
-
*/
|
|
1327
|
-
category_id?: string | null;
|
|
1328
|
-
/**
|
|
1329
|
-
*
|
|
1330
|
-
* @type {string}
|
|
1331
|
-
* @memberof SaveSubTransaction
|
|
1332
|
-
*/
|
|
1333
|
-
memo?: string | null;
|
|
1334
|
-
}
|
|
1335
|
-
/**
|
|
1336
|
-
*
|
|
1337
|
-
* @export
|
|
1338
|
-
* @interface SaveTransactionWithOptionalFields
|
|
1339
|
-
*/
|
|
1340
|
-
export interface SaveTransactionWithOptionalFields {
|
|
1341
|
-
/**
|
|
1342
|
-
*
|
|
1343
|
-
* @type {string}
|
|
1344
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1345
|
-
*/
|
|
1346
|
-
account_id?: string | null;
|
|
1347
|
-
/**
|
|
1348
|
-
* The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
|
|
1349
|
-
* @type {string}
|
|
1350
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1351
|
-
*/
|
|
1352
|
-
date?: string | null;
|
|
1353
|
-
/**
|
|
1354
|
-
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
1355
|
-
* @type {number}
|
|
1356
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1357
|
-
*/
|
|
1358
|
-
amount?: number | null;
|
|
1359
|
-
/**
|
|
1360
|
-
* The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
|
|
1361
|
-
* @type {string}
|
|
1362
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1363
|
-
*/
|
|
1364
|
-
payee_id?: string | null;
|
|
1365
|
-
/**
|
|
1366
|
-
* The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
|
|
1367
|
-
* @type {string}
|
|
1368
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1369
|
-
*/
|
|
1370
|
-
payee_name?: string | null;
|
|
1371
|
-
/**
|
|
1372
|
-
* The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
|
|
1373
|
-
* @type {string}
|
|
1374
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1375
|
-
*/
|
|
1376
|
-
category_id?: string | null;
|
|
1377
|
-
/**
|
|
1378
|
-
*
|
|
1379
|
-
* @type {string}
|
|
1380
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1381
|
-
*/
|
|
1382
|
-
memo?: string | null;
|
|
1383
|
-
/**
|
|
1384
|
-
* The cleared status of the transaction
|
|
1385
|
-
* @type {string}
|
|
1386
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1387
|
-
*/
|
|
1388
|
-
cleared?: SaveTransactionWithOptionalFields.ClearedEnum | null;
|
|
1389
|
-
/**
|
|
1390
|
-
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
1391
|
-
* @type {boolean}
|
|
1392
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1393
|
-
*/
|
|
1394
|
-
approved?: boolean | null;
|
|
1395
|
-
/**
|
|
1396
|
-
* The transaction flag
|
|
1397
|
-
* @type {string}
|
|
1398
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1399
|
-
*/
|
|
1400
|
-
flag_color?: SaveTransactionWithOptionalFields.FlagColorEnum | null;
|
|
1401
|
-
/**
|
|
1402
|
-
* If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
|
|
1403
|
-
* @type {string}
|
|
1404
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1405
|
-
*/
|
|
1406
|
-
import_id?: string | null;
|
|
1407
|
-
/**
|
|
1408
|
-
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
1409
|
-
* @type {Array<SaveSubTransaction>}
|
|
1410
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
1411
|
-
*/
|
|
1412
|
-
subtransactions?: Array<SaveSubTransaction> | null;
|
|
1413
|
-
}
|
|
1414
|
-
/**
|
|
1415
|
-
* @export
|
|
1416
|
-
* @namespace SaveTransactionWithOptionalFields
|
|
1417
|
-
*/
|
|
1418
|
-
export declare namespace SaveTransactionWithOptionalFields {
|
|
1419
|
-
/**
|
|
1420
|
-
* @export
|
|
1421
|
-
* @enum {string}
|
|
1422
|
-
*/
|
|
1423
|
-
enum ClearedEnum {
|
|
1424
|
-
Cleared,
|
|
1425
|
-
Uncleared,
|
|
1426
|
-
Reconciled
|
|
1427
|
-
}
|
|
1428
|
-
/**
|
|
1429
|
-
* @export
|
|
1430
|
-
* @enum {string}
|
|
1431
|
-
*/
|
|
1432
|
-
enum FlagColorEnum {
|
|
1433
|
-
Red,
|
|
1434
|
-
Orange,
|
|
1435
|
-
Yellow,
|
|
1436
|
-
Green,
|
|
1437
|
-
Blue,
|
|
1438
|
-
Purple
|
|
1439
|
-
}
|
|
1440
|
-
}
|
|
1441
|
-
/**
|
|
1442
|
-
*
|
|
1443
|
-
* @export
|
|
1444
|
-
* @interface SaveTransactionsResponse
|
|
1445
|
-
*/
|
|
1446
|
-
export interface SaveTransactionsResponse {
|
|
1447
|
-
/**
|
|
1448
|
-
*
|
|
1449
|
-
* @type {SaveTransactionsResponseData}
|
|
1450
|
-
* @memberof SaveTransactionsResponse
|
|
1451
|
-
*/
|
|
1452
|
-
data: SaveTransactionsResponseData;
|
|
1453
|
-
}
|
|
1454
|
-
/**
|
|
1455
|
-
*
|
|
1456
|
-
* @export
|
|
1457
|
-
* @interface SaveTransactionsResponseData
|
|
1458
|
-
*/
|
|
1459
|
-
export interface SaveTransactionsResponseData {
|
|
1460
|
-
/**
|
|
1461
|
-
* The transaction ids that were saved
|
|
1462
|
-
* @type {Array<string>}
|
|
1463
|
-
* @memberof SaveTransactionsResponseData
|
|
1464
|
-
*/
|
|
1465
|
-
transaction_ids: Array<string>;
|
|
1466
|
-
/**
|
|
1467
|
-
* If a single transaction was specified, the transaction that was saved
|
|
1468
|
-
* @type {TransactionDetail}
|
|
1469
|
-
* @memberof SaveTransactionsResponseData
|
|
1470
|
-
*/
|
|
1471
|
-
transaction?: TransactionDetail | null;
|
|
1472
|
-
/**
|
|
1473
|
-
* If multiple transactions were specified, the transactions that were saved
|
|
1474
|
-
* @type {Array<TransactionDetail>}
|
|
1475
|
-
* @memberof SaveTransactionsResponseData
|
|
1476
|
-
*/
|
|
1477
|
-
transactions?: Array<TransactionDetail> | null;
|
|
1478
|
-
/**
|
|
1479
|
-
* If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account
|
|
1480
|
-
* @type {Array<string>}
|
|
1481
|
-
* @memberof SaveTransactionsResponseData
|
|
1482
|
-
*/
|
|
1483
|
-
duplicate_import_ids?: Array<string> | null;
|
|
1484
|
-
/**
|
|
1485
|
-
* The knowledge of the server
|
|
1486
|
-
* @type {number}
|
|
1487
|
-
* @memberof SaveTransactionsResponseData
|
|
1488
|
-
*/
|
|
1489
|
-
server_knowledge: number;
|
|
1490
|
-
}
|
|
1491
|
-
/**
|
|
1492
|
-
*
|
|
1493
|
-
* @export
|
|
1494
|
-
* @interface ScheduledSubTransaction
|
|
1495
|
-
*/
|
|
1496
|
-
export interface ScheduledSubTransaction {
|
|
1497
|
-
/**
|
|
1498
|
-
*
|
|
1499
|
-
* @type {string}
|
|
1500
|
-
* @memberof ScheduledSubTransaction
|
|
1501
|
-
*/
|
|
1502
|
-
id: string;
|
|
1503
|
-
/**
|
|
1504
|
-
*
|
|
1505
|
-
* @type {string}
|
|
1506
|
-
* @memberof ScheduledSubTransaction
|
|
1507
|
-
*/
|
|
1508
|
-
scheduled_transaction_id: string;
|
|
1509
|
-
/**
|
|
1510
|
-
* The scheduled subtransaction amount in milliunits format
|
|
1511
|
-
* @type {number}
|
|
1512
|
-
* @memberof ScheduledSubTransaction
|
|
1513
|
-
*/
|
|
1514
|
-
amount: number;
|
|
1515
|
-
/**
|
|
1516
|
-
*
|
|
1517
|
-
* @type {string}
|
|
1518
|
-
* @memberof ScheduledSubTransaction
|
|
1519
|
-
*/
|
|
1520
|
-
memo?: string | null;
|
|
1521
|
-
/**
|
|
1522
|
-
*
|
|
1523
|
-
* @type {string}
|
|
1524
|
-
* @memberof ScheduledSubTransaction
|
|
1525
|
-
*/
|
|
1526
|
-
payee_id?: string | null;
|
|
1527
|
-
/**
|
|
1528
|
-
*
|
|
1529
|
-
* @type {string}
|
|
1530
|
-
* @memberof ScheduledSubTransaction
|
|
1531
|
-
*/
|
|
1532
|
-
category_id?: string | null;
|
|
1533
|
-
/**
|
|
1534
|
-
* If a transfer, the account_id which the scheduled subtransaction transfers to
|
|
1535
|
-
* @type {string}
|
|
1536
|
-
* @memberof ScheduledSubTransaction
|
|
1537
|
-
*/
|
|
1538
|
-
transfer_account_id?: string | null;
|
|
1539
|
-
/**
|
|
1540
|
-
* Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests.
|
|
1541
|
-
* @type {boolean}
|
|
1542
|
-
* @memberof ScheduledSubTransaction
|
|
1543
|
-
*/
|
|
1544
|
-
deleted: boolean;
|
|
1545
|
-
}
|
|
1546
|
-
/**
|
|
1547
|
-
*
|
|
1548
|
-
* @export
|
|
1549
|
-
* @interface ScheduledTransactionResponse
|
|
1550
|
-
*/
|
|
1551
|
-
export interface ScheduledTransactionResponse {
|
|
1552
|
-
/**
|
|
1553
|
-
*
|
|
1554
|
-
* @type {ScheduledTransactionResponseData}
|
|
1555
|
-
* @memberof ScheduledTransactionResponse
|
|
1556
|
-
*/
|
|
1557
|
-
data: ScheduledTransactionResponseData;
|
|
1558
|
-
}
|
|
1559
|
-
/**
|
|
1560
|
-
*
|
|
1561
|
-
* @export
|
|
1562
|
-
* @interface ScheduledTransactionResponseData
|
|
1563
|
-
*/
|
|
1564
|
-
export interface ScheduledTransactionResponseData {
|
|
1565
|
-
/**
|
|
1566
|
-
*
|
|
1567
|
-
* @type {ScheduledTransactionDetail}
|
|
1568
|
-
* @memberof ScheduledTransactionResponseData
|
|
1569
|
-
*/
|
|
1570
|
-
scheduled_transaction: ScheduledTransactionDetail;
|
|
1571
|
-
}
|
|
1572
|
-
/**
|
|
1573
|
-
*
|
|
1574
|
-
* @export
|
|
1575
|
-
* @interface ScheduledTransactionSummary
|
|
1576
|
-
*/
|
|
1577
|
-
export interface ScheduledTransactionSummary {
|
|
1578
|
-
/**
|
|
1579
|
-
*
|
|
1580
|
-
* @type {string}
|
|
1581
|
-
* @memberof ScheduledTransactionSummary
|
|
1582
|
-
*/
|
|
1583
|
-
id: string;
|
|
1584
|
-
/**
|
|
1585
|
-
* The first date for which the Scheduled Transaction was scheduled.
|
|
1586
|
-
* @type {string}
|
|
1587
|
-
* @memberof ScheduledTransactionSummary
|
|
1588
|
-
*/
|
|
1589
|
-
date_first: string;
|
|
1590
|
-
/**
|
|
1591
|
-
* The next date for which the Scheduled Transaction is scheduled.
|
|
1592
|
-
* @type {string}
|
|
1593
|
-
* @memberof ScheduledTransactionSummary
|
|
1594
|
-
*/
|
|
1595
|
-
date_next: string;
|
|
1596
|
-
/**
|
|
1597
|
-
*
|
|
1598
|
-
* @type {string}
|
|
1599
|
-
* @memberof ScheduledTransactionSummary
|
|
1600
|
-
*/
|
|
1601
|
-
frequency: ScheduledTransactionSummary.FrequencyEnum;
|
|
1602
|
-
/**
|
|
1603
|
-
* The scheduled transaction amount in milliunits format
|
|
1604
|
-
* @type {number}
|
|
1605
|
-
* @memberof ScheduledTransactionSummary
|
|
1606
|
-
*/
|
|
1607
|
-
amount: number;
|
|
1608
|
-
/**
|
|
1609
|
-
*
|
|
1610
|
-
* @type {string}
|
|
1611
|
-
* @memberof ScheduledTransactionSummary
|
|
1612
|
-
*/
|
|
1613
|
-
memo?: string | null;
|
|
1614
|
-
/**
|
|
1615
|
-
* The scheduled transaction flag
|
|
1616
|
-
* @type {string}
|
|
1617
|
-
* @memberof ScheduledTransactionSummary
|
|
1618
|
-
*/
|
|
1619
|
-
flag_color?: ScheduledTransactionSummary.FlagColorEnum | null;
|
|
1620
|
-
/**
|
|
1621
|
-
*
|
|
1622
|
-
* @type {string}
|
|
1623
|
-
* @memberof ScheduledTransactionSummary
|
|
1624
|
-
*/
|
|
1625
|
-
account_id: string;
|
|
1626
|
-
/**
|
|
1627
|
-
*
|
|
1628
|
-
* @type {string}
|
|
1629
|
-
* @memberof ScheduledTransactionSummary
|
|
1630
|
-
*/
|
|
1631
|
-
payee_id?: string | null;
|
|
1632
|
-
/**
|
|
1633
|
-
*
|
|
1634
|
-
* @type {string}
|
|
1635
|
-
* @memberof ScheduledTransactionSummary
|
|
1636
|
-
*/
|
|
1637
|
-
category_id?: string | null;
|
|
1638
|
-
/**
|
|
1639
|
-
* If a transfer, the account_id which the scheduled transaction transfers to
|
|
1640
|
-
* @type {string}
|
|
1641
|
-
* @memberof ScheduledTransactionSummary
|
|
1642
|
-
*/
|
|
1643
|
-
transfer_account_id?: string | null;
|
|
1644
|
-
/**
|
|
1645
|
-
* Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
|
|
1646
|
-
* @type {boolean}
|
|
1647
|
-
* @memberof ScheduledTransactionSummary
|
|
1648
|
-
*/
|
|
1649
|
-
deleted: boolean;
|
|
1650
|
-
}
|
|
1651
|
-
/**
|
|
1652
|
-
* @export
|
|
1653
|
-
* @namespace ScheduledTransactionSummary
|
|
1654
|
-
*/
|
|
1655
|
-
export declare namespace ScheduledTransactionSummary {
|
|
1656
|
-
/**
|
|
1657
|
-
* @export
|
|
1658
|
-
* @enum {string}
|
|
1659
|
-
*/
|
|
1660
|
-
enum FrequencyEnum {
|
|
1661
|
-
Never,
|
|
1662
|
-
Daily,
|
|
1663
|
-
Weekly,
|
|
1664
|
-
EveryOtherWeek,
|
|
1665
|
-
TwiceAMonth,
|
|
1666
|
-
Every4Weeks,
|
|
1667
|
-
Monthly,
|
|
1668
|
-
EveryOtherMonth,
|
|
1669
|
-
Every3Months,
|
|
1670
|
-
Every4Months,
|
|
1671
|
-
TwiceAYear,
|
|
1672
|
-
Yearly,
|
|
1673
|
-
EveryOtherYear
|
|
1674
|
-
}
|
|
1675
|
-
/**
|
|
1676
|
-
* @export
|
|
1677
|
-
* @enum {string}
|
|
1678
|
-
*/
|
|
1679
|
-
enum FlagColorEnum {
|
|
1680
|
-
Red,
|
|
1681
|
-
Orange,
|
|
1682
|
-
Yellow,
|
|
1683
|
-
Green,
|
|
1684
|
-
Blue,
|
|
1685
|
-
Purple
|
|
1686
|
-
}
|
|
1687
|
-
}
|
|
1688
|
-
/**
|
|
1689
|
-
*
|
|
1690
|
-
* @export
|
|
1691
|
-
* @interface ScheduledTransactionsResponse
|
|
1692
|
-
*/
|
|
1693
|
-
export interface ScheduledTransactionsResponse {
|
|
1694
|
-
/**
|
|
1695
|
-
*
|
|
1696
|
-
* @type {ScheduledTransactionsResponseData}
|
|
1697
|
-
* @memberof ScheduledTransactionsResponse
|
|
1698
|
-
*/
|
|
1699
|
-
data: ScheduledTransactionsResponseData;
|
|
1700
|
-
}
|
|
1701
|
-
/**
|
|
1702
|
-
*
|
|
1703
|
-
* @export
|
|
1704
|
-
* @interface ScheduledTransactionsResponseData
|
|
1705
|
-
*/
|
|
1706
|
-
export interface ScheduledTransactionsResponseData {
|
|
1707
|
-
/**
|
|
1708
|
-
*
|
|
1709
|
-
* @type {Array<ScheduledTransactionDetail>}
|
|
1710
|
-
* @memberof ScheduledTransactionsResponseData
|
|
1711
|
-
*/
|
|
1712
|
-
scheduled_transactions: Array<ScheduledTransactionDetail>;
|
|
1713
|
-
/**
|
|
1714
|
-
* The knowledge of the server
|
|
1715
|
-
* @type {number}
|
|
1716
|
-
* @memberof ScheduledTransactionsResponseData
|
|
1717
|
-
*/
|
|
1718
|
-
server_knowledge: number;
|
|
1719
|
-
}
|
|
1720
|
-
/**
|
|
1721
|
-
*
|
|
1722
|
-
* @export
|
|
1723
|
-
* @interface SubTransaction
|
|
1724
|
-
*/
|
|
1725
|
-
export interface SubTransaction {
|
|
1726
|
-
/**
|
|
1727
|
-
*
|
|
1728
|
-
* @type {string}
|
|
1729
|
-
* @memberof SubTransaction
|
|
1730
|
-
*/
|
|
1731
|
-
id: string;
|
|
1732
|
-
/**
|
|
1733
|
-
*
|
|
1734
|
-
* @type {string}
|
|
1735
|
-
* @memberof SubTransaction
|
|
1736
|
-
*/
|
|
1737
|
-
transaction_id: string;
|
|
1738
|
-
/**
|
|
1739
|
-
* The subtransaction amount in milliunits format
|
|
1740
|
-
* @type {number}
|
|
1741
|
-
* @memberof SubTransaction
|
|
1742
|
-
*/
|
|
1743
|
-
amount: number;
|
|
1744
|
-
/**
|
|
1745
|
-
*
|
|
1746
|
-
* @type {string}
|
|
1747
|
-
* @memberof SubTransaction
|
|
1748
|
-
*/
|
|
1749
|
-
memo?: string | null;
|
|
1750
|
-
/**
|
|
1751
|
-
*
|
|
1752
|
-
* @type {string}
|
|
1753
|
-
* @memberof SubTransaction
|
|
1754
|
-
*/
|
|
1755
|
-
payee_id?: string | null;
|
|
1756
|
-
/**
|
|
1757
|
-
*
|
|
1758
|
-
* @type {string}
|
|
1759
|
-
* @memberof SubTransaction
|
|
1760
|
-
*/
|
|
1761
|
-
payee_name?: string | null;
|
|
1762
|
-
/**
|
|
1763
|
-
*
|
|
1764
|
-
* @type {string}
|
|
1765
|
-
* @memberof SubTransaction
|
|
1766
|
-
*/
|
|
1767
|
-
category_id?: string | null;
|
|
1768
|
-
/**
|
|
1769
|
-
*
|
|
1770
|
-
* @type {string}
|
|
1771
|
-
* @memberof SubTransaction
|
|
1772
|
-
*/
|
|
1773
|
-
category_name?: string | null;
|
|
1774
|
-
/**
|
|
1775
|
-
* If a transfer, the account_id which the subtransaction transfers to
|
|
1776
|
-
* @type {string}
|
|
1777
|
-
* @memberof SubTransaction
|
|
1778
|
-
*/
|
|
1779
|
-
transfer_account_id?: string | null;
|
|
1780
|
-
/**
|
|
1781
|
-
* If a transfer, the id of transaction on the other side of the transfer
|
|
1782
|
-
* @type {string}
|
|
1783
|
-
* @memberof SubTransaction
|
|
1784
|
-
*/
|
|
1785
|
-
transfer_transaction_id?: string | null;
|
|
1786
|
-
/**
|
|
1787
|
-
* Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests.
|
|
1788
|
-
* @type {boolean}
|
|
1789
|
-
* @memberof SubTransaction
|
|
1790
|
-
*/
|
|
1791
|
-
deleted: boolean;
|
|
1792
|
-
}
|
|
1793
|
-
/**
|
|
1794
|
-
*
|
|
1795
|
-
* @export
|
|
1796
|
-
* @interface TransactionResponse
|
|
1797
|
-
*/
|
|
1798
|
-
export interface TransactionResponse {
|
|
1799
|
-
/**
|
|
1800
|
-
*
|
|
1801
|
-
* @type {TransactionResponseData}
|
|
1802
|
-
* @memberof TransactionResponse
|
|
1803
|
-
*/
|
|
1804
|
-
data: TransactionResponseData;
|
|
1805
|
-
}
|
|
1806
|
-
/**
|
|
1807
|
-
*
|
|
1808
|
-
* @export
|
|
1809
|
-
* @interface TransactionResponseData
|
|
1810
|
-
*/
|
|
1811
|
-
export interface TransactionResponseData {
|
|
1812
|
-
/**
|
|
1813
|
-
*
|
|
1814
|
-
* @type {TransactionDetail}
|
|
1815
|
-
* @memberof TransactionResponseData
|
|
1816
|
-
*/
|
|
1817
|
-
transaction: TransactionDetail;
|
|
1818
|
-
}
|
|
1819
|
-
/**
|
|
1820
|
-
*
|
|
1821
|
-
* @export
|
|
1822
|
-
* @interface TransactionSummary
|
|
1823
|
-
*/
|
|
1824
|
-
export interface TransactionSummary {
|
|
1825
|
-
/**
|
|
1826
|
-
*
|
|
1827
|
-
* @type {string}
|
|
1828
|
-
* @memberof TransactionSummary
|
|
1829
|
-
*/
|
|
1830
|
-
id: string;
|
|
1831
|
-
/**
|
|
1832
|
-
* The transaction date in ISO format (e.g. 2016-12-01)
|
|
1833
|
-
* @type {string}
|
|
1834
|
-
* @memberof TransactionSummary
|
|
1835
|
-
*/
|
|
1836
|
-
date: string;
|
|
1837
|
-
/**
|
|
1838
|
-
* The transaction amount in milliunits format
|
|
1839
|
-
* @type {number}
|
|
1840
|
-
* @memberof TransactionSummary
|
|
1841
|
-
*/
|
|
1842
|
-
amount: number;
|
|
1843
|
-
/**
|
|
1844
|
-
*
|
|
1845
|
-
* @type {string}
|
|
1846
|
-
* @memberof TransactionSummary
|
|
1847
|
-
*/
|
|
1848
|
-
memo?: string | null;
|
|
1849
|
-
/**
|
|
1850
|
-
* The cleared status of the transaction
|
|
1851
|
-
* @type {string}
|
|
1852
|
-
* @memberof TransactionSummary
|
|
1853
|
-
*/
|
|
1854
|
-
cleared: TransactionSummary.ClearedEnum;
|
|
1855
|
-
/**
|
|
1856
|
-
* Whether or not the transaction is approved
|
|
1857
|
-
* @type {boolean}
|
|
1858
|
-
* @memberof TransactionSummary
|
|
1859
|
-
*/
|
|
1860
|
-
approved: boolean;
|
|
1861
|
-
/**
|
|
1862
|
-
* The transaction flag
|
|
1863
|
-
* @type {string}
|
|
1864
|
-
* @memberof TransactionSummary
|
|
1865
|
-
*/
|
|
1866
|
-
flag_color?: TransactionSummary.FlagColorEnum | null;
|
|
1867
|
-
/**
|
|
1868
|
-
*
|
|
1869
|
-
* @type {string}
|
|
1870
|
-
* @memberof TransactionSummary
|
|
1871
|
-
*/
|
|
1872
|
-
account_id: string;
|
|
1873
|
-
/**
|
|
1874
|
-
*
|
|
1875
|
-
* @type {string}
|
|
1876
|
-
* @memberof TransactionSummary
|
|
1877
|
-
*/
|
|
1878
|
-
payee_id?: string | null;
|
|
1879
|
-
/**
|
|
1880
|
-
*
|
|
1881
|
-
* @type {string}
|
|
1882
|
-
* @memberof TransactionSummary
|
|
1883
|
-
*/
|
|
1884
|
-
category_id?: string | null;
|
|
1885
|
-
/**
|
|
1886
|
-
* If a transfer transaction, the account to which it transfers
|
|
1887
|
-
* @type {string}
|
|
1888
|
-
* @memberof TransactionSummary
|
|
1889
|
-
*/
|
|
1890
|
-
transfer_account_id?: string | null;
|
|
1891
|
-
/**
|
|
1892
|
-
* If a transfer transaction, the id of transaction on the other side of the transfer
|
|
1893
|
-
* @type {string}
|
|
1894
|
-
* @memberof TransactionSummary
|
|
1895
|
-
*/
|
|
1896
|
-
transfer_transaction_id?: string | null;
|
|
1897
|
-
/**
|
|
1898
|
-
* If transaction is matched, the id of the matched transaction
|
|
1899
|
-
* @type {string}
|
|
1900
|
-
* @memberof TransactionSummary
|
|
1901
|
-
*/
|
|
1902
|
-
matched_transaction_id?: string | null;
|
|
1903
|
-
/**
|
|
1904
|
-
* If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
|
|
1905
|
-
* @type {string}
|
|
1906
|
-
* @memberof TransactionSummary
|
|
1907
|
-
*/
|
|
1908
|
-
import_id?: string | null;
|
|
1909
|
-
/**
|
|
1910
|
-
* If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
|
|
1911
|
-
* @type {string}
|
|
1912
|
-
* @memberof TransactionSummary
|
|
1913
|
-
*/
|
|
1914
|
-
import_payee_name?: string | null;
|
|
1915
|
-
/**
|
|
1916
|
-
* If the transaction was imported, the original payee name as it appeared on the statement
|
|
1917
|
-
* @type {string}
|
|
1918
|
-
* @memberof TransactionSummary
|
|
1919
|
-
*/
|
|
1920
|
-
import_payee_name_original?: string | null;
|
|
1921
|
-
/**
|
|
1922
|
-
* If the transaction is a debt/loan account transaction, the type of transaction
|
|
1923
|
-
* @type {string}
|
|
1924
|
-
* @memberof TransactionSummary
|
|
1925
|
-
*/
|
|
1926
|
-
debt_transaction_type?: TransactionSummary.DebtTransactionTypeEnum | null;
|
|
1927
|
-
/**
|
|
1928
|
-
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
1929
|
-
* @type {boolean}
|
|
1930
|
-
* @memberof TransactionSummary
|
|
1931
|
-
*/
|
|
1932
|
-
deleted: boolean;
|
|
1933
|
-
}
|
|
1934
|
-
/**
|
|
1935
|
-
* @export
|
|
1936
|
-
* @namespace TransactionSummary
|
|
1937
|
-
*/
|
|
1938
|
-
export declare namespace TransactionSummary {
|
|
1939
|
-
/**
|
|
1940
|
-
* @export
|
|
1941
|
-
* @enum {string}
|
|
1942
|
-
*/
|
|
1943
|
-
enum ClearedEnum {
|
|
1944
|
-
Cleared,
|
|
1945
|
-
Uncleared,
|
|
1946
|
-
Reconciled
|
|
1947
|
-
}
|
|
1948
|
-
/**
|
|
1949
|
-
* @export
|
|
1950
|
-
* @enum {string}
|
|
1951
|
-
*/
|
|
1952
|
-
enum FlagColorEnum {
|
|
1953
|
-
Red,
|
|
1954
|
-
Orange,
|
|
1955
|
-
Yellow,
|
|
1956
|
-
Green,
|
|
1957
|
-
Blue,
|
|
1958
|
-
Purple
|
|
1959
|
-
}
|
|
1960
|
-
/**
|
|
1961
|
-
* @export
|
|
1962
|
-
* @enum {string}
|
|
1963
|
-
*/
|
|
1964
|
-
enum DebtTransactionTypeEnum {
|
|
1965
|
-
Payment,
|
|
1966
|
-
Refund,
|
|
1967
|
-
Fee,
|
|
1968
|
-
Interest,
|
|
1969
|
-
Escrow,
|
|
1970
|
-
BalancedAdjustment,
|
|
1971
|
-
Credit,
|
|
1972
|
-
Charge
|
|
1973
|
-
}
|
|
1974
|
-
}
|
|
1975
|
-
/**
|
|
1976
|
-
*
|
|
1977
|
-
* @export
|
|
1978
|
-
* @interface TransactionsImportResponse
|
|
1979
|
-
*/
|
|
1980
|
-
export interface TransactionsImportResponse {
|
|
1981
|
-
/**
|
|
1982
|
-
*
|
|
1983
|
-
* @type {TransactionsImportResponseData}
|
|
1984
|
-
* @memberof TransactionsImportResponse
|
|
1985
|
-
*/
|
|
1986
|
-
data: TransactionsImportResponseData;
|
|
1987
|
-
}
|
|
1988
|
-
/**
|
|
1989
|
-
*
|
|
1990
|
-
* @export
|
|
1991
|
-
* @interface TransactionsImportResponseData
|
|
1992
|
-
*/
|
|
1993
|
-
export interface TransactionsImportResponseData {
|
|
1994
|
-
/**
|
|
1995
|
-
* The list of transaction ids that were imported.
|
|
1996
|
-
* @type {Array<string>}
|
|
1997
|
-
* @memberof TransactionsImportResponseData
|
|
1998
|
-
*/
|
|
1999
|
-
transaction_ids: Array<string>;
|
|
2000
|
-
}
|
|
2001
|
-
/**
|
|
2002
|
-
*
|
|
2003
|
-
* @export
|
|
2004
|
-
* @interface TransactionsResponse
|
|
2005
|
-
*/
|
|
2006
|
-
export interface TransactionsResponse {
|
|
2007
|
-
/**
|
|
2008
|
-
*
|
|
2009
|
-
* @type {TransactionsResponseData}
|
|
2010
|
-
* @memberof TransactionsResponse
|
|
2011
|
-
*/
|
|
2012
|
-
data: TransactionsResponseData;
|
|
2013
|
-
}
|
|
2014
|
-
/**
|
|
2015
|
-
*
|
|
2016
|
-
* @export
|
|
2017
|
-
* @interface TransactionsResponseData
|
|
2018
|
-
*/
|
|
2019
|
-
export interface TransactionsResponseData {
|
|
2020
|
-
/**
|
|
2021
|
-
*
|
|
2022
|
-
* @type {Array<TransactionDetail>}
|
|
2023
|
-
* @memberof TransactionsResponseData
|
|
2024
|
-
*/
|
|
2025
|
-
transactions: Array<TransactionDetail>;
|
|
2026
|
-
/**
|
|
2027
|
-
* The knowledge of the server
|
|
2028
|
-
* @type {number}
|
|
2029
|
-
* @memberof TransactionsResponseData
|
|
2030
|
-
*/
|
|
2031
|
-
server_knowledge: number;
|
|
2032
|
-
}
|
|
2033
|
-
/**
|
|
2034
|
-
*
|
|
2035
|
-
* @export
|
|
2036
|
-
* @interface User
|
|
2037
|
-
*/
|
|
2038
|
-
export interface User {
|
|
2039
|
-
/**
|
|
2040
|
-
*
|
|
2041
|
-
* @type {string}
|
|
2042
|
-
* @memberof User
|
|
2043
|
-
*/
|
|
2044
|
-
id: string;
|
|
2045
|
-
}
|
|
2046
|
-
/**
|
|
2047
|
-
*
|
|
2048
|
-
* @export
|
|
2049
|
-
* @interface UserResponse
|
|
2050
|
-
*/
|
|
2051
|
-
export interface UserResponse {
|
|
2052
|
-
/**
|
|
2053
|
-
*
|
|
2054
|
-
* @type {UserResponseData}
|
|
2055
|
-
* @memberof UserResponse
|
|
2056
|
-
*/
|
|
2057
|
-
data: UserResponseData;
|
|
2058
|
-
}
|
|
2059
|
-
/**
|
|
2060
|
-
*
|
|
2061
|
-
* @export
|
|
2062
|
-
* @interface UserResponseData
|
|
2063
|
-
*/
|
|
2064
|
-
export interface UserResponseData {
|
|
2065
|
-
/**
|
|
2066
|
-
*
|
|
2067
|
-
* @type {User}
|
|
2068
|
-
* @memberof UserResponseData
|
|
2069
|
-
*/
|
|
2070
|
-
user: User;
|
|
2071
|
-
}
|
|
2072
|
-
/**
|
|
2073
|
-
*
|
|
2074
|
-
* @export
|
|
2075
|
-
* @interface BudgetDetail
|
|
2076
|
-
*/
|
|
2077
|
-
export interface BudgetDetail {
|
|
2078
|
-
/**
|
|
2079
|
-
*
|
|
2080
|
-
* @type {string}
|
|
2081
|
-
* @memberof BudgetDetail
|
|
2082
|
-
*/
|
|
2083
|
-
id: string;
|
|
2084
|
-
/**
|
|
2085
|
-
*
|
|
2086
|
-
* @type {string}
|
|
2087
|
-
* @memberof BudgetDetail
|
|
2088
|
-
*/
|
|
2089
|
-
name: string;
|
|
2090
|
-
/**
|
|
2091
|
-
* The last time any changes were made to the budget from either a web or mobile client
|
|
2092
|
-
* @type {string}
|
|
2093
|
-
* @memberof BudgetDetail
|
|
2094
|
-
*/
|
|
2095
|
-
last_modified_on?: string | null;
|
|
2096
|
-
/**
|
|
2097
|
-
* The earliest budget month
|
|
2098
|
-
* @type {string}
|
|
2099
|
-
* @memberof BudgetDetail
|
|
2100
|
-
*/
|
|
2101
|
-
first_month?: string | null;
|
|
2102
|
-
/**
|
|
2103
|
-
* The latest budget month
|
|
2104
|
-
* @type {string}
|
|
2105
|
-
* @memberof BudgetDetail
|
|
2106
|
-
*/
|
|
2107
|
-
last_month?: string | null;
|
|
2108
|
-
/**
|
|
2109
|
-
*
|
|
2110
|
-
* @type {DateFormat}
|
|
2111
|
-
* @memberof BudgetDetail
|
|
2112
|
-
*/
|
|
2113
|
-
date_format?: DateFormat | null;
|
|
2114
|
-
/**
|
|
2115
|
-
*
|
|
2116
|
-
* @type {CurrencyFormat}
|
|
2117
|
-
* @memberof BudgetDetail
|
|
2118
|
-
*/
|
|
2119
|
-
currency_format?: CurrencyFormat | null;
|
|
2120
|
-
/**
|
|
2121
|
-
*
|
|
2122
|
-
* @type {Array<Account>}
|
|
2123
|
-
* @memberof BudgetDetail
|
|
2124
|
-
*/
|
|
2125
|
-
accounts?: Array<Account> | null;
|
|
2126
|
-
/**
|
|
2127
|
-
*
|
|
2128
|
-
* @type {Array<Payee>}
|
|
2129
|
-
* @memberof BudgetDetail
|
|
2130
|
-
*/
|
|
2131
|
-
payees?: Array<Payee> | null;
|
|
2132
|
-
/**
|
|
2133
|
-
*
|
|
2134
|
-
* @type {Array<PayeeLocation>}
|
|
2135
|
-
* @memberof BudgetDetail
|
|
2136
|
-
*/
|
|
2137
|
-
payee_locations?: Array<PayeeLocation> | null;
|
|
2138
|
-
/**
|
|
2139
|
-
*
|
|
2140
|
-
* @type {Array<CategoryGroup>}
|
|
2141
|
-
* @memberof BudgetDetail
|
|
2142
|
-
*/
|
|
2143
|
-
category_groups?: Array<CategoryGroup> | null;
|
|
2144
|
-
/**
|
|
2145
|
-
*
|
|
2146
|
-
* @type {Array<Category>}
|
|
2147
|
-
* @memberof BudgetDetail
|
|
2148
|
-
*/
|
|
2149
|
-
categories?: Array<Category> | null;
|
|
2150
|
-
/**
|
|
2151
|
-
*
|
|
2152
|
-
* @type {Array<MonthDetail>}
|
|
2153
|
-
* @memberof BudgetDetail
|
|
2154
|
-
*/
|
|
2155
|
-
months?: Array<MonthDetail> | null;
|
|
2156
|
-
/**
|
|
2157
|
-
*
|
|
2158
|
-
* @type {Array<TransactionSummary>}
|
|
2159
|
-
* @memberof BudgetDetail
|
|
2160
|
-
*/
|
|
2161
|
-
transactions?: Array<TransactionSummary> | null;
|
|
2162
|
-
/**
|
|
2163
|
-
*
|
|
2164
|
-
* @type {Array<SubTransaction>}
|
|
2165
|
-
* @memberof BudgetDetail
|
|
2166
|
-
*/
|
|
2167
|
-
subtransactions?: Array<SubTransaction> | null;
|
|
2168
|
-
/**
|
|
2169
|
-
*
|
|
2170
|
-
* @type {Array<ScheduledTransactionSummary>}
|
|
2171
|
-
* @memberof BudgetDetail
|
|
2172
|
-
*/
|
|
2173
|
-
scheduled_transactions?: Array<ScheduledTransactionSummary> | null;
|
|
2174
|
-
/**
|
|
2175
|
-
*
|
|
2176
|
-
* @type {Array<ScheduledSubTransaction>}
|
|
2177
|
-
* @memberof BudgetDetail
|
|
2178
|
-
*/
|
|
2179
|
-
scheduled_subtransactions?: Array<ScheduledSubTransaction> | null;
|
|
2180
|
-
}
|
|
2181
|
-
/**
|
|
2182
|
-
*
|
|
2183
|
-
* @export
|
|
2184
|
-
* @interface CategoryGroupWithCategories
|
|
2185
|
-
*/
|
|
2186
|
-
export interface CategoryGroupWithCategories {
|
|
2187
|
-
/**
|
|
2188
|
-
*
|
|
2189
|
-
* @type {string}
|
|
2190
|
-
* @memberof CategoryGroupWithCategories
|
|
2191
|
-
*/
|
|
2192
|
-
id: string;
|
|
2193
|
-
/**
|
|
2194
|
-
*
|
|
2195
|
-
* @type {string}
|
|
2196
|
-
* @memberof CategoryGroupWithCategories
|
|
2197
|
-
*/
|
|
2198
|
-
name: string;
|
|
2199
|
-
/**
|
|
2200
|
-
* Whether or not the category group is hidden
|
|
2201
|
-
* @type {boolean}
|
|
2202
|
-
* @memberof CategoryGroupWithCategories
|
|
2203
|
-
*/
|
|
2204
|
-
hidden: boolean;
|
|
2205
|
-
/**
|
|
2206
|
-
* Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.
|
|
2207
|
-
* @type {boolean}
|
|
2208
|
-
* @memberof CategoryGroupWithCategories
|
|
2209
|
-
*/
|
|
2210
|
-
deleted: boolean;
|
|
2211
|
-
/**
|
|
2212
|
-
* Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
2213
|
-
* @type {Array<Category>}
|
|
2214
|
-
* @memberof CategoryGroupWithCategories
|
|
2215
|
-
*/
|
|
2216
|
-
categories: Array<Category>;
|
|
2217
|
-
}
|
|
2218
|
-
/**
|
|
2219
|
-
*
|
|
2220
|
-
* @export
|
|
2221
|
-
* @interface HybridTransaction
|
|
2222
|
-
*/
|
|
2223
|
-
export interface HybridTransaction {
|
|
2224
|
-
/**
|
|
2225
|
-
*
|
|
2226
|
-
* @type {string}
|
|
2227
|
-
* @memberof HybridTransaction
|
|
2228
|
-
*/
|
|
2229
|
-
id: string;
|
|
2230
|
-
/**
|
|
2231
|
-
* The transaction date in ISO format (e.g. 2016-12-01)
|
|
2232
|
-
* @type {string}
|
|
2233
|
-
* @memberof HybridTransaction
|
|
2234
|
-
*/
|
|
2235
|
-
date: string;
|
|
2236
|
-
/**
|
|
2237
|
-
* The transaction amount in milliunits format
|
|
2238
|
-
* @type {number}
|
|
2239
|
-
* @memberof HybridTransaction
|
|
2240
|
-
*/
|
|
2241
|
-
amount: number;
|
|
2242
|
-
/**
|
|
2243
|
-
*
|
|
2244
|
-
* @type {string}
|
|
2245
|
-
* @memberof HybridTransaction
|
|
2246
|
-
*/
|
|
2247
|
-
memo?: string | null;
|
|
2248
|
-
/**
|
|
2249
|
-
* The cleared status of the transaction
|
|
2250
|
-
* @type {string}
|
|
2251
|
-
* @memberof HybridTransaction
|
|
2252
|
-
*/
|
|
2253
|
-
cleared: HybridTransaction.ClearedEnum;
|
|
2254
|
-
/**
|
|
2255
|
-
* Whether or not the transaction is approved
|
|
2256
|
-
* @type {boolean}
|
|
2257
|
-
* @memberof HybridTransaction
|
|
2258
|
-
*/
|
|
2259
|
-
approved: boolean;
|
|
2260
|
-
/**
|
|
2261
|
-
* The transaction flag
|
|
2262
|
-
* @type {string}
|
|
2263
|
-
* @memberof HybridTransaction
|
|
2264
|
-
*/
|
|
2265
|
-
flag_color?: HybridTransaction.FlagColorEnum | null;
|
|
2266
|
-
/**
|
|
2267
|
-
*
|
|
2268
|
-
* @type {string}
|
|
2269
|
-
* @memberof HybridTransaction
|
|
2270
|
-
*/
|
|
2271
|
-
account_id: string;
|
|
2272
|
-
/**
|
|
2273
|
-
*
|
|
2274
|
-
* @type {string}
|
|
2275
|
-
* @memberof HybridTransaction
|
|
2276
|
-
*/
|
|
2277
|
-
payee_id?: string | null;
|
|
2278
|
-
/**
|
|
2279
|
-
*
|
|
2280
|
-
* @type {string}
|
|
2281
|
-
* @memberof HybridTransaction
|
|
2282
|
-
*/
|
|
2283
|
-
category_id?: string | null;
|
|
2284
|
-
/**
|
|
2285
|
-
* If a transfer transaction, the account to which it transfers
|
|
2286
|
-
* @type {string}
|
|
2287
|
-
* @memberof HybridTransaction
|
|
2288
|
-
*/
|
|
2289
|
-
transfer_account_id?: string | null;
|
|
2290
|
-
/**
|
|
2291
|
-
* If a transfer transaction, the id of transaction on the other side of the transfer
|
|
2292
|
-
* @type {string}
|
|
2293
|
-
* @memberof HybridTransaction
|
|
2294
|
-
*/
|
|
2295
|
-
transfer_transaction_id?: string | null;
|
|
2296
|
-
/**
|
|
2297
|
-
* If transaction is matched, the id of the matched transaction
|
|
2298
|
-
* @type {string}
|
|
2299
|
-
* @memberof HybridTransaction
|
|
2300
|
-
*/
|
|
2301
|
-
matched_transaction_id?: string | null;
|
|
2302
|
-
/**
|
|
2303
|
-
* If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
|
|
2304
|
-
* @type {string}
|
|
2305
|
-
* @memberof HybridTransaction
|
|
2306
|
-
*/
|
|
2307
|
-
import_id?: string | null;
|
|
2308
|
-
/**
|
|
2309
|
-
* If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
|
|
2310
|
-
* @type {string}
|
|
2311
|
-
* @memberof HybridTransaction
|
|
2312
|
-
*/
|
|
2313
|
-
import_payee_name?: string | null;
|
|
2314
|
-
/**
|
|
2315
|
-
* If the transaction was imported, the original payee name as it appeared on the statement
|
|
2316
|
-
* @type {string}
|
|
2317
|
-
* @memberof HybridTransaction
|
|
2318
|
-
*/
|
|
2319
|
-
import_payee_name_original?: string | null;
|
|
2320
|
-
/**
|
|
2321
|
-
* If the transaction is a debt/loan account transaction, the type of transaction
|
|
2322
|
-
* @type {string}
|
|
2323
|
-
* @memberof HybridTransaction
|
|
2324
|
-
*/
|
|
2325
|
-
debt_transaction_type?: HybridTransaction.DebtTransactionTypeEnum | null;
|
|
2326
|
-
/**
|
|
2327
|
-
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
2328
|
-
* @type {boolean}
|
|
2329
|
-
* @memberof HybridTransaction
|
|
2330
|
-
*/
|
|
2331
|
-
deleted: boolean;
|
|
2332
|
-
/**
|
|
2333
|
-
* Whether the hybrid transaction represents a regular transaction or a subtransaction
|
|
2334
|
-
* @type {string}
|
|
2335
|
-
* @memberof HybridTransaction
|
|
2336
|
-
*/
|
|
2337
|
-
type: HybridTransaction.TypeEnum;
|
|
2338
|
-
/**
|
|
2339
|
-
* For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null.
|
|
2340
|
-
* @type {string}
|
|
2341
|
-
* @memberof HybridTransaction
|
|
2342
|
-
*/
|
|
2343
|
-
parent_transaction_id?: string | null;
|
|
2344
|
-
/**
|
|
2345
|
-
*
|
|
2346
|
-
* @type {string}
|
|
2347
|
-
* @memberof HybridTransaction
|
|
2348
|
-
*/
|
|
2349
|
-
account_name: string;
|
|
2350
|
-
/**
|
|
2351
|
-
*
|
|
2352
|
-
* @type {string}
|
|
2353
|
-
* @memberof HybridTransaction
|
|
2354
|
-
*/
|
|
2355
|
-
payee_name?: string | null;
|
|
2356
|
-
/**
|
|
2357
|
-
*
|
|
2358
|
-
* @type {string}
|
|
2359
|
-
* @memberof HybridTransaction
|
|
2360
|
-
*/
|
|
2361
|
-
category_name?: string | null;
|
|
2362
|
-
}
|
|
2363
|
-
/**
|
|
2364
|
-
* @export
|
|
2365
|
-
* @namespace HybridTransaction
|
|
2366
|
-
*/
|
|
2367
|
-
export declare namespace HybridTransaction {
|
|
2368
|
-
/**
|
|
2369
|
-
* @export
|
|
2370
|
-
* @enum {string}
|
|
2371
|
-
*/
|
|
2372
|
-
enum ClearedEnum {
|
|
2373
|
-
Cleared,
|
|
2374
|
-
Uncleared,
|
|
2375
|
-
Reconciled
|
|
2376
|
-
}
|
|
2377
|
-
/**
|
|
2378
|
-
* @export
|
|
2379
|
-
* @enum {string}
|
|
2380
|
-
*/
|
|
2381
|
-
enum FlagColorEnum {
|
|
2382
|
-
Red,
|
|
2383
|
-
Orange,
|
|
2384
|
-
Yellow,
|
|
2385
|
-
Green,
|
|
2386
|
-
Blue,
|
|
2387
|
-
Purple
|
|
2388
|
-
}
|
|
2389
|
-
/**
|
|
2390
|
-
* @export
|
|
2391
|
-
* @enum {string}
|
|
2392
|
-
*/
|
|
2393
|
-
enum DebtTransactionTypeEnum {
|
|
2394
|
-
Payment,
|
|
2395
|
-
Refund,
|
|
2396
|
-
Fee,
|
|
2397
|
-
Interest,
|
|
2398
|
-
Escrow,
|
|
2399
|
-
BalancedAdjustment,
|
|
2400
|
-
Credit,
|
|
2401
|
-
Charge
|
|
2402
|
-
}
|
|
2403
|
-
/**
|
|
2404
|
-
* @export
|
|
2405
|
-
* @enum {string}
|
|
2406
|
-
*/
|
|
2407
|
-
enum TypeEnum {
|
|
2408
|
-
Transaction,
|
|
2409
|
-
Subtransaction
|
|
2410
|
-
}
|
|
2411
|
-
}
|
|
2412
|
-
/**
|
|
2413
|
-
*
|
|
2414
|
-
* @export
|
|
2415
|
-
* @interface MonthDetail
|
|
2416
|
-
*/
|
|
2417
|
-
export interface MonthDetail {
|
|
2418
|
-
/**
|
|
2419
|
-
*
|
|
2420
|
-
* @type {string}
|
|
2421
|
-
* @memberof MonthDetail
|
|
2422
|
-
*/
|
|
2423
|
-
month: string;
|
|
2424
|
-
/**
|
|
2425
|
-
*
|
|
2426
|
-
* @type {string}
|
|
2427
|
-
* @memberof MonthDetail
|
|
2428
|
-
*/
|
|
2429
|
-
note?: string | null;
|
|
2430
|
-
/**
|
|
2431
|
-
* The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
|
|
2432
|
-
* @type {number}
|
|
2433
|
-
* @memberof MonthDetail
|
|
2434
|
-
*/
|
|
2435
|
-
income: number;
|
|
2436
|
-
/**
|
|
2437
|
-
* The total amount budgeted in the month
|
|
2438
|
-
* @type {number}
|
|
2439
|
-
* @memberof MonthDetail
|
|
2440
|
-
*/
|
|
2441
|
-
budgeted: number;
|
|
2442
|
-
/**
|
|
2443
|
-
* The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
|
|
2444
|
-
* @type {number}
|
|
2445
|
-
* @memberof MonthDetail
|
|
2446
|
-
*/
|
|
2447
|
-
activity: number;
|
|
2448
|
-
/**
|
|
2449
|
-
* The available amount for 'Ready to Assign'
|
|
2450
|
-
* @type {number}
|
|
2451
|
-
* @memberof MonthDetail
|
|
2452
|
-
*/
|
|
2453
|
-
to_be_budgeted: number;
|
|
2454
|
-
/**
|
|
2455
|
-
* The Age of Money as of the month
|
|
2456
|
-
* @type {number}
|
|
2457
|
-
* @memberof MonthDetail
|
|
2458
|
-
*/
|
|
2459
|
-
age_of_money?: number | null;
|
|
2460
|
-
/**
|
|
2461
|
-
* Whether or not the month has been deleted. Deleted months will only be included in delta requests.
|
|
2462
|
-
* @type {boolean}
|
|
2463
|
-
* @memberof MonthDetail
|
|
2464
|
-
*/
|
|
2465
|
-
deleted: boolean;
|
|
2466
|
-
/**
|
|
2467
|
-
* The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.
|
|
2468
|
-
* @type {Array<Category>}
|
|
2469
|
-
* @memberof MonthDetail
|
|
2470
|
-
*/
|
|
2471
|
-
categories: Array<Category>;
|
|
2472
|
-
}
|
|
2473
|
-
/**
|
|
2474
|
-
*
|
|
2475
|
-
* @export
|
|
2476
|
-
* @interface SaveTransaction
|
|
2477
|
-
*/
|
|
2478
|
-
export interface SaveTransaction {
|
|
2479
|
-
/**
|
|
2480
|
-
*
|
|
2481
|
-
* @type {string}
|
|
2482
|
-
* @memberof SaveTransaction
|
|
2483
|
-
*/
|
|
2484
|
-
account_id?: string | null;
|
|
2485
|
-
/**
|
|
2486
|
-
* The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
|
|
2487
|
-
* @type {string}
|
|
2488
|
-
* @memberof SaveTransaction
|
|
2489
|
-
*/
|
|
2490
|
-
date?: string | null;
|
|
2491
|
-
/**
|
|
2492
|
-
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
2493
|
-
* @type {number}
|
|
2494
|
-
* @memberof SaveTransaction
|
|
2495
|
-
*/
|
|
2496
|
-
amount?: number | null;
|
|
2497
|
-
/**
|
|
2498
|
-
* The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
|
|
2499
|
-
* @type {string}
|
|
2500
|
-
* @memberof SaveTransaction
|
|
2501
|
-
*/
|
|
2502
|
-
payee_id?: string | null;
|
|
2503
|
-
/**
|
|
2504
|
-
* The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
|
|
2505
|
-
* @type {string}
|
|
2506
|
-
* @memberof SaveTransaction
|
|
2507
|
-
*/
|
|
2508
|
-
payee_name?: string | null;
|
|
2509
|
-
/**
|
|
2510
|
-
* The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
|
|
2511
|
-
* @type {string}
|
|
2512
|
-
* @memberof SaveTransaction
|
|
2513
|
-
*/
|
|
2514
|
-
category_id?: string | null;
|
|
2515
|
-
/**
|
|
2516
|
-
*
|
|
2517
|
-
* @type {string}
|
|
2518
|
-
* @memberof SaveTransaction
|
|
2519
|
-
*/
|
|
2520
|
-
memo?: string | null;
|
|
2521
|
-
/**
|
|
2522
|
-
* The cleared status of the transaction
|
|
2523
|
-
* @type {string}
|
|
2524
|
-
* @memberof SaveTransaction
|
|
2525
|
-
*/
|
|
2526
|
-
cleared?: SaveTransaction.ClearedEnum | null;
|
|
2527
|
-
/**
|
|
2528
|
-
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
2529
|
-
* @type {boolean}
|
|
2530
|
-
* @memberof SaveTransaction
|
|
2531
|
-
*/
|
|
2532
|
-
approved?: boolean | null;
|
|
2533
|
-
/**
|
|
2534
|
-
* The transaction flag
|
|
2535
|
-
* @type {string}
|
|
2536
|
-
* @memberof SaveTransaction
|
|
2537
|
-
*/
|
|
2538
|
-
flag_color?: SaveTransaction.FlagColorEnum | null;
|
|
2539
|
-
/**
|
|
2540
|
-
* If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
|
|
2541
|
-
* @type {string}
|
|
2542
|
-
* @memberof SaveTransaction
|
|
2543
|
-
*/
|
|
2544
|
-
import_id?: string | null;
|
|
2545
|
-
/**
|
|
2546
|
-
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
2547
|
-
* @type {Array<SaveSubTransaction>}
|
|
2548
|
-
* @memberof SaveTransaction
|
|
2549
|
-
*/
|
|
2550
|
-
subtransactions?: Array<SaveSubTransaction> | null;
|
|
2551
|
-
}
|
|
2552
|
-
/**
|
|
2553
|
-
* @export
|
|
2554
|
-
* @namespace SaveTransaction
|
|
2555
|
-
*/
|
|
2556
|
-
export declare namespace SaveTransaction {
|
|
2557
|
-
/**
|
|
2558
|
-
* @export
|
|
2559
|
-
* @enum {string}
|
|
2560
|
-
*/
|
|
2561
|
-
enum ClearedEnum {
|
|
2562
|
-
Cleared,
|
|
2563
|
-
Uncleared,
|
|
2564
|
-
Reconciled
|
|
2565
|
-
}
|
|
2566
|
-
/**
|
|
2567
|
-
* @export
|
|
2568
|
-
* @enum {string}
|
|
2569
|
-
*/
|
|
2570
|
-
enum FlagColorEnum {
|
|
2571
|
-
Red,
|
|
2572
|
-
Orange,
|
|
2573
|
-
Yellow,
|
|
2574
|
-
Green,
|
|
2575
|
-
Blue,
|
|
2576
|
-
Purple
|
|
2577
|
-
}
|
|
2578
|
-
}
|
|
2579
|
-
/**
|
|
2580
|
-
*
|
|
2581
|
-
* @export
|
|
2582
|
-
* @interface SaveTransactionWithId
|
|
2583
|
-
*/
|
|
2584
|
-
export interface SaveTransactionWithId {
|
|
2585
|
-
/**
|
|
2586
|
-
*
|
|
2587
|
-
* @type {string}
|
|
2588
|
-
* @memberof SaveTransactionWithId
|
|
2589
|
-
*/
|
|
2590
|
-
account_id?: string | null;
|
|
2591
|
-
/**
|
|
2592
|
-
* The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
|
|
2593
|
-
* @type {string}
|
|
2594
|
-
* @memberof SaveTransactionWithId
|
|
2595
|
-
*/
|
|
2596
|
-
date?: string | null;
|
|
2597
|
-
/**
|
|
2598
|
-
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
2599
|
-
* @type {number}
|
|
2600
|
-
* @memberof SaveTransactionWithId
|
|
2601
|
-
*/
|
|
2602
|
-
amount?: number | null;
|
|
2603
|
-
/**
|
|
2604
|
-
* The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
|
|
2605
|
-
* @type {string}
|
|
2606
|
-
* @memberof SaveTransactionWithId
|
|
2607
|
-
*/
|
|
2608
|
-
payee_id?: string | null;
|
|
2609
|
-
/**
|
|
2610
|
-
* The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
|
|
2611
|
-
* @type {string}
|
|
2612
|
-
* @memberof SaveTransactionWithId
|
|
2613
|
-
*/
|
|
2614
|
-
payee_name?: string | null;
|
|
2615
|
-
/**
|
|
2616
|
-
* The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
|
|
2617
|
-
* @type {string}
|
|
2618
|
-
* @memberof SaveTransactionWithId
|
|
2619
|
-
*/
|
|
2620
|
-
category_id?: string | null;
|
|
2621
|
-
/**
|
|
2622
|
-
*
|
|
2623
|
-
* @type {string}
|
|
2624
|
-
* @memberof SaveTransactionWithId
|
|
2625
|
-
*/
|
|
2626
|
-
memo?: string | null;
|
|
2627
|
-
/**
|
|
2628
|
-
* The cleared status of the transaction
|
|
2629
|
-
* @type {string}
|
|
2630
|
-
* @memberof SaveTransactionWithId
|
|
2631
|
-
*/
|
|
2632
|
-
cleared?: SaveTransactionWithId.ClearedEnum | null;
|
|
2633
|
-
/**
|
|
2634
|
-
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
2635
|
-
* @type {boolean}
|
|
2636
|
-
* @memberof SaveTransactionWithId
|
|
2637
|
-
*/
|
|
2638
|
-
approved?: boolean | null;
|
|
2639
|
-
/**
|
|
2640
|
-
* The transaction flag
|
|
2641
|
-
* @type {string}
|
|
2642
|
-
* @memberof SaveTransactionWithId
|
|
2643
|
-
*/
|
|
2644
|
-
flag_color?: SaveTransactionWithId.FlagColorEnum | null;
|
|
2645
|
-
/**
|
|
2646
|
-
* If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
|
|
2647
|
-
* @type {string}
|
|
2648
|
-
* @memberof SaveTransactionWithId
|
|
2649
|
-
*/
|
|
2650
|
-
import_id?: string | null;
|
|
2651
|
-
/**
|
|
2652
|
-
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
2653
|
-
* @type {Array<SaveSubTransaction>}
|
|
2654
|
-
* @memberof SaveTransactionWithId
|
|
2655
|
-
*/
|
|
2656
|
-
subtransactions?: Array<SaveSubTransaction> | null;
|
|
2657
|
-
/**
|
|
2658
|
-
*
|
|
2659
|
-
* @type {string}
|
|
2660
|
-
* @memberof SaveTransactionWithId
|
|
2661
|
-
*/
|
|
2662
|
-
id?: string | null;
|
|
2663
|
-
}
|
|
2664
|
-
/**
|
|
2665
|
-
* @export
|
|
2666
|
-
* @namespace SaveTransactionWithId
|
|
2667
|
-
*/
|
|
2668
|
-
export declare namespace SaveTransactionWithId {
|
|
2669
|
-
/**
|
|
2670
|
-
* @export
|
|
2671
|
-
* @enum {string}
|
|
2672
|
-
*/
|
|
2673
|
-
enum ClearedEnum {
|
|
2674
|
-
Cleared,
|
|
2675
|
-
Uncleared,
|
|
2676
|
-
Reconciled
|
|
2677
|
-
}
|
|
2678
|
-
/**
|
|
2679
|
-
* @export
|
|
2680
|
-
* @enum {string}
|
|
2681
|
-
*/
|
|
2682
|
-
enum FlagColorEnum {
|
|
2683
|
-
Red,
|
|
2684
|
-
Orange,
|
|
2685
|
-
Yellow,
|
|
2686
|
-
Green,
|
|
2687
|
-
Blue,
|
|
2688
|
-
Purple
|
|
2689
|
-
}
|
|
2690
|
-
}
|
|
2691
|
-
/**
|
|
2692
|
-
*
|
|
2693
|
-
* @export
|
|
2694
|
-
* @interface ScheduledTransactionDetail
|
|
2695
|
-
*/
|
|
2696
|
-
export interface ScheduledTransactionDetail {
|
|
2697
|
-
/**
|
|
2698
|
-
*
|
|
2699
|
-
* @type {string}
|
|
2700
|
-
* @memberof ScheduledTransactionDetail
|
|
2701
|
-
*/
|
|
2702
|
-
id: string;
|
|
2703
|
-
/**
|
|
2704
|
-
* The first date for which the Scheduled Transaction was scheduled.
|
|
2705
|
-
* @type {string}
|
|
2706
|
-
* @memberof ScheduledTransactionDetail
|
|
2707
|
-
*/
|
|
2708
|
-
date_first: string;
|
|
2709
|
-
/**
|
|
2710
|
-
* The next date for which the Scheduled Transaction is scheduled.
|
|
2711
|
-
* @type {string}
|
|
2712
|
-
* @memberof ScheduledTransactionDetail
|
|
2713
|
-
*/
|
|
2714
|
-
date_next: string;
|
|
2715
|
-
/**
|
|
2716
|
-
*
|
|
2717
|
-
* @type {string}
|
|
2718
|
-
* @memberof ScheduledTransactionDetail
|
|
2719
|
-
*/
|
|
2720
|
-
frequency: ScheduledTransactionDetail.FrequencyEnum;
|
|
2721
|
-
/**
|
|
2722
|
-
* The scheduled transaction amount in milliunits format
|
|
2723
|
-
* @type {number}
|
|
2724
|
-
* @memberof ScheduledTransactionDetail
|
|
2725
|
-
*/
|
|
2726
|
-
amount: number;
|
|
2727
|
-
/**
|
|
2728
|
-
*
|
|
2729
|
-
* @type {string}
|
|
2730
|
-
* @memberof ScheduledTransactionDetail
|
|
2731
|
-
*/
|
|
2732
|
-
memo?: string | null;
|
|
2733
|
-
/**
|
|
2734
|
-
* The scheduled transaction flag
|
|
2735
|
-
* @type {string}
|
|
2736
|
-
* @memberof ScheduledTransactionDetail
|
|
2737
|
-
*/
|
|
2738
|
-
flag_color?: ScheduledTransactionDetail.FlagColorEnum | null;
|
|
2739
|
-
/**
|
|
2740
|
-
*
|
|
2741
|
-
* @type {string}
|
|
2742
|
-
* @memberof ScheduledTransactionDetail
|
|
2743
|
-
*/
|
|
2744
|
-
account_id: string;
|
|
2745
|
-
/**
|
|
2746
|
-
*
|
|
2747
|
-
* @type {string}
|
|
2748
|
-
* @memberof ScheduledTransactionDetail
|
|
2749
|
-
*/
|
|
2750
|
-
payee_id?: string | null;
|
|
2751
|
-
/**
|
|
2752
|
-
*
|
|
2753
|
-
* @type {string}
|
|
2754
|
-
* @memberof ScheduledTransactionDetail
|
|
2755
|
-
*/
|
|
2756
|
-
category_id?: string | null;
|
|
2757
|
-
/**
|
|
2758
|
-
* If a transfer, the account_id which the scheduled transaction transfers to
|
|
2759
|
-
* @type {string}
|
|
2760
|
-
* @memberof ScheduledTransactionDetail
|
|
2761
|
-
*/
|
|
2762
|
-
transfer_account_id?: string | null;
|
|
2763
|
-
/**
|
|
2764
|
-
* Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
|
|
2765
|
-
* @type {boolean}
|
|
2766
|
-
* @memberof ScheduledTransactionDetail
|
|
2767
|
-
*/
|
|
2768
|
-
deleted: boolean;
|
|
2769
|
-
/**
|
|
2770
|
-
*
|
|
2771
|
-
* @type {string}
|
|
2772
|
-
* @memberof ScheduledTransactionDetail
|
|
2773
|
-
*/
|
|
2774
|
-
account_name: string;
|
|
2775
|
-
/**
|
|
2776
|
-
*
|
|
2777
|
-
* @type {string}
|
|
2778
|
-
* @memberof ScheduledTransactionDetail
|
|
2779
|
-
*/
|
|
2780
|
-
payee_name?: string | null;
|
|
2781
|
-
/**
|
|
2782
|
-
*
|
|
2783
|
-
* @type {string}
|
|
2784
|
-
* @memberof ScheduledTransactionDetail
|
|
2785
|
-
*/
|
|
2786
|
-
category_name?: string | null;
|
|
2787
|
-
/**
|
|
2788
|
-
* If a split scheduled transaction, the subtransactions.
|
|
2789
|
-
* @type {Array<ScheduledSubTransaction>}
|
|
2790
|
-
* @memberof ScheduledTransactionDetail
|
|
2791
|
-
*/
|
|
2792
|
-
subtransactions: Array<ScheduledSubTransaction>;
|
|
2793
|
-
}
|
|
2794
|
-
/**
|
|
2795
|
-
* @export
|
|
2796
|
-
* @namespace ScheduledTransactionDetail
|
|
2797
|
-
*/
|
|
2798
|
-
export declare namespace ScheduledTransactionDetail {
|
|
2799
|
-
/**
|
|
2800
|
-
* @export
|
|
2801
|
-
* @enum {string}
|
|
2802
|
-
*/
|
|
2803
|
-
enum FrequencyEnum {
|
|
2804
|
-
Never,
|
|
2805
|
-
Daily,
|
|
2806
|
-
Weekly,
|
|
2807
|
-
EveryOtherWeek,
|
|
2808
|
-
TwiceAMonth,
|
|
2809
|
-
Every4Weeks,
|
|
2810
|
-
Monthly,
|
|
2811
|
-
EveryOtherMonth,
|
|
2812
|
-
Every3Months,
|
|
2813
|
-
Every4Months,
|
|
2814
|
-
TwiceAYear,
|
|
2815
|
-
Yearly,
|
|
2816
|
-
EveryOtherYear
|
|
2817
|
-
}
|
|
2818
|
-
/**
|
|
2819
|
-
* @export
|
|
2820
|
-
* @enum {string}
|
|
2821
|
-
*/
|
|
2822
|
-
enum FlagColorEnum {
|
|
2823
|
-
Red,
|
|
2824
|
-
Orange,
|
|
2825
|
-
Yellow,
|
|
2826
|
-
Green,
|
|
2827
|
-
Blue,
|
|
2828
|
-
Purple
|
|
2829
|
-
}
|
|
2830
|
-
}
|
|
2831
|
-
/**
|
|
2832
|
-
*
|
|
2833
|
-
* @export
|
|
2834
|
-
* @interface TransactionDetail
|
|
2835
|
-
*/
|
|
2836
|
-
export interface TransactionDetail {
|
|
2837
|
-
/**
|
|
2838
|
-
*
|
|
2839
|
-
* @type {string}
|
|
2840
|
-
* @memberof TransactionDetail
|
|
2841
|
-
*/
|
|
2842
|
-
id: string;
|
|
2843
|
-
/**
|
|
2844
|
-
* The transaction date in ISO format (e.g. 2016-12-01)
|
|
2845
|
-
* @type {string}
|
|
2846
|
-
* @memberof TransactionDetail
|
|
2847
|
-
*/
|
|
2848
|
-
date: string;
|
|
2849
|
-
/**
|
|
2850
|
-
* The transaction amount in milliunits format
|
|
2851
|
-
* @type {number}
|
|
2852
|
-
* @memberof TransactionDetail
|
|
2853
|
-
*/
|
|
2854
|
-
amount: number;
|
|
2855
|
-
/**
|
|
2856
|
-
*
|
|
2857
|
-
* @type {string}
|
|
2858
|
-
* @memberof TransactionDetail
|
|
2859
|
-
*/
|
|
2860
|
-
memo?: string | null;
|
|
2861
|
-
/**
|
|
2862
|
-
* The cleared status of the transaction
|
|
2863
|
-
* @type {string}
|
|
2864
|
-
* @memberof TransactionDetail
|
|
2865
|
-
*/
|
|
2866
|
-
cleared: TransactionDetail.ClearedEnum;
|
|
2867
|
-
/**
|
|
2868
|
-
* Whether or not the transaction is approved
|
|
2869
|
-
* @type {boolean}
|
|
2870
|
-
* @memberof TransactionDetail
|
|
2871
|
-
*/
|
|
2872
|
-
approved: boolean;
|
|
2873
|
-
/**
|
|
2874
|
-
* The transaction flag
|
|
2875
|
-
* @type {string}
|
|
2876
|
-
* @memberof TransactionDetail
|
|
2877
|
-
*/
|
|
2878
|
-
flag_color?: TransactionDetail.FlagColorEnum | null;
|
|
2879
|
-
/**
|
|
2880
|
-
*
|
|
2881
|
-
* @type {string}
|
|
2882
|
-
* @memberof TransactionDetail
|
|
2883
|
-
*/
|
|
2884
|
-
account_id: string;
|
|
2885
|
-
/**
|
|
2886
|
-
*
|
|
2887
|
-
* @type {string}
|
|
2888
|
-
* @memberof TransactionDetail
|
|
2889
|
-
*/
|
|
2890
|
-
payee_id?: string | null;
|
|
2891
|
-
/**
|
|
2892
|
-
*
|
|
2893
|
-
* @type {string}
|
|
2894
|
-
* @memberof TransactionDetail
|
|
2895
|
-
*/
|
|
2896
|
-
category_id?: string | null;
|
|
2897
|
-
/**
|
|
2898
|
-
* If a transfer transaction, the account to which it transfers
|
|
2899
|
-
* @type {string}
|
|
2900
|
-
* @memberof TransactionDetail
|
|
2901
|
-
*/
|
|
2902
|
-
transfer_account_id?: string | null;
|
|
2903
|
-
/**
|
|
2904
|
-
* If a transfer transaction, the id of transaction on the other side of the transfer
|
|
2905
|
-
* @type {string}
|
|
2906
|
-
* @memberof TransactionDetail
|
|
2907
|
-
*/
|
|
2908
|
-
transfer_transaction_id?: string | null;
|
|
2909
|
-
/**
|
|
2910
|
-
* If transaction is matched, the id of the matched transaction
|
|
2911
|
-
* @type {string}
|
|
2912
|
-
* @memberof TransactionDetail
|
|
2913
|
-
*/
|
|
2914
|
-
matched_transaction_id?: string | null;
|
|
2915
|
-
/**
|
|
2916
|
-
* If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
|
|
2917
|
-
* @type {string}
|
|
2918
|
-
* @memberof TransactionDetail
|
|
2919
|
-
*/
|
|
2920
|
-
import_id?: string | null;
|
|
2921
|
-
/**
|
|
2922
|
-
* If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
|
|
2923
|
-
* @type {string}
|
|
2924
|
-
* @memberof TransactionDetail
|
|
2925
|
-
*/
|
|
2926
|
-
import_payee_name?: string | null;
|
|
2927
|
-
/**
|
|
2928
|
-
* If the transaction was imported, the original payee name as it appeared on the statement
|
|
2929
|
-
* @type {string}
|
|
2930
|
-
* @memberof TransactionDetail
|
|
2931
|
-
*/
|
|
2932
|
-
import_payee_name_original?: string | null;
|
|
2933
|
-
/**
|
|
2934
|
-
* If the transaction is a debt/loan account transaction, the type of transaction
|
|
2935
|
-
* @type {string}
|
|
2936
|
-
* @memberof TransactionDetail
|
|
2937
|
-
*/
|
|
2938
|
-
debt_transaction_type?: TransactionDetail.DebtTransactionTypeEnum | null;
|
|
2939
|
-
/**
|
|
2940
|
-
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
2941
|
-
* @type {boolean}
|
|
2942
|
-
* @memberof TransactionDetail
|
|
2943
|
-
*/
|
|
2944
|
-
deleted: boolean;
|
|
2945
|
-
/**
|
|
2946
|
-
*
|
|
2947
|
-
* @type {string}
|
|
2948
|
-
* @memberof TransactionDetail
|
|
2949
|
-
*/
|
|
2950
|
-
account_name: string;
|
|
2951
|
-
/**
|
|
2952
|
-
*
|
|
2953
|
-
* @type {string}
|
|
2954
|
-
* @memberof TransactionDetail
|
|
2955
|
-
*/
|
|
2956
|
-
payee_name?: string | null;
|
|
2957
|
-
/**
|
|
2958
|
-
*
|
|
2959
|
-
* @type {string}
|
|
2960
|
-
* @memberof TransactionDetail
|
|
2961
|
-
*/
|
|
2962
|
-
category_name?: string | null;
|
|
2963
|
-
/**
|
|
2964
|
-
* If a split transaction, the subtransactions.
|
|
2965
|
-
* @type {Array<SubTransaction>}
|
|
2966
|
-
* @memberof TransactionDetail
|
|
2967
|
-
*/
|
|
2968
|
-
subtransactions: Array<SubTransaction>;
|
|
2969
|
-
}
|
|
2970
|
-
/**
|
|
2971
|
-
* @export
|
|
2972
|
-
* @namespace TransactionDetail
|
|
2973
|
-
*/
|
|
2974
|
-
export declare namespace TransactionDetail {
|
|
2975
|
-
/**
|
|
2976
|
-
* @export
|
|
2977
|
-
* @enum {string}
|
|
2978
|
-
*/
|
|
2979
|
-
enum ClearedEnum {
|
|
2980
|
-
Cleared,
|
|
2981
|
-
Uncleared,
|
|
2982
|
-
Reconciled
|
|
2983
|
-
}
|
|
2984
|
-
/**
|
|
2985
|
-
* @export
|
|
2986
|
-
* @enum {string}
|
|
2987
|
-
*/
|
|
2988
|
-
enum FlagColorEnum {
|
|
2989
|
-
Red,
|
|
2990
|
-
Orange,
|
|
2991
|
-
Yellow,
|
|
2992
|
-
Green,
|
|
2993
|
-
Blue,
|
|
2994
|
-
Purple
|
|
2995
|
-
}
|
|
2996
|
-
/**
|
|
2997
|
-
* @export
|
|
2998
|
-
* @enum {string}
|
|
2999
|
-
*/
|
|
3000
|
-
enum DebtTransactionTypeEnum {
|
|
3001
|
-
Payment,
|
|
3002
|
-
Refund,
|
|
3003
|
-
Fee,
|
|
3004
|
-
Interest,
|
|
3005
|
-
Escrow,
|
|
3006
|
-
BalancedAdjustment,
|
|
3007
|
-
Credit,
|
|
3008
|
-
Charge
|
|
3009
|
-
}
|
|
3010
|
-
}
|
|
3011
|
-
/**
|
|
3012
|
-
* AccountsApi - fetch parameter creator
|
|
3013
|
-
* @export
|
|
3014
|
-
*/
|
|
3015
|
-
export declare const AccountsApiFetchParamCreator: (configuration: Configuration) => {
|
|
3016
|
-
/**
|
|
3017
|
-
* Creates a new account
|
|
3018
|
-
* @summary Create a new account
|
|
3019
|
-
* @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
3020
|
-
* @param {PostAccountWrapper} data - The account to create.
|
|
3021
|
-
* @param {*} [options] - Override http request options.
|
|
3022
|
-
* @throws {RequiredError}
|
|
3023
|
-
*/
|
|
3024
|
-
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): FetchArgs;
|
|
3025
|
-
/**
|
|
3026
|
-
* Returns a single account
|
|
3027
|
-
* @summary Single account
|
|
3028
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3029
|
-
* @param {string} account_id - The id of the account
|
|
3030
|
-
* @param {*} [options] - Override http request options.
|
|
3031
|
-
* @throws {RequiredError}
|
|
3032
|
-
*/
|
|
3033
|
-
getAccountById(budget_id: string, account_id: string, options?: any): FetchArgs;
|
|
3034
|
-
/**
|
|
3035
|
-
* Returns all accounts
|
|
3036
|
-
* @summary Account list
|
|
3037
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3038
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3039
|
-
* @param {*} [options] - Override http request options.
|
|
3040
|
-
* @throws {RequiredError}
|
|
3041
|
-
*/
|
|
3042
|
-
getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3043
|
-
};
|
|
3044
|
-
/**
|
|
3045
|
-
* AccountsApi - functional programming interface
|
|
3046
|
-
* @export
|
|
3047
|
-
*/
|
|
3048
|
-
export declare const AccountsApiFp: (configuration: Configuration) => {
|
|
3049
|
-
/**
|
|
3050
|
-
* Creates a new account
|
|
3051
|
-
* @summary Create a new account
|
|
3052
|
-
* @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
3053
|
-
* @param {PostAccountWrapper} data - The account to create.
|
|
3054
|
-
* @param {*} [options] - Override http request options.
|
|
3055
|
-
* @throws {RequiredError}
|
|
3056
|
-
*/
|
|
3057
|
-
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
|
|
3058
|
-
rateLimit: string | null;
|
|
3059
|
-
}>;
|
|
3060
|
-
/**
|
|
3061
|
-
* Returns a single account
|
|
3062
|
-
* @summary Single account
|
|
3063
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3064
|
-
* @param {string} account_id - The id of the account
|
|
3065
|
-
* @param {*} [options] - Override http request options.
|
|
3066
|
-
* @throws {RequiredError}
|
|
3067
|
-
*/
|
|
3068
|
-
getAccountById(budget_id: string, account_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
|
|
3069
|
-
rateLimit: string | null;
|
|
3070
|
-
}>;
|
|
3071
|
-
/**
|
|
3072
|
-
* Returns all accounts
|
|
3073
|
-
* @summary Account list
|
|
3074
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3075
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3076
|
-
* @param {*} [options] - Override http request options.
|
|
3077
|
-
* @throws {RequiredError}
|
|
3078
|
-
*/
|
|
3079
|
-
getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountsResponse & {
|
|
3080
|
-
rateLimit: string | null;
|
|
3081
|
-
}>;
|
|
3082
|
-
};
|
|
3083
|
-
/**
|
|
3084
|
-
* AccountsApi - factory interface
|
|
3085
|
-
* @export
|
|
3086
|
-
*/
|
|
3087
|
-
export declare const AccountsApiFactory: (configuration: Configuration) => {
|
|
3088
|
-
/**
|
|
3089
|
-
* Creates a new account
|
|
3090
|
-
* @summary Create a new account
|
|
3091
|
-
* @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
3092
|
-
* @param {PostAccountWrapper} data - The account to create.
|
|
3093
|
-
* @param {*} [options] - Override http request options.
|
|
3094
|
-
* @throws {RequiredError}
|
|
3095
|
-
*/
|
|
3096
|
-
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
|
|
3097
|
-
rateLimit: string | null;
|
|
3098
|
-
}>;
|
|
3099
|
-
/**
|
|
3100
|
-
* Returns a single account
|
|
3101
|
-
* @summary Single account
|
|
3102
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3103
|
-
* @param {string} account_id - The id of the account
|
|
3104
|
-
* @param {*} [options] - Override http request options.
|
|
3105
|
-
* @throws {RequiredError}
|
|
3106
|
-
*/
|
|
3107
|
-
getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse & {
|
|
3108
|
-
rateLimit: string | null;
|
|
3109
|
-
}>;
|
|
3110
|
-
/**
|
|
3111
|
-
* Returns all accounts
|
|
3112
|
-
* @summary Account list
|
|
3113
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3114
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3115
|
-
* @param {*} [options] - Override http request options.
|
|
3116
|
-
* @throws {RequiredError}
|
|
3117
|
-
*/
|
|
3118
|
-
getAccounts(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<AccountsResponse & {
|
|
3119
|
-
rateLimit: string | null;
|
|
3120
|
-
}>;
|
|
3121
|
-
};
|
|
3122
|
-
/**
|
|
3123
|
-
* AccountsApi - object-oriented interface
|
|
3124
|
-
* @export
|
|
3125
|
-
* @class AccountsApi
|
|
3126
|
-
* @extends {BaseAPI}
|
|
3127
|
-
*/
|
|
3128
|
-
export declare class AccountsApi extends BaseAPI {
|
|
3129
|
-
/**
|
|
3130
|
-
* Creates a new account
|
|
3131
|
-
* @summary Create a new account
|
|
3132
|
-
* @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
3133
|
-
* @param {PostAccountWrapper} data - The account to create.
|
|
3134
|
-
* @param {*} [options] - Override http request options.
|
|
3135
|
-
* @throws {RequiredError}
|
|
3136
|
-
* @memberof AccountsApi
|
|
3137
|
-
*/
|
|
3138
|
-
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
|
|
3139
|
-
rateLimit: string | null;
|
|
3140
|
-
}>;
|
|
3141
|
-
/**
|
|
3142
|
-
* Returns a single account
|
|
3143
|
-
* @summary Single account
|
|
3144
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3145
|
-
* @param {string} account_id - The id of the account
|
|
3146
|
-
* @param {*} [options] - Override http request options.
|
|
3147
|
-
* @throws {RequiredError}
|
|
3148
|
-
* @memberof AccountsApi
|
|
3149
|
-
*/
|
|
3150
|
-
getAccountById(budget_id: string, account_id: string, options?: any): Promise<AccountResponse & {
|
|
3151
|
-
rateLimit: string | null;
|
|
3152
|
-
}>;
|
|
3153
|
-
/**
|
|
3154
|
-
* Returns all accounts
|
|
3155
|
-
* @summary Account list
|
|
3156
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3157
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3158
|
-
* @param {*} [options] - Override http request options.
|
|
3159
|
-
* @throws {RequiredError}
|
|
3160
|
-
* @memberof AccountsApi
|
|
3161
|
-
*/
|
|
3162
|
-
getAccounts(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<AccountsResponse & {
|
|
3163
|
-
rateLimit: string | null;
|
|
3164
|
-
}>;
|
|
3165
|
-
}
|
|
3166
|
-
/**
|
|
3167
|
-
* BudgetsApi - fetch parameter creator
|
|
3168
|
-
* @export
|
|
3169
|
-
*/
|
|
3170
|
-
export declare const BudgetsApiFetchParamCreator: (configuration: Configuration) => {
|
|
3171
|
-
/**
|
|
3172
|
-
* Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
3173
|
-
* @summary Single budget
|
|
3174
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3175
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3176
|
-
* @param {*} [options] - Override http request options.
|
|
3177
|
-
* @throws {RequiredError}
|
|
3178
|
-
*/
|
|
3179
|
-
getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3180
|
-
/**
|
|
3181
|
-
* Returns settings for a budget
|
|
3182
|
-
* @summary Budget Settings
|
|
3183
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3184
|
-
* @param {*} [options] - Override http request options.
|
|
3185
|
-
* @throws {RequiredError}
|
|
3186
|
-
*/
|
|
3187
|
-
getBudgetSettingsById(budget_id: string, options?: any): FetchArgs;
|
|
3188
|
-
/**
|
|
3189
|
-
* Returns budgets list with summary information
|
|
3190
|
-
* @summary List budgets
|
|
3191
|
-
* @param {boolean} [include_accounts] - Whether to include the list of budget accounts
|
|
3192
|
-
* @param {*} [options] - Override http request options.
|
|
3193
|
-
* @throws {RequiredError}
|
|
3194
|
-
*/
|
|
3195
|
-
getBudgets(include_accounts?: boolean | undefined, options?: any): FetchArgs;
|
|
3196
|
-
};
|
|
3197
|
-
/**
|
|
3198
|
-
* BudgetsApi - functional programming interface
|
|
3199
|
-
* @export
|
|
3200
|
-
*/
|
|
3201
|
-
export declare const BudgetsApiFp: (configuration: Configuration) => {
|
|
3202
|
-
/**
|
|
3203
|
-
* Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
3204
|
-
* @summary Single budget
|
|
3205
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3206
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3207
|
-
* @param {*} [options] - Override http request options.
|
|
3208
|
-
* @throws {RequiredError}
|
|
3209
|
-
*/
|
|
3210
|
-
getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetDetailResponse & {
|
|
3211
|
-
rateLimit: string | null;
|
|
3212
|
-
}>;
|
|
3213
|
-
/**
|
|
3214
|
-
* Returns settings for a budget
|
|
3215
|
-
* @summary Budget Settings
|
|
3216
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3217
|
-
* @param {*} [options] - Override http request options.
|
|
3218
|
-
* @throws {RequiredError}
|
|
3219
|
-
*/
|
|
3220
|
-
getBudgetSettingsById(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSettingsResponse & {
|
|
3221
|
-
rateLimit: string | null;
|
|
3222
|
-
}>;
|
|
3223
|
-
/**
|
|
3224
|
-
* Returns budgets list with summary information
|
|
3225
|
-
* @summary List budgets
|
|
3226
|
-
* @param {boolean} [include_accounts] - Whether to include the list of budget accounts
|
|
3227
|
-
* @param {*} [options] - Override http request options.
|
|
3228
|
-
* @throws {RequiredError}
|
|
3229
|
-
*/
|
|
3230
|
-
getBudgets(include_accounts?: boolean | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BudgetSummaryResponse & {
|
|
3231
|
-
rateLimit: string | null;
|
|
3232
|
-
}>;
|
|
3233
|
-
};
|
|
3234
|
-
/**
|
|
3235
|
-
* BudgetsApi - factory interface
|
|
3236
|
-
* @export
|
|
3237
|
-
*/
|
|
3238
|
-
export declare const BudgetsApiFactory: (configuration: Configuration) => {
|
|
3239
|
-
/**
|
|
3240
|
-
* Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
3241
|
-
* @summary Single budget
|
|
3242
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3243
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3244
|
-
* @param {*} [options] - Override http request options.
|
|
3245
|
-
* @throws {RequiredError}
|
|
3246
|
-
*/
|
|
3247
|
-
getBudgetById(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<BudgetDetailResponse & {
|
|
3248
|
-
rateLimit: string | null;
|
|
3249
|
-
}>;
|
|
3250
|
-
/**
|
|
3251
|
-
* Returns settings for a budget
|
|
3252
|
-
* @summary Budget Settings
|
|
3253
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3254
|
-
* @param {*} [options] - Override http request options.
|
|
3255
|
-
* @throws {RequiredError}
|
|
3256
|
-
*/
|
|
3257
|
-
getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse & {
|
|
3258
|
-
rateLimit: string | null;
|
|
3259
|
-
}>;
|
|
3260
|
-
/**
|
|
3261
|
-
* Returns budgets list with summary information
|
|
3262
|
-
* @summary List budgets
|
|
3263
|
-
* @param {boolean} [include_accounts] - Whether to include the list of budget accounts
|
|
3264
|
-
* @param {*} [options] - Override http request options.
|
|
3265
|
-
* @throws {RequiredError}
|
|
3266
|
-
*/
|
|
3267
|
-
getBudgets(include_accounts?: boolean | undefined, options?: any): Promise<BudgetSummaryResponse & {
|
|
3268
|
-
rateLimit: string | null;
|
|
3269
|
-
}>;
|
|
3270
|
-
};
|
|
3271
|
-
/**
|
|
3272
|
-
* BudgetsApi - object-oriented interface
|
|
3273
|
-
* @export
|
|
3274
|
-
* @class BudgetsApi
|
|
3275
|
-
* @extends {BaseAPI}
|
|
3276
|
-
*/
|
|
3277
|
-
export declare class BudgetsApi extends BaseAPI {
|
|
3278
|
-
/**
|
|
3279
|
-
* Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
3280
|
-
* @summary Single budget
|
|
3281
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3282
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3283
|
-
* @param {*} [options] - Override http request options.
|
|
3284
|
-
* @throws {RequiredError}
|
|
3285
|
-
* @memberof BudgetsApi
|
|
3286
|
-
*/
|
|
3287
|
-
getBudgetById(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<BudgetDetailResponse & {
|
|
3288
|
-
rateLimit: string | null;
|
|
3289
|
-
}>;
|
|
3290
|
-
/**
|
|
3291
|
-
* Returns settings for a budget
|
|
3292
|
-
* @summary Budget Settings
|
|
3293
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3294
|
-
* @param {*} [options] - Override http request options.
|
|
3295
|
-
* @throws {RequiredError}
|
|
3296
|
-
* @memberof BudgetsApi
|
|
3297
|
-
*/
|
|
3298
|
-
getBudgetSettingsById(budget_id: string, options?: any): Promise<BudgetSettingsResponse & {
|
|
3299
|
-
rateLimit: string | null;
|
|
3300
|
-
}>;
|
|
3301
|
-
/**
|
|
3302
|
-
* Returns budgets list with summary information
|
|
3303
|
-
* @summary List budgets
|
|
3304
|
-
* @param {boolean} [include_accounts] - Whether to include the list of budget accounts
|
|
3305
|
-
* @param {*} [options] - Override http request options.
|
|
3306
|
-
* @throws {RequiredError}
|
|
3307
|
-
* @memberof BudgetsApi
|
|
3308
|
-
*/
|
|
3309
|
-
getBudgets(include_accounts?: boolean, options?: any): Promise<BudgetSummaryResponse & {
|
|
3310
|
-
rateLimit: string | null;
|
|
3311
|
-
}>;
|
|
3312
|
-
}
|
|
3313
|
-
/**
|
|
3314
|
-
* CategoriesApi - fetch parameter creator
|
|
3315
|
-
* @export
|
|
3316
|
-
*/
|
|
3317
|
-
export declare const CategoriesApiFetchParamCreator: (configuration: Configuration) => {
|
|
3318
|
-
/**
|
|
3319
|
-
* Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3320
|
-
* @summary List categories
|
|
3321
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3322
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3323
|
-
* @param {*} [options] - Override http request options.
|
|
3324
|
-
* @throws {RequiredError}
|
|
3325
|
-
*/
|
|
3326
|
-
getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3327
|
-
/**
|
|
3328
|
-
* Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3329
|
-
* @summary Single category
|
|
3330
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3331
|
-
* @param {string} category_id - The id of the category
|
|
3332
|
-
* @param {*} [options] - Override http request options.
|
|
3333
|
-
* @throws {RequiredError}
|
|
3334
|
-
*/
|
|
3335
|
-
getCategoryById(budget_id: string, category_id: string, options?: any): FetchArgs;
|
|
3336
|
-
/**
|
|
3337
|
-
* Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3338
|
-
* @summary Single category for a specific budget month
|
|
3339
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3340
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3341
|
-
* @param {string} category_id - The id of the category
|
|
3342
|
-
* @param {*} [options] - Override http request options.
|
|
3343
|
-
* @throws {RequiredError}
|
|
3344
|
-
*/
|
|
3345
|
-
getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): FetchArgs;
|
|
3346
|
-
/**
|
|
3347
|
-
* Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
3348
|
-
* @summary Update a category for a specific month
|
|
3349
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3350
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3351
|
-
* @param {string} category_id - The id of the category
|
|
3352
|
-
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3353
|
-
* @param {*} [options] - Override http request options.
|
|
3354
|
-
* @throws {RequiredError}
|
|
3355
|
-
*/
|
|
3356
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): FetchArgs;
|
|
3357
|
-
};
|
|
3358
|
-
/**
|
|
3359
|
-
* CategoriesApi - functional programming interface
|
|
3360
|
-
* @export
|
|
3361
|
-
*/
|
|
3362
|
-
export declare const CategoriesApiFp: (configuration: Configuration) => {
|
|
3363
|
-
/**
|
|
3364
|
-
* Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3365
|
-
* @summary List categories
|
|
3366
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3367
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3368
|
-
* @param {*} [options] - Override http request options.
|
|
3369
|
-
* @throws {RequiredError}
|
|
3370
|
-
*/
|
|
3371
|
-
getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoriesResponse & {
|
|
3372
|
-
rateLimit: string | null;
|
|
3373
|
-
}>;
|
|
3374
|
-
/**
|
|
3375
|
-
* Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3376
|
-
* @summary Single category
|
|
3377
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3378
|
-
* @param {string} category_id - The id of the category
|
|
3379
|
-
* @param {*} [options] - Override http request options.
|
|
3380
|
-
* @throws {RequiredError}
|
|
3381
|
-
*/
|
|
3382
|
-
getCategoryById(budget_id: string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse & {
|
|
3383
|
-
rateLimit: string | null;
|
|
3384
|
-
}>;
|
|
3385
|
-
/**
|
|
3386
|
-
* Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3387
|
-
* @summary Single category for a specific budget month
|
|
3388
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3389
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3390
|
-
* @param {string} category_id - The id of the category
|
|
3391
|
-
* @param {*} [options] - Override http request options.
|
|
3392
|
-
* @throws {RequiredError}
|
|
3393
|
-
*/
|
|
3394
|
-
getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<CategoryResponse & {
|
|
3395
|
-
rateLimit: string | null;
|
|
3396
|
-
}>;
|
|
3397
|
-
/**
|
|
3398
|
-
* Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
3399
|
-
* @summary Update a category for a specific month
|
|
3400
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3401
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3402
|
-
* @param {string} category_id - The id of the category
|
|
3403
|
-
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3404
|
-
* @param {*} [options] - Override http request options.
|
|
3405
|
-
* @throws {RequiredError}
|
|
3406
|
-
*/
|
|
3407
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse & {
|
|
3408
|
-
rateLimit: string | null;
|
|
3409
|
-
}>;
|
|
3410
|
-
};
|
|
3411
|
-
/**
|
|
3412
|
-
* CategoriesApi - factory interface
|
|
3413
|
-
* @export
|
|
3414
|
-
*/
|
|
3415
|
-
export declare const CategoriesApiFactory: (configuration: Configuration) => {
|
|
3416
|
-
/**
|
|
3417
|
-
* Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3418
|
-
* @summary List categories
|
|
3419
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3420
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3421
|
-
* @param {*} [options] - Override http request options.
|
|
3422
|
-
* @throws {RequiredError}
|
|
3423
|
-
*/
|
|
3424
|
-
getCategories(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<CategoriesResponse & {
|
|
3425
|
-
rateLimit: string | null;
|
|
3426
|
-
}>;
|
|
3427
|
-
/**
|
|
3428
|
-
* Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3429
|
-
* @summary Single category
|
|
3430
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3431
|
-
* @param {string} category_id - The id of the category
|
|
3432
|
-
* @param {*} [options] - Override http request options.
|
|
3433
|
-
* @throws {RequiredError}
|
|
3434
|
-
*/
|
|
3435
|
-
getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse & {
|
|
3436
|
-
rateLimit: string | null;
|
|
3437
|
-
}>;
|
|
3438
|
-
/**
|
|
3439
|
-
* Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3440
|
-
* @summary Single category for a specific budget month
|
|
3441
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3442
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3443
|
-
* @param {string} category_id - The id of the category
|
|
3444
|
-
* @param {*} [options] - Override http request options.
|
|
3445
|
-
* @throws {RequiredError}
|
|
3446
|
-
*/
|
|
3447
|
-
getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse & {
|
|
3448
|
-
rateLimit: string | null;
|
|
3449
|
-
}>;
|
|
3450
|
-
/**
|
|
3451
|
-
* Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
3452
|
-
* @summary Update a category for a specific month
|
|
3453
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3454
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3455
|
-
* @param {string} category_id - The id of the category
|
|
3456
|
-
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3457
|
-
* @param {*} [options] - Override http request options.
|
|
3458
|
-
* @throws {RequiredError}
|
|
3459
|
-
*/
|
|
3460
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
|
|
3461
|
-
rateLimit: string | null;
|
|
3462
|
-
}>;
|
|
3463
|
-
};
|
|
3464
|
-
/**
|
|
3465
|
-
* CategoriesApi - object-oriented interface
|
|
3466
|
-
* @export
|
|
3467
|
-
* @class CategoriesApi
|
|
3468
|
-
* @extends {BaseAPI}
|
|
3469
|
-
*/
|
|
3470
|
-
export declare class CategoriesApi extends BaseAPI {
|
|
3471
|
-
/**
|
|
3472
|
-
* Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3473
|
-
* @summary List categories
|
|
3474
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3475
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3476
|
-
* @param {*} [options] - Override http request options.
|
|
3477
|
-
* @throws {RequiredError}
|
|
3478
|
-
* @memberof CategoriesApi
|
|
3479
|
-
*/
|
|
3480
|
-
getCategories(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<CategoriesResponse & {
|
|
3481
|
-
rateLimit: string | null;
|
|
3482
|
-
}>;
|
|
3483
|
-
/**
|
|
3484
|
-
* Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3485
|
-
* @summary Single category
|
|
3486
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3487
|
-
* @param {string} category_id - The id of the category
|
|
3488
|
-
* @param {*} [options] - Override http request options.
|
|
3489
|
-
* @throws {RequiredError}
|
|
3490
|
-
* @memberof CategoriesApi
|
|
3491
|
-
*/
|
|
3492
|
-
getCategoryById(budget_id: string, category_id: string, options?: any): Promise<CategoryResponse & {
|
|
3493
|
-
rateLimit: string | null;
|
|
3494
|
-
}>;
|
|
3495
|
-
/**
|
|
3496
|
-
* Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
3497
|
-
* @summary Single category for a specific budget month
|
|
3498
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3499
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3500
|
-
* @param {string} category_id - The id of the category
|
|
3501
|
-
* @param {*} [options] - Override http request options.
|
|
3502
|
-
* @throws {RequiredError}
|
|
3503
|
-
* @memberof CategoriesApi
|
|
3504
|
-
*/
|
|
3505
|
-
getMonthCategoryById(budget_id: string, month: Date | string, category_id: string, options?: any): Promise<CategoryResponse & {
|
|
3506
|
-
rateLimit: string | null;
|
|
3507
|
-
}>;
|
|
3508
|
-
/**
|
|
3509
|
-
* Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
3510
|
-
* @summary Update a category for a specific month
|
|
3511
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3512
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3513
|
-
* @param {string} category_id - The id of the category
|
|
3514
|
-
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3515
|
-
* @param {*} [options] - Override http request options.
|
|
3516
|
-
* @throws {RequiredError}
|
|
3517
|
-
* @memberof CategoriesApi
|
|
3518
|
-
*/
|
|
3519
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
|
|
3520
|
-
rateLimit: string | null;
|
|
3521
|
-
}>;
|
|
3522
|
-
}
|
|
3523
|
-
/**
|
|
3524
|
-
* DeprecatedApi - fetch parameter creator
|
|
3525
|
-
* @export
|
|
3526
|
-
*/
|
|
3527
|
-
export declare const DeprecatedApiFetchParamCreator: (configuration: Configuration) => {
|
|
3528
|
-
/**
|
|
3529
|
-
* Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
3530
|
-
* @summary Bulk create transactions
|
|
3531
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3532
|
-
* @param {BulkTransactions} transactions - The list of transactions to create
|
|
3533
|
-
* @param {*} [options] - Override http request options.
|
|
3534
|
-
* @throws {RequiredError}
|
|
3535
|
-
*/
|
|
3536
|
-
bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): FetchArgs;
|
|
3537
|
-
};
|
|
3538
|
-
/**
|
|
3539
|
-
* DeprecatedApi - functional programming interface
|
|
3540
|
-
* @export
|
|
3541
|
-
*/
|
|
3542
|
-
export declare const DeprecatedApiFp: (configuration: Configuration) => {
|
|
3543
|
-
/**
|
|
3544
|
-
* Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
3545
|
-
* @summary Bulk create transactions
|
|
3546
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3547
|
-
* @param {BulkTransactions} transactions - The list of transactions to create
|
|
3548
|
-
* @param {*} [options] - Override http request options.
|
|
3549
|
-
* @throws {RequiredError}
|
|
3550
|
-
*/
|
|
3551
|
-
bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<BulkResponse & {
|
|
3552
|
-
rateLimit: string | null;
|
|
3553
|
-
}>;
|
|
3554
|
-
};
|
|
3555
|
-
/**
|
|
3556
|
-
* DeprecatedApi - factory interface
|
|
3557
|
-
* @export
|
|
3558
|
-
*/
|
|
3559
|
-
export declare const DeprecatedApiFactory: (configuration: Configuration) => {
|
|
3560
|
-
/**
|
|
3561
|
-
* Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
3562
|
-
* @summary Bulk create transactions
|
|
3563
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3564
|
-
* @param {BulkTransactions} transactions - The list of transactions to create
|
|
3565
|
-
* @param {*} [options] - Override http request options.
|
|
3566
|
-
* @throws {RequiredError}
|
|
3567
|
-
*/
|
|
3568
|
-
bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse & {
|
|
3569
|
-
rateLimit: string | null;
|
|
3570
|
-
}>;
|
|
3571
|
-
};
|
|
3572
|
-
/**
|
|
3573
|
-
* DeprecatedApi - object-oriented interface
|
|
3574
|
-
* @export
|
|
3575
|
-
* @class DeprecatedApi
|
|
3576
|
-
* @extends {BaseAPI}
|
|
3577
|
-
*/
|
|
3578
|
-
export declare class DeprecatedApi extends BaseAPI {
|
|
3579
|
-
/**
|
|
3580
|
-
* Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
3581
|
-
* @summary Bulk create transactions
|
|
3582
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3583
|
-
* @param {BulkTransactions} transactions - The list of transactions to create
|
|
3584
|
-
* @param {*} [options] - Override http request options.
|
|
3585
|
-
* @throws {RequiredError}
|
|
3586
|
-
* @memberof DeprecatedApi
|
|
3587
|
-
*/
|
|
3588
|
-
bulkCreateTransactions(budget_id: string, transactions: BulkTransactions, options?: any): Promise<BulkResponse & {
|
|
3589
|
-
rateLimit: string | null;
|
|
3590
|
-
}>;
|
|
3591
|
-
}
|
|
3592
|
-
/**
|
|
3593
|
-
* MonthsApi - fetch parameter creator
|
|
3594
|
-
* @export
|
|
3595
|
-
*/
|
|
3596
|
-
export declare const MonthsApiFetchParamCreator: (configuration: Configuration) => {
|
|
3597
|
-
/**
|
|
3598
|
-
* Returns a single budget month
|
|
3599
|
-
* @summary Single budget month
|
|
3600
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3601
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3602
|
-
* @param {*} [options] - Override http request options.
|
|
3603
|
-
* @throws {RequiredError}
|
|
3604
|
-
*/
|
|
3605
|
-
getBudgetMonth(budget_id: string, month: Date | string, options?: any): FetchArgs;
|
|
3606
|
-
/**
|
|
3607
|
-
* Returns all budget months
|
|
3608
|
-
* @summary List budget months
|
|
3609
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3610
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3611
|
-
* @param {*} [options] - Override http request options.
|
|
3612
|
-
* @throws {RequiredError}
|
|
3613
|
-
*/
|
|
3614
|
-
getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3615
|
-
};
|
|
3616
|
-
/**
|
|
3617
|
-
* MonthsApi - functional programming interface
|
|
3618
|
-
* @export
|
|
3619
|
-
*/
|
|
3620
|
-
export declare const MonthsApiFp: (configuration: Configuration) => {
|
|
3621
|
-
/**
|
|
3622
|
-
* Returns a single budget month
|
|
3623
|
-
* @summary Single budget month
|
|
3624
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3625
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3626
|
-
* @param {*} [options] - Override http request options.
|
|
3627
|
-
* @throws {RequiredError}
|
|
3628
|
-
*/
|
|
3629
|
-
getBudgetMonth(budget_id: string, month: Date | string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthDetailResponse & {
|
|
3630
|
-
rateLimit: string | null;
|
|
3631
|
-
}>;
|
|
3632
|
-
/**
|
|
3633
|
-
* Returns all budget months
|
|
3634
|
-
* @summary List budget months
|
|
3635
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3636
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3637
|
-
* @param {*} [options] - Override http request options.
|
|
3638
|
-
* @throws {RequiredError}
|
|
3639
|
-
*/
|
|
3640
|
-
getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<MonthSummariesResponse & {
|
|
3641
|
-
rateLimit: string | null;
|
|
3642
|
-
}>;
|
|
3643
|
-
};
|
|
3644
|
-
/**
|
|
3645
|
-
* MonthsApi - factory interface
|
|
3646
|
-
* @export
|
|
3647
|
-
*/
|
|
3648
|
-
export declare const MonthsApiFactory: (configuration: Configuration) => {
|
|
3649
|
-
/**
|
|
3650
|
-
* Returns a single budget month
|
|
3651
|
-
* @summary Single budget month
|
|
3652
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3653
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3654
|
-
* @param {*} [options] - Override http request options.
|
|
3655
|
-
* @throws {RequiredError}
|
|
3656
|
-
*/
|
|
3657
|
-
getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse & {
|
|
3658
|
-
rateLimit: string | null;
|
|
3659
|
-
}>;
|
|
3660
|
-
/**
|
|
3661
|
-
* Returns all budget months
|
|
3662
|
-
* @summary List budget months
|
|
3663
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3664
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3665
|
-
* @param {*} [options] - Override http request options.
|
|
3666
|
-
* @throws {RequiredError}
|
|
3667
|
-
*/
|
|
3668
|
-
getBudgetMonths(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<MonthSummariesResponse & {
|
|
3669
|
-
rateLimit: string | null;
|
|
3670
|
-
}>;
|
|
3671
|
-
};
|
|
3672
|
-
/**
|
|
3673
|
-
* MonthsApi - object-oriented interface
|
|
3674
|
-
* @export
|
|
3675
|
-
* @class MonthsApi
|
|
3676
|
-
* @extends {BaseAPI}
|
|
3677
|
-
*/
|
|
3678
|
-
export declare class MonthsApi extends BaseAPI {
|
|
3679
|
-
/**
|
|
3680
|
-
* Returns a single budget month
|
|
3681
|
-
* @summary Single budget month
|
|
3682
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3683
|
-
* @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
3684
|
-
* @param {*} [options] - Override http request options.
|
|
3685
|
-
* @throws {RequiredError}
|
|
3686
|
-
* @memberof MonthsApi
|
|
3687
|
-
*/
|
|
3688
|
-
getBudgetMonth(budget_id: string, month: Date | string, options?: any): Promise<MonthDetailResponse & {
|
|
3689
|
-
rateLimit: string | null;
|
|
3690
|
-
}>;
|
|
3691
|
-
/**
|
|
3692
|
-
* Returns all budget months
|
|
3693
|
-
* @summary List budget months
|
|
3694
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3695
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3696
|
-
* @param {*} [options] - Override http request options.
|
|
3697
|
-
* @throws {RequiredError}
|
|
3698
|
-
* @memberof MonthsApi
|
|
3699
|
-
*/
|
|
3700
|
-
getBudgetMonths(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<MonthSummariesResponse & {
|
|
3701
|
-
rateLimit: string | null;
|
|
3702
|
-
}>;
|
|
3703
|
-
}
|
|
3704
|
-
/**
|
|
3705
|
-
* PayeeLocationsApi - fetch parameter creator
|
|
3706
|
-
* @export
|
|
3707
|
-
*/
|
|
3708
|
-
export declare const PayeeLocationsApiFetchParamCreator: (configuration: Configuration) => {
|
|
3709
|
-
/**
|
|
3710
|
-
* Returns a single payee location
|
|
3711
|
-
* @summary Single payee location
|
|
3712
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3713
|
-
* @param {string} payee_location_id - id of payee location
|
|
3714
|
-
* @param {*} [options] - Override http request options.
|
|
3715
|
-
* @throws {RequiredError}
|
|
3716
|
-
*/
|
|
3717
|
-
getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): FetchArgs;
|
|
3718
|
-
/**
|
|
3719
|
-
* Returns all payee locations
|
|
3720
|
-
* @summary List payee locations
|
|
3721
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3722
|
-
* @param {*} [options] - Override http request options.
|
|
3723
|
-
* @throws {RequiredError}
|
|
3724
|
-
*/
|
|
3725
|
-
getPayeeLocations(budget_id: string, options?: any): FetchArgs;
|
|
3726
|
-
/**
|
|
3727
|
-
* Returns all payee locations for a specified payee
|
|
3728
|
-
* @summary List locations for a payee
|
|
3729
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3730
|
-
* @param {string} payee_id - id of payee
|
|
3731
|
-
* @param {*} [options] - Override http request options.
|
|
3732
|
-
* @throws {RequiredError}
|
|
3733
|
-
*/
|
|
3734
|
-
getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): FetchArgs;
|
|
3735
|
-
};
|
|
3736
|
-
/**
|
|
3737
|
-
* PayeeLocationsApi - functional programming interface
|
|
3738
|
-
* @export
|
|
3739
|
-
*/
|
|
3740
|
-
export declare const PayeeLocationsApiFp: (configuration: Configuration) => {
|
|
3741
|
-
/**
|
|
3742
|
-
* Returns a single payee location
|
|
3743
|
-
* @summary Single payee location
|
|
3744
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3745
|
-
* @param {string} payee_location_id - id of payee location
|
|
3746
|
-
* @param {*} [options] - Override http request options.
|
|
3747
|
-
* @throws {RequiredError}
|
|
3748
|
-
*/
|
|
3749
|
-
getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationResponse & {
|
|
3750
|
-
rateLimit: string | null;
|
|
3751
|
-
}>;
|
|
3752
|
-
/**
|
|
3753
|
-
* Returns all payee locations
|
|
3754
|
-
* @summary List payee locations
|
|
3755
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3756
|
-
* @param {*} [options] - Override http request options.
|
|
3757
|
-
* @throws {RequiredError}
|
|
3758
|
-
*/
|
|
3759
|
-
getPayeeLocations(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse & {
|
|
3760
|
-
rateLimit: string | null;
|
|
3761
|
-
}>;
|
|
3762
|
-
/**
|
|
3763
|
-
* Returns all payee locations for a specified payee
|
|
3764
|
-
* @summary List locations for a payee
|
|
3765
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3766
|
-
* @param {string} payee_id - id of payee
|
|
3767
|
-
* @param {*} [options] - Override http request options.
|
|
3768
|
-
* @throws {RequiredError}
|
|
3769
|
-
*/
|
|
3770
|
-
getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeLocationsResponse & {
|
|
3771
|
-
rateLimit: string | null;
|
|
3772
|
-
}>;
|
|
3773
|
-
};
|
|
3774
|
-
/**
|
|
3775
|
-
* PayeeLocationsApi - factory interface
|
|
3776
|
-
* @export
|
|
3777
|
-
*/
|
|
3778
|
-
export declare const PayeeLocationsApiFactory: (configuration: Configuration) => {
|
|
3779
|
-
/**
|
|
3780
|
-
* Returns a single payee location
|
|
3781
|
-
* @summary Single payee location
|
|
3782
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3783
|
-
* @param {string} payee_location_id - id of payee location
|
|
3784
|
-
* @param {*} [options] - Override http request options.
|
|
3785
|
-
* @throws {RequiredError}
|
|
3786
|
-
*/
|
|
3787
|
-
getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse & {
|
|
3788
|
-
rateLimit: string | null;
|
|
3789
|
-
}>;
|
|
3790
|
-
/**
|
|
3791
|
-
* Returns all payee locations
|
|
3792
|
-
* @summary List payee locations
|
|
3793
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3794
|
-
* @param {*} [options] - Override http request options.
|
|
3795
|
-
* @throws {RequiredError}
|
|
3796
|
-
*/
|
|
3797
|
-
getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse & {
|
|
3798
|
-
rateLimit: string | null;
|
|
3799
|
-
}>;
|
|
3800
|
-
/**
|
|
3801
|
-
* Returns all payee locations for a specified payee
|
|
3802
|
-
* @summary List locations for a payee
|
|
3803
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3804
|
-
* @param {string} payee_id - id of payee
|
|
3805
|
-
* @param {*} [options] - Override http request options.
|
|
3806
|
-
* @throws {RequiredError}
|
|
3807
|
-
*/
|
|
3808
|
-
getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse & {
|
|
3809
|
-
rateLimit: string | null;
|
|
3810
|
-
}>;
|
|
3811
|
-
};
|
|
3812
|
-
/**
|
|
3813
|
-
* PayeeLocationsApi - object-oriented interface
|
|
3814
|
-
* @export
|
|
3815
|
-
* @class PayeeLocationsApi
|
|
3816
|
-
* @extends {BaseAPI}
|
|
3817
|
-
*/
|
|
3818
|
-
export declare class PayeeLocationsApi extends BaseAPI {
|
|
3819
|
-
/**
|
|
3820
|
-
* Returns a single payee location
|
|
3821
|
-
* @summary Single payee location
|
|
3822
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3823
|
-
* @param {string} payee_location_id - id of payee location
|
|
3824
|
-
* @param {*} [options] - Override http request options.
|
|
3825
|
-
* @throws {RequiredError}
|
|
3826
|
-
* @memberof PayeeLocationsApi
|
|
3827
|
-
*/
|
|
3828
|
-
getPayeeLocationById(budget_id: string, payee_location_id: string, options?: any): Promise<PayeeLocationResponse & {
|
|
3829
|
-
rateLimit: string | null;
|
|
3830
|
-
}>;
|
|
3831
|
-
/**
|
|
3832
|
-
* Returns all payee locations
|
|
3833
|
-
* @summary List payee locations
|
|
3834
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3835
|
-
* @param {*} [options] - Override http request options.
|
|
3836
|
-
* @throws {RequiredError}
|
|
3837
|
-
* @memberof PayeeLocationsApi
|
|
3838
|
-
*/
|
|
3839
|
-
getPayeeLocations(budget_id: string, options?: any): Promise<PayeeLocationsResponse & {
|
|
3840
|
-
rateLimit: string | null;
|
|
3841
|
-
}>;
|
|
3842
|
-
/**
|
|
3843
|
-
* Returns all payee locations for a specified payee
|
|
3844
|
-
* @summary List locations for a payee
|
|
3845
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3846
|
-
* @param {string} payee_id - id of payee
|
|
3847
|
-
* @param {*} [options] - Override http request options.
|
|
3848
|
-
* @throws {RequiredError}
|
|
3849
|
-
* @memberof PayeeLocationsApi
|
|
3850
|
-
*/
|
|
3851
|
-
getPayeeLocationsByPayee(budget_id: string, payee_id: string, options?: any): Promise<PayeeLocationsResponse & {
|
|
3852
|
-
rateLimit: string | null;
|
|
3853
|
-
}>;
|
|
3854
|
-
}
|
|
3855
|
-
/**
|
|
3856
|
-
* PayeesApi - fetch parameter creator
|
|
3857
|
-
* @export
|
|
3858
|
-
*/
|
|
3859
|
-
export declare const PayeesApiFetchParamCreator: (configuration: Configuration) => {
|
|
3860
|
-
/**
|
|
3861
|
-
* Returns a single payee
|
|
3862
|
-
* @summary Single payee
|
|
3863
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3864
|
-
* @param {string} payee_id - The id of the payee
|
|
3865
|
-
* @param {*} [options] - Override http request options.
|
|
3866
|
-
* @throws {RequiredError}
|
|
3867
|
-
*/
|
|
3868
|
-
getPayeeById(budget_id: string, payee_id: string, options?: any): FetchArgs;
|
|
3869
|
-
/**
|
|
3870
|
-
* Returns all payees
|
|
3871
|
-
* @summary List payees
|
|
3872
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3873
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3874
|
-
* @param {*} [options] - Override http request options.
|
|
3875
|
-
* @throws {RequiredError}
|
|
3876
|
-
*/
|
|
3877
|
-
getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3878
|
-
};
|
|
3879
|
-
/**
|
|
3880
|
-
* PayeesApi - functional programming interface
|
|
3881
|
-
* @export
|
|
3882
|
-
*/
|
|
3883
|
-
export declare const PayeesApiFp: (configuration: Configuration) => {
|
|
3884
|
-
/**
|
|
3885
|
-
* Returns a single payee
|
|
3886
|
-
* @summary Single payee
|
|
3887
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3888
|
-
* @param {string} payee_id - The id of the payee
|
|
3889
|
-
* @param {*} [options] - Override http request options.
|
|
3890
|
-
* @throws {RequiredError}
|
|
3891
|
-
*/
|
|
3892
|
-
getPayeeById(budget_id: string, payee_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeeResponse & {
|
|
3893
|
-
rateLimit: string | null;
|
|
3894
|
-
}>;
|
|
3895
|
-
/**
|
|
3896
|
-
* Returns all payees
|
|
3897
|
-
* @summary List payees
|
|
3898
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3899
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3900
|
-
* @param {*} [options] - Override http request options.
|
|
3901
|
-
* @throws {RequiredError}
|
|
3902
|
-
*/
|
|
3903
|
-
getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<PayeesResponse & {
|
|
3904
|
-
rateLimit: string | null;
|
|
3905
|
-
}>;
|
|
3906
|
-
};
|
|
3907
|
-
/**
|
|
3908
|
-
* PayeesApi - factory interface
|
|
3909
|
-
* @export
|
|
3910
|
-
*/
|
|
3911
|
-
export declare const PayeesApiFactory: (configuration: Configuration) => {
|
|
3912
|
-
/**
|
|
3913
|
-
* Returns a single payee
|
|
3914
|
-
* @summary Single payee
|
|
3915
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3916
|
-
* @param {string} payee_id - The id of the payee
|
|
3917
|
-
* @param {*} [options] - Override http request options.
|
|
3918
|
-
* @throws {RequiredError}
|
|
3919
|
-
*/
|
|
3920
|
-
getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse & {
|
|
3921
|
-
rateLimit: string | null;
|
|
3922
|
-
}>;
|
|
3923
|
-
/**
|
|
3924
|
-
* Returns all payees
|
|
3925
|
-
* @summary List payees
|
|
3926
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3927
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3928
|
-
* @param {*} [options] - Override http request options.
|
|
3929
|
-
* @throws {RequiredError}
|
|
3930
|
-
*/
|
|
3931
|
-
getPayees(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<PayeesResponse & {
|
|
3932
|
-
rateLimit: string | null;
|
|
3933
|
-
}>;
|
|
3934
|
-
};
|
|
3935
|
-
/**
|
|
3936
|
-
* PayeesApi - object-oriented interface
|
|
3937
|
-
* @export
|
|
3938
|
-
* @class PayeesApi
|
|
3939
|
-
* @extends {BaseAPI}
|
|
3940
|
-
*/
|
|
3941
|
-
export declare class PayeesApi extends BaseAPI {
|
|
3942
|
-
/**
|
|
3943
|
-
* Returns a single payee
|
|
3944
|
-
* @summary Single payee
|
|
3945
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3946
|
-
* @param {string} payee_id - The id of the payee
|
|
3947
|
-
* @param {*} [options] - Override http request options.
|
|
3948
|
-
* @throws {RequiredError}
|
|
3949
|
-
* @memberof PayeesApi
|
|
3950
|
-
*/
|
|
3951
|
-
getPayeeById(budget_id: string, payee_id: string, options?: any): Promise<PayeeResponse & {
|
|
3952
|
-
rateLimit: string | null;
|
|
3953
|
-
}>;
|
|
3954
|
-
/**
|
|
3955
|
-
* Returns all payees
|
|
3956
|
-
* @summary List payees
|
|
3957
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3958
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3959
|
-
* @param {*} [options] - Override http request options.
|
|
3960
|
-
* @throws {RequiredError}
|
|
3961
|
-
* @memberof PayeesApi
|
|
3962
|
-
*/
|
|
3963
|
-
getPayees(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<PayeesResponse & {
|
|
3964
|
-
rateLimit: string | null;
|
|
3965
|
-
}>;
|
|
3966
|
-
}
|
|
3967
|
-
/**
|
|
3968
|
-
* ScheduledTransactionsApi - fetch parameter creator
|
|
3969
|
-
* @export
|
|
3970
|
-
*/
|
|
3971
|
-
export declare const ScheduledTransactionsApiFetchParamCreator: (configuration: Configuration) => {
|
|
3972
|
-
/**
|
|
3973
|
-
* Returns a single scheduled transaction
|
|
3974
|
-
* @summary Single scheduled transaction
|
|
3975
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3976
|
-
* @param {string} scheduled_transaction_id - The id of the scheduled transaction
|
|
3977
|
-
* @param {*} [options] - Override http request options.
|
|
3978
|
-
* @throws {RequiredError}
|
|
3979
|
-
*/
|
|
3980
|
-
getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): FetchArgs;
|
|
3981
|
-
/**
|
|
3982
|
-
* Returns all scheduled transactions
|
|
3983
|
-
* @summary List scheduled transactions
|
|
3984
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
3985
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
3986
|
-
* @param {*} [options] - Override http request options.
|
|
3987
|
-
* @throws {RequiredError}
|
|
3988
|
-
*/
|
|
3989
|
-
getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
3990
|
-
};
|
|
3991
|
-
/**
|
|
3992
|
-
* ScheduledTransactionsApi - functional programming interface
|
|
3993
|
-
* @export
|
|
3994
|
-
*/
|
|
3995
|
-
export declare const ScheduledTransactionsApiFp: (configuration: Configuration) => {
|
|
3996
|
-
/**
|
|
3997
|
-
* Returns a single scheduled transaction
|
|
3998
|
-
* @summary Single scheduled transaction
|
|
3999
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4000
|
-
* @param {string} scheduled_transaction_id - The id of the scheduled transaction
|
|
4001
|
-
* @param {*} [options] - Override http request options.
|
|
4002
|
-
* @throws {RequiredError}
|
|
4003
|
-
*/
|
|
4004
|
-
getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionResponse & {
|
|
4005
|
-
rateLimit: string | null;
|
|
4006
|
-
}>;
|
|
4007
|
-
/**
|
|
4008
|
-
* Returns all scheduled transactions
|
|
4009
|
-
* @summary List scheduled transactions
|
|
4010
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4011
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4012
|
-
* @param {*} [options] - Override http request options.
|
|
4013
|
-
* @throws {RequiredError}
|
|
4014
|
-
*/
|
|
4015
|
-
getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<ScheduledTransactionsResponse & {
|
|
4016
|
-
rateLimit: string | null;
|
|
4017
|
-
}>;
|
|
4018
|
-
};
|
|
4019
|
-
/**
|
|
4020
|
-
* ScheduledTransactionsApi - factory interface
|
|
4021
|
-
* @export
|
|
4022
|
-
*/
|
|
4023
|
-
export declare const ScheduledTransactionsApiFactory: (configuration: Configuration) => {
|
|
4024
|
-
/**
|
|
4025
|
-
* Returns a single scheduled transaction
|
|
4026
|
-
* @summary Single scheduled transaction
|
|
4027
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4028
|
-
* @param {string} scheduled_transaction_id - The id of the scheduled transaction
|
|
4029
|
-
* @param {*} [options] - Override http request options.
|
|
4030
|
-
* @throws {RequiredError}
|
|
4031
|
-
*/
|
|
4032
|
-
getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse & {
|
|
4033
|
-
rateLimit: string | null;
|
|
4034
|
-
}>;
|
|
4035
|
-
/**
|
|
4036
|
-
* Returns all scheduled transactions
|
|
4037
|
-
* @summary List scheduled transactions
|
|
4038
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4039
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4040
|
-
* @param {*} [options] - Override http request options.
|
|
4041
|
-
* @throws {RequiredError}
|
|
4042
|
-
*/
|
|
4043
|
-
getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number | undefined, options?: any): Promise<ScheduledTransactionsResponse & {
|
|
4044
|
-
rateLimit: string | null;
|
|
4045
|
-
}>;
|
|
4046
|
-
};
|
|
4047
|
-
/**
|
|
4048
|
-
* ScheduledTransactionsApi - object-oriented interface
|
|
4049
|
-
* @export
|
|
4050
|
-
* @class ScheduledTransactionsApi
|
|
4051
|
-
* @extends {BaseAPI}
|
|
4052
|
-
*/
|
|
4053
|
-
export declare class ScheduledTransactionsApi extends BaseAPI {
|
|
4054
|
-
/**
|
|
4055
|
-
* Returns a single scheduled transaction
|
|
4056
|
-
* @summary Single scheduled transaction
|
|
4057
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4058
|
-
* @param {string} scheduled_transaction_id - The id of the scheduled transaction
|
|
4059
|
-
* @param {*} [options] - Override http request options.
|
|
4060
|
-
* @throws {RequiredError}
|
|
4061
|
-
* @memberof ScheduledTransactionsApi
|
|
4062
|
-
*/
|
|
4063
|
-
getScheduledTransactionById(budget_id: string, scheduled_transaction_id: string, options?: any): Promise<ScheduledTransactionResponse & {
|
|
4064
|
-
rateLimit: string | null;
|
|
4065
|
-
}>;
|
|
4066
|
-
/**
|
|
4067
|
-
* Returns all scheduled transactions
|
|
4068
|
-
* @summary List scheduled transactions
|
|
4069
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4070
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4071
|
-
* @param {*} [options] - Override http request options.
|
|
4072
|
-
* @throws {RequiredError}
|
|
4073
|
-
* @memberof ScheduledTransactionsApi
|
|
4074
|
-
*/
|
|
4075
|
-
getScheduledTransactions(budget_id: string, last_knowledge_of_server?: number, options?: any): Promise<ScheduledTransactionsResponse & {
|
|
4076
|
-
rateLimit: string | null;
|
|
4077
|
-
}>;
|
|
4078
|
-
}
|
|
4079
|
-
/**
|
|
4080
|
-
* TransactionsApi - fetch parameter creator
|
|
4081
|
-
* @export
|
|
4082
|
-
*/
|
|
4083
|
-
export declare const TransactionsApiFetchParamCreator: (configuration: Configuration) => {
|
|
4084
|
-
/**
|
|
4085
|
-
* Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
4086
|
-
* @summary Create a single transaction or multiple transactions
|
|
4087
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4088
|
-
* @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
4089
|
-
* @param {*} [options] - Override http request options.
|
|
4090
|
-
* @throws {RequiredError}
|
|
4091
|
-
*/
|
|
4092
|
-
createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): FetchArgs;
|
|
4093
|
-
/**
|
|
4094
|
-
* Deletes a transaction
|
|
4095
|
-
* @summary Deletes an existing transaction
|
|
4096
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4097
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4098
|
-
* @param {*} [options] - Override http request options.
|
|
4099
|
-
* @throws {RequiredError}
|
|
4100
|
-
*/
|
|
4101
|
-
deleteTransaction(budget_id: string, transaction_id: string, options?: any): FetchArgs;
|
|
4102
|
-
/**
|
|
4103
|
-
* Returns a single transaction
|
|
4104
|
-
* @summary Single transaction
|
|
4105
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4106
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4107
|
-
* @param {*} [options] - Override http request options.
|
|
4108
|
-
* @throws {RequiredError}
|
|
4109
|
-
*/
|
|
4110
|
-
getTransactionById(budget_id: string, transaction_id: string, options?: any): FetchArgs;
|
|
4111
|
-
/**
|
|
4112
|
-
* Returns budget transactions
|
|
4113
|
-
* @summary List transactions
|
|
4114
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4115
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4116
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4117
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4118
|
-
* @param {*} [options] - Override http request options.
|
|
4119
|
-
* @throws {RequiredError}
|
|
4120
|
-
*/
|
|
4121
|
-
getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
4122
|
-
/**
|
|
4123
|
-
* Returns all transactions for a specified account
|
|
4124
|
-
* @summary List account transactions
|
|
4125
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4126
|
-
* @param {string} account_id - The id of the account
|
|
4127
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4128
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4129
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4130
|
-
* @param {*} [options] - Override http request options.
|
|
4131
|
-
* @throws {RequiredError}
|
|
4132
|
-
*/
|
|
4133
|
-
getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
4134
|
-
/**
|
|
4135
|
-
* Returns all transactions for a specified category
|
|
4136
|
-
* @summary List category transactions
|
|
4137
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4138
|
-
* @param {string} category_id - The id of the category
|
|
4139
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4140
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4141
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4142
|
-
* @param {*} [options] - Override http request options.
|
|
4143
|
-
* @throws {RequiredError}
|
|
4144
|
-
*/
|
|
4145
|
-
getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
4146
|
-
/**
|
|
4147
|
-
* Returns all transactions for a specified payee
|
|
4148
|
-
* @summary List payee transactions
|
|
4149
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4150
|
-
* @param {string} payee_id - The id of the payee
|
|
4151
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4152
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4153
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4154
|
-
* @param {*} [options] - Override http request options.
|
|
4155
|
-
* @throws {RequiredError}
|
|
4156
|
-
*/
|
|
4157
|
-
getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): FetchArgs;
|
|
4158
|
-
/**
|
|
4159
|
-
* Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
|
|
4160
|
-
* @summary Import transactions
|
|
4161
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4162
|
-
* @param {*} [options] - Override http request options.
|
|
4163
|
-
* @throws {RequiredError}
|
|
4164
|
-
*/
|
|
4165
|
-
importTransactions(budget_id: string, options?: any): FetchArgs;
|
|
4166
|
-
/**
|
|
4167
|
-
* Updates a single transaction
|
|
4168
|
-
* @summary Updates an existing transaction
|
|
4169
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4170
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4171
|
-
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4172
|
-
* @param {*} [options] - Override http request options.
|
|
4173
|
-
* @throws {RequiredError}
|
|
4174
|
-
*/
|
|
4175
|
-
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): FetchArgs;
|
|
4176
|
-
/**
|
|
4177
|
-
* Updates multiple transactions, by `id` or `import_id`.
|
|
4178
|
-
* @summary Update multiple transactions
|
|
4179
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4180
|
-
* @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
4181
|
-
* @param {*} [options] - Override http request options.
|
|
4182
|
-
* @throws {RequiredError}
|
|
4183
|
-
*/
|
|
4184
|
-
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): FetchArgs;
|
|
4185
|
-
};
|
|
4186
|
-
/**
|
|
4187
|
-
* TransactionsApi - functional programming interface
|
|
4188
|
-
* @export
|
|
4189
|
-
*/
|
|
4190
|
-
export declare const TransactionsApiFp: (configuration: Configuration) => {
|
|
4191
|
-
/**
|
|
4192
|
-
* Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
4193
|
-
* @summary Create a single transaction or multiple transactions
|
|
4194
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4195
|
-
* @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
4196
|
-
* @param {*} [options] - Override http request options.
|
|
4197
|
-
* @throws {RequiredError}
|
|
4198
|
-
*/
|
|
4199
|
-
createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
|
|
4200
|
-
rateLimit: string | null;
|
|
4201
|
-
}>;
|
|
4202
|
-
/**
|
|
4203
|
-
* Deletes a transaction
|
|
4204
|
-
* @summary Deletes an existing transaction
|
|
4205
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4206
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4207
|
-
* @param {*} [options] - Override http request options.
|
|
4208
|
-
* @throws {RequiredError}
|
|
4209
|
-
*/
|
|
4210
|
-
deleteTransaction(budget_id: string, transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
|
|
4211
|
-
rateLimit: string | null;
|
|
4212
|
-
}>;
|
|
4213
|
-
/**
|
|
4214
|
-
* Returns a single transaction
|
|
4215
|
-
* @summary Single transaction
|
|
4216
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4217
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4218
|
-
* @param {*} [options] - Override http request options.
|
|
4219
|
-
* @throws {RequiredError}
|
|
4220
|
-
*/
|
|
4221
|
-
getTransactionById(budget_id: string, transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
|
|
4222
|
-
rateLimit: string | null;
|
|
4223
|
-
}>;
|
|
4224
|
-
/**
|
|
4225
|
-
* Returns budget transactions
|
|
4226
|
-
* @summary List transactions
|
|
4227
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4228
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4229
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4230
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4231
|
-
* @param {*} [options] - Override http request options.
|
|
4232
|
-
* @throws {RequiredError}
|
|
4233
|
-
*/
|
|
4234
|
-
getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse & {
|
|
4235
|
-
rateLimit: string | null;
|
|
4236
|
-
}>;
|
|
4237
|
-
/**
|
|
4238
|
-
* Returns all transactions for a specified account
|
|
4239
|
-
* @summary List account transactions
|
|
4240
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4241
|
-
* @param {string} account_id - The id of the account
|
|
4242
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4243
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4244
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4245
|
-
* @param {*} [options] - Override http request options.
|
|
4246
|
-
* @throws {RequiredError}
|
|
4247
|
-
*/
|
|
4248
|
-
getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsResponse & {
|
|
4249
|
-
rateLimit: string | null;
|
|
4250
|
-
}>;
|
|
4251
|
-
/**
|
|
4252
|
-
* Returns all transactions for a specified category
|
|
4253
|
-
* @summary List category transactions
|
|
4254
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4255
|
-
* @param {string} category_id - The id of the category
|
|
4256
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4257
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4258
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4259
|
-
* @param {*} [options] - Override http request options.
|
|
4260
|
-
* @throws {RequiredError}
|
|
4261
|
-
*/
|
|
4262
|
-
getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse & {
|
|
4263
|
-
rateLimit: string | null;
|
|
4264
|
-
}>;
|
|
4265
|
-
/**
|
|
4266
|
-
* Returns all transactions for a specified payee
|
|
4267
|
-
* @summary List payee transactions
|
|
4268
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4269
|
-
* @param {string} payee_id - The id of the payee
|
|
4270
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4271
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4272
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4273
|
-
* @param {*} [options] - Override http request options.
|
|
4274
|
-
* @throws {RequiredError}
|
|
4275
|
-
*/
|
|
4276
|
-
getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<HybridTransactionsResponse & {
|
|
4277
|
-
rateLimit: string | null;
|
|
4278
|
-
}>;
|
|
4279
|
-
/**
|
|
4280
|
-
* Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
|
|
4281
|
-
* @summary Import transactions
|
|
4282
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4283
|
-
* @param {*} [options] - Override http request options.
|
|
4284
|
-
* @throws {RequiredError}
|
|
4285
|
-
*/
|
|
4286
|
-
importTransactions(budget_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionsImportResponse & {
|
|
4287
|
-
rateLimit: string | null;
|
|
4288
|
-
}>;
|
|
4289
|
-
/**
|
|
4290
|
-
* Updates a single transaction
|
|
4291
|
-
* @summary Updates an existing transaction
|
|
4292
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4293
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4294
|
-
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4295
|
-
* @param {*} [options] - Override http request options.
|
|
4296
|
-
* @throws {RequiredError}
|
|
4297
|
-
*/
|
|
4298
|
-
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
|
|
4299
|
-
rateLimit: string | null;
|
|
4300
|
-
}>;
|
|
4301
|
-
/**
|
|
4302
|
-
* Updates multiple transactions, by `id` or `import_id`.
|
|
4303
|
-
* @summary Update multiple transactions
|
|
4304
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4305
|
-
* @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
4306
|
-
* @param {*} [options] - Override http request options.
|
|
4307
|
-
* @throws {RequiredError}
|
|
4308
|
-
*/
|
|
4309
|
-
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
|
|
4310
|
-
rateLimit: string | null;
|
|
4311
|
-
}>;
|
|
4312
|
-
};
|
|
4313
|
-
/**
|
|
4314
|
-
* TransactionsApi - factory interface
|
|
4315
|
-
* @export
|
|
4316
|
-
*/
|
|
4317
|
-
export declare const TransactionsApiFactory: (configuration: Configuration) => {
|
|
4318
|
-
/**
|
|
4319
|
-
* Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
4320
|
-
* @summary Create a single transaction or multiple transactions
|
|
4321
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4322
|
-
* @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
4323
|
-
* @param {*} [options] - Override http request options.
|
|
4324
|
-
* @throws {RequiredError}
|
|
4325
|
-
*/
|
|
4326
|
-
createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4327
|
-
rateLimit: string | null;
|
|
4328
|
-
}>;
|
|
4329
|
-
/**
|
|
4330
|
-
* Deletes a transaction
|
|
4331
|
-
* @summary Deletes an existing transaction
|
|
4332
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4333
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4334
|
-
* @param {*} [options] - Override http request options.
|
|
4335
|
-
* @throws {RequiredError}
|
|
4336
|
-
*/
|
|
4337
|
-
deleteTransaction(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
|
|
4338
|
-
rateLimit: string | null;
|
|
4339
|
-
}>;
|
|
4340
|
-
/**
|
|
4341
|
-
* Returns a single transaction
|
|
4342
|
-
* @summary Single transaction
|
|
4343
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4344
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4345
|
-
* @param {*} [options] - Override http request options.
|
|
4346
|
-
* @throws {RequiredError}
|
|
4347
|
-
*/
|
|
4348
|
-
getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
|
|
4349
|
-
rateLimit: string | null;
|
|
4350
|
-
}>;
|
|
4351
|
-
/**
|
|
4352
|
-
* Returns budget transactions
|
|
4353
|
-
* @summary List transactions
|
|
4354
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4355
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4356
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4357
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4358
|
-
* @param {*} [options] - Override http request options.
|
|
4359
|
-
* @throws {RequiredError}
|
|
4360
|
-
*/
|
|
4361
|
-
getTransactions(budget_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse & {
|
|
4362
|
-
rateLimit: string | null;
|
|
4363
|
-
}>;
|
|
4364
|
-
/**
|
|
4365
|
-
* Returns all transactions for a specified account
|
|
4366
|
-
* @summary List account transactions
|
|
4367
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4368
|
-
* @param {string} account_id - The id of the account
|
|
4369
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4370
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4371
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4372
|
-
* @param {*} [options] - Override http request options.
|
|
4373
|
-
* @throws {RequiredError}
|
|
4374
|
-
*/
|
|
4375
|
-
getTransactionsByAccount(budget_id: string, account_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<TransactionsResponse & {
|
|
4376
|
-
rateLimit: string | null;
|
|
4377
|
-
}>;
|
|
4378
|
-
/**
|
|
4379
|
-
* Returns all transactions for a specified category
|
|
4380
|
-
* @summary List category transactions
|
|
4381
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4382
|
-
* @param {string} category_id - The id of the category
|
|
4383
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4384
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4385
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4386
|
-
* @param {*} [options] - Override http request options.
|
|
4387
|
-
* @throws {RequiredError}
|
|
4388
|
-
*/
|
|
4389
|
-
getTransactionsByCategory(budget_id: string, category_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse & {
|
|
4390
|
-
rateLimit: string | null;
|
|
4391
|
-
}>;
|
|
4392
|
-
/**
|
|
4393
|
-
* Returns all transactions for a specified payee
|
|
4394
|
-
* @summary List payee transactions
|
|
4395
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4396
|
-
* @param {string} payee_id - The id of the payee
|
|
4397
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4398
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4399
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4400
|
-
* @param {*} [options] - Override http request options.
|
|
4401
|
-
* @throws {RequiredError}
|
|
4402
|
-
*/
|
|
4403
|
-
getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: string | Date | undefined, type?: "uncategorized" | "unapproved" | undefined, last_knowledge_of_server?: number | undefined, options?: any): Promise<HybridTransactionsResponse & {
|
|
4404
|
-
rateLimit: string | null;
|
|
4405
|
-
}>;
|
|
4406
|
-
/**
|
|
4407
|
-
* Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
|
|
4408
|
-
* @summary Import transactions
|
|
4409
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4410
|
-
* @param {*} [options] - Override http request options.
|
|
4411
|
-
* @throws {RequiredError}
|
|
4412
|
-
*/
|
|
4413
|
-
importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse & {
|
|
4414
|
-
rateLimit: string | null;
|
|
4415
|
-
}>;
|
|
4416
|
-
/**
|
|
4417
|
-
* Updates a single transaction
|
|
4418
|
-
* @summary Updates an existing transaction
|
|
4419
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4420
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4421
|
-
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4422
|
-
* @param {*} [options] - Override http request options.
|
|
4423
|
-
* @throws {RequiredError}
|
|
4424
|
-
*/
|
|
4425
|
-
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
|
|
4426
|
-
rateLimit: string | null;
|
|
4427
|
-
}>;
|
|
4428
|
-
/**
|
|
4429
|
-
* Updates multiple transactions, by `id` or `import_id`.
|
|
4430
|
-
* @summary Update multiple transactions
|
|
4431
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4432
|
-
* @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
4433
|
-
* @param {*} [options] - Override http request options.
|
|
4434
|
-
* @throws {RequiredError}
|
|
4435
|
-
*/
|
|
4436
|
-
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4437
|
-
rateLimit: string | null;
|
|
4438
|
-
}>;
|
|
4439
|
-
};
|
|
4440
|
-
/**
|
|
4441
|
-
* TransactionsApi - object-oriented interface
|
|
4442
|
-
* @export
|
|
4443
|
-
* @class TransactionsApi
|
|
4444
|
-
* @extends {BaseAPI}
|
|
4445
|
-
*/
|
|
4446
|
-
export declare class TransactionsApi extends BaseAPI {
|
|
4447
|
-
/**
|
|
4448
|
-
* Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
4449
|
-
* @summary Create a single transaction or multiple transactions
|
|
4450
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4451
|
-
* @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
4452
|
-
* @param {*} [options] - Override http request options.
|
|
4453
|
-
* @throws {RequiredError}
|
|
4454
|
-
* @memberof TransactionsApi
|
|
4455
|
-
*/
|
|
4456
|
-
createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4457
|
-
rateLimit: string | null;
|
|
4458
|
-
}>;
|
|
4459
|
-
/**
|
|
4460
|
-
* Deletes a transaction
|
|
4461
|
-
* @summary Deletes an existing transaction
|
|
4462
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4463
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4464
|
-
* @param {*} [options] - Override http request options.
|
|
4465
|
-
* @throws {RequiredError}
|
|
4466
|
-
* @memberof TransactionsApi
|
|
4467
|
-
*/
|
|
4468
|
-
deleteTransaction(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
|
|
4469
|
-
rateLimit: string | null;
|
|
4470
|
-
}>;
|
|
4471
|
-
/**
|
|
4472
|
-
* Returns a single transaction
|
|
4473
|
-
* @summary Single transaction
|
|
4474
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4475
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4476
|
-
* @param {*} [options] - Override http request options.
|
|
4477
|
-
* @throws {RequiredError}
|
|
4478
|
-
* @memberof TransactionsApi
|
|
4479
|
-
*/
|
|
4480
|
-
getTransactionById(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
|
|
4481
|
-
rateLimit: string | null;
|
|
4482
|
-
}>;
|
|
4483
|
-
/**
|
|
4484
|
-
* Returns budget transactions
|
|
4485
|
-
* @summary List transactions
|
|
4486
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4487
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4488
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4489
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4490
|
-
* @param {*} [options] - Override http request options.
|
|
4491
|
-
* @throws {RequiredError}
|
|
4492
|
-
* @memberof TransactionsApi
|
|
4493
|
-
*/
|
|
4494
|
-
getTransactions(budget_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse & {
|
|
4495
|
-
rateLimit: string | null;
|
|
4496
|
-
}>;
|
|
4497
|
-
/**
|
|
4498
|
-
* Returns all transactions for a specified account
|
|
4499
|
-
* @summary List account transactions
|
|
4500
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4501
|
-
* @param {string} account_id - The id of the account
|
|
4502
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4503
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4504
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4505
|
-
* @param {*} [options] - Override http request options.
|
|
4506
|
-
* @throws {RequiredError}
|
|
4507
|
-
* @memberof TransactionsApi
|
|
4508
|
-
*/
|
|
4509
|
-
getTransactionsByAccount(budget_id: string, account_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<TransactionsResponse & {
|
|
4510
|
-
rateLimit: string | null;
|
|
4511
|
-
}>;
|
|
4512
|
-
/**
|
|
4513
|
-
* Returns all transactions for a specified category
|
|
4514
|
-
* @summary List category transactions
|
|
4515
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4516
|
-
* @param {string} category_id - The id of the category
|
|
4517
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4518
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4519
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4520
|
-
* @param {*} [options] - Override http request options.
|
|
4521
|
-
* @throws {RequiredError}
|
|
4522
|
-
* @memberof TransactionsApi
|
|
4523
|
-
*/
|
|
4524
|
-
getTransactionsByCategory(budget_id: string, category_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse & {
|
|
4525
|
-
rateLimit: string | null;
|
|
4526
|
-
}>;
|
|
4527
|
-
/**
|
|
4528
|
-
* Returns all transactions for a specified payee
|
|
4529
|
-
* @summary List payee transactions
|
|
4530
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4531
|
-
* @param {string} payee_id - The id of the payee
|
|
4532
|
-
* @param {Date} [since_date] - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
|
|
4533
|
-
* @param {'uncategorized' | 'unapproved'} [type] - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
4534
|
-
* @param {number} [last_knowledge_of_server] - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
4535
|
-
* @param {*} [options] - Override http request options.
|
|
4536
|
-
* @throws {RequiredError}
|
|
4537
|
-
* @memberof TransactionsApi
|
|
4538
|
-
*/
|
|
4539
|
-
getTransactionsByPayee(budget_id: string, payee_id: string, since_date?: Date | string, type?: 'uncategorized' | 'unapproved', last_knowledge_of_server?: number, options?: any): Promise<HybridTransactionsResponse & {
|
|
4540
|
-
rateLimit: string | null;
|
|
4541
|
-
}>;
|
|
4542
|
-
/**
|
|
4543
|
-
* Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
|
|
4544
|
-
* @summary Import transactions
|
|
4545
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4546
|
-
* @param {*} [options] - Override http request options.
|
|
4547
|
-
* @throws {RequiredError}
|
|
4548
|
-
* @memberof TransactionsApi
|
|
4549
|
-
*/
|
|
4550
|
-
importTransactions(budget_id: string, options?: any): Promise<TransactionsImportResponse & {
|
|
4551
|
-
rateLimit: string | null;
|
|
4552
|
-
}>;
|
|
4553
|
-
/**
|
|
4554
|
-
* Updates a single transaction
|
|
4555
|
-
* @summary Updates an existing transaction
|
|
4556
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4557
|
-
* @param {string} transaction_id - The id of the transaction
|
|
4558
|
-
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4559
|
-
* @param {*} [options] - Override http request options.
|
|
4560
|
-
* @throws {RequiredError}
|
|
4561
|
-
* @memberof TransactionsApi
|
|
4562
|
-
*/
|
|
4563
|
-
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
|
|
4564
|
-
rateLimit: string | null;
|
|
4565
|
-
}>;
|
|
4566
|
-
/**
|
|
4567
|
-
* Updates multiple transactions, by `id` or `import_id`.
|
|
4568
|
-
* @summary Update multiple transactions
|
|
4569
|
-
* @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
4570
|
-
* @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
4571
|
-
* @param {*} [options] - Override http request options.
|
|
4572
|
-
* @throws {RequiredError}
|
|
4573
|
-
* @memberof TransactionsApi
|
|
4574
|
-
*/
|
|
4575
|
-
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4576
|
-
rateLimit: string | null;
|
|
4577
|
-
}>;
|
|
4578
|
-
}
|
|
4579
|
-
/**
|
|
4580
|
-
* UserApi - fetch parameter creator
|
|
4581
|
-
* @export
|
|
4582
|
-
*/
|
|
4583
|
-
export declare const UserApiFetchParamCreator: (configuration: Configuration) => {
|
|
4584
|
-
/**
|
|
4585
|
-
* Returns authenticated user information
|
|
4586
|
-
* @summary User info
|
|
4587
|
-
* @param {*} [options] - Override http request options.
|
|
4588
|
-
* @throws {RequiredError}
|
|
4589
|
-
*/
|
|
4590
|
-
getUser(options?: any): FetchArgs;
|
|
4591
|
-
};
|
|
4592
|
-
/**
|
|
4593
|
-
* UserApi - functional programming interface
|
|
4594
|
-
* @export
|
|
4595
|
-
*/
|
|
4596
|
-
export declare const UserApiFp: (configuration: Configuration) => {
|
|
4597
|
-
/**
|
|
4598
|
-
* Returns authenticated user information
|
|
4599
|
-
* @summary User info
|
|
4600
|
-
* @param {*} [options] - Override http request options.
|
|
4601
|
-
* @throws {RequiredError}
|
|
4602
|
-
*/
|
|
4603
|
-
getUser(options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<UserResponse & {
|
|
4604
|
-
rateLimit: string | null;
|
|
4605
|
-
}>;
|
|
4606
|
-
};
|
|
4607
|
-
/**
|
|
4608
|
-
* UserApi - factory interface
|
|
4609
|
-
* @export
|
|
4610
|
-
*/
|
|
4611
|
-
export declare const UserApiFactory: (configuration: Configuration) => {
|
|
4612
|
-
/**
|
|
4613
|
-
* Returns authenticated user information
|
|
4614
|
-
* @summary User info
|
|
4615
|
-
* @param {*} [options] - Override http request options.
|
|
4616
|
-
* @throws {RequiredError}
|
|
4617
|
-
*/
|
|
4618
|
-
getUser(options?: any): Promise<UserResponse & {
|
|
4619
|
-
rateLimit: string | null;
|
|
4620
|
-
}>;
|
|
4621
|
-
};
|
|
4622
|
-
/**
|
|
4623
|
-
* UserApi - object-oriented interface
|
|
4624
|
-
* @export
|
|
4625
|
-
* @class UserApi
|
|
4626
|
-
* @extends {BaseAPI}
|
|
4627
|
-
*/
|
|
4628
|
-
export declare class UserApi extends BaseAPI {
|
|
4629
|
-
/**
|
|
4630
|
-
* Returns authenticated user information
|
|
4631
|
-
* @summary User info
|
|
4632
|
-
* @param {*} [options] - Override http request options.
|
|
4633
|
-
* @throws {RequiredError}
|
|
4634
|
-
* @memberof UserApi
|
|
4635
|
-
*/
|
|
4636
|
-
getUser(options?: any): Promise<UserResponse & {
|
|
4637
|
-
rateLimit: string | null;
|
|
4638
|
-
}>;
|
|
4639
|
-
}
|