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.ynab.com
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Put the package under your project folder in a directory named openapi
and add the following to Cargo.toml
under [dependencies]
:
openapi = { path = "./openapi" }
All URIs are relative to https://api.ynab.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AccountsApi | create_account | POST /budgets/{budget_id}/accounts | Create a new account |
AccountsApi | get_account_by_id | GET /budgets/{budget_id}/accounts/{account_id} | Single account |
AccountsApi | get_accounts | GET /budgets/{budget_id}/accounts | Account list |
BudgetsApi | get_budget_by_id | GET /budgets/{budget_id} | Single budget |
BudgetsApi | get_budget_settings_by_id | GET /budgets/{budget_id}/settings | Budget Settings |
BudgetsApi | get_budgets | GET /budgets | List budgets |
CategoriesApi | get_categories | GET /budgets/{budget_id}/categories | List categories |
CategoriesApi | get_category_by_id | GET /budgets/{budget_id}/categories/{category_id} | Single category |
CategoriesApi | get_month_category_by_id | GET /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month |
CategoriesApi | update_category | PATCH /budgets/{budget_id}/categories/{category_id} | Update a category |
CategoriesApi | update_month_category | PATCH /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
MonthsApi | get_budget_month | GET /budgets/{budget_id}/months/{month} | Single budget month |
MonthsApi | get_budget_months | GET /budgets/{budget_id}/months | List budget months |
PayeeLocationsApi | get_payee_location_by_id | GET /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
PayeeLocationsApi | get_payee_locations | GET /budgets/{budget_id}/payee_locations | List payee locations |
PayeeLocationsApi | get_payee_locations_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
PayeesApi | get_payee_by_id | GET /budgets/{budget_id}/payees/{payee_id} | Single payee |
PayeesApi | get_payees | GET /budgets/{budget_id}/payees | List payees |
ScheduledTransactionsApi | get_scheduled_transaction_by_id | GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction |
ScheduledTransactionsApi | get_scheduled_transactions | GET /budgets/{budget_id}/scheduled_transactions | List scheduled transactions |
TransactionsApi | create_transaction | POST /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions |
TransactionsApi | delete_transaction | DELETE /budgets/{budget_id}/transactions/{transaction_id} | Deletes an existing transaction |
TransactionsApi | get_transaction_by_id | GET /budgets/{budget_id}/transactions/{transaction_id} | Single transaction |
TransactionsApi | get_transactions | GET /budgets/{budget_id}/transactions | List transactions |
TransactionsApi | get_transactions_by_account | GET /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions |
TransactionsApi | get_transactions_by_category | GET /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions |
TransactionsApi | get_transactions_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions |
TransactionsApi | import_transactions | POST /budgets/{budget_id}/transactions/import | Import transactions |
TransactionsApi | update_transaction | PUT /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction |
TransactionsApi | update_transactions | PATCH /budgets/{budget_id}/transactions | Update multiple transactions |
UserApi | get_user | GET /user | User info |
- Account
- AccountResponse
- AccountResponseData
- AccountType
- AccountsResponse
- AccountsResponseData
- BudgetDetail
- BudgetDetailResponse
- BudgetDetailResponseData
- BudgetSettings
- BudgetSettingsResponse
- BudgetSettingsResponseData
- BudgetSummary
- BudgetSummaryResponse
- BudgetSummaryResponseData
- BulkResponse
- BulkResponseData
- BulkResponseDataBulk
- BulkTransactions
- CategoriesResponse
- CategoriesResponseData
- Category
- CategoryGroup
- CategoryGroupWithCategories
- CategoryResponse
- CategoryResponseData
- CurrencyFormat
- DateFormat
- ErrorDetail
- ErrorResponse
- HybridTransaction
- HybridTransactionsResponse
- HybridTransactionsResponseData
- MonthDetail
- MonthDetailResponse
- MonthDetailResponseData
- MonthSummariesResponse
- MonthSummariesResponseData
- MonthSummary
- PatchCategoryWrapper
- PatchMonthCategoryWrapper
- PatchTransactionsWrapper
- Payee
- PayeeLocation
- PayeeLocationResponse
- PayeeLocationResponseData
- PayeeLocationsResponse
- PayeeLocationsResponseData
- PayeeResponse
- PayeeResponseData
- PayeesResponse
- PayeesResponseData
- PostAccountWrapper
- PostTransactionsWrapper
- PutTransactionWrapper
- SaveAccount
- SaveCategory
- SaveCategoryResponse
- SaveCategoryResponseData
- SaveMonthCategory
- SaveSubTransaction
- SaveTransaction
- SaveTransactionWithId
- SaveTransactionWithOptionalFields
- SaveTransactionsResponse
- SaveTransactionsResponseData
- ScheduledSubTransaction
- ScheduledTransactionDetail
- ScheduledTransactionResponse
- ScheduledTransactionResponseData
- ScheduledTransactionSummary
- ScheduledTransactionsResponse
- ScheduledTransactionsResponseData
- SubTransaction
- TransactionClearedStatus
- TransactionDetail
- TransactionFlagColor
- TransactionResponse
- TransactionResponseData
- TransactionSummary
- TransactionsImportResponse
- TransactionsImportResponseData
- TransactionsResponse
- TransactionsResponseData
- User
- UserResponse
- UserResponseData
To get access to the crate's generated documentation, use:
cargo doc --open