Package cm.xd.genapi.ynab.api

Class TransactionsApi

java.lang.Object
cm.xd.genapi.ynab.api.TransactionsApi
public class TransactionsApi extends Object

  • Constructor Details

    • TransactionsApi

      public TransactionsApi()

    • TransactionsApi

      public TransactionsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • createTransactionCall

      public okhttp3.Call createTransactionCall(@Nonnull String planId, @Nonnull PostTransactionsWrapper data, ApiCallback _callback) throws ApiException
      Build call for createTransaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 The transaction or transactions were successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -
      409 A transaction on the same account with the same `import_id` already exists. -

    • createTransaction

      public SaveTransactionsResponse createTransaction(@Nonnull String planId, @Nonnull PostTransactionsWrapper data) throws ApiException
      Create a single transaction or multiple transactions 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 (transactions with a future date) cannot be created on this endpoint.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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. (required)
      Returns:
      SaveTransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 The transaction or transactions were successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -
      409 A transaction on the same account with the same `import_id` already exists. -

    • createTransactionWithHttpInfo

      public ApiResponse<SaveTransactionsResponse> createTransactionWithHttpInfo(@Nonnull String planId, @Nonnull PostTransactionsWrapper data) throws ApiException
      Create a single transaction or multiple transactions 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 (transactions with a future date) cannot be created on this endpoint.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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. (required)
      Returns:
      ApiResponse<SaveTransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 The transaction or transactions were successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -
      409 A transaction on the same account with the same `import_id` already exists. -

    • createTransactionAsync

      public okhttp3.Call createTransactionAsync(@Nonnull String planId, @Nonnull PostTransactionsWrapper data, ApiCallback<SaveTransactionsResponse> _callback) throws ApiException
      Create a single transaction or multiple transactions (asynchronously) 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 (transactions with a future date) cannot be created on this endpoint.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      201 The transaction or transactions were successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -
      409 A transaction on the same account with the same `import_id` already exists. -

    • deleteTransactionCall

      public okhttp3.Call deleteTransactionCall(@Nonnull String planId, @Nonnull String transactionId, ApiCallback _callback) throws ApiException
      Build call for deleteTransaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully deleted -
      404 The transaction was not found -

    • deleteTransaction

      public TransactionResponse deleteTransaction(@Nonnull String planId, @Nonnull String transactionId) throws ApiException
      Delete a transaction Deletes a transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      Returns:
      TransactionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully deleted -
      404 The transaction was not found -

    • deleteTransactionWithHttpInfo

      public ApiResponse<TransactionResponse> deleteTransactionWithHttpInfo(@Nonnull String planId, @Nonnull String transactionId) throws ApiException
      Delete a transaction Deletes a transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      Returns:
      ApiResponse<TransactionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully deleted -
      404 The transaction was not found -

    • deleteTransactionAsync

      public okhttp3.Call deleteTransactionAsync(@Nonnull String planId, @Nonnull String transactionId, ApiCallback<TransactionResponse> _callback) throws ApiException
      Delete a transaction (asynchronously) Deletes a transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully deleted -
      404 The transaction was not found -

    • getTransactionByIdCall

      public okhttp3.Call getTransactionByIdCall(@Nonnull String planId, @Nonnull String transactionId, ApiCallback _callback) throws ApiException
      Build call for getTransactionById
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The requested transaction -
      404 The transaction was not found -

    • getTransactionById

      public TransactionResponse getTransactionById(@Nonnull String planId, @Nonnull String transactionId) throws ApiException
      Get a transaction Returns a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      Returns:
      TransactionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The requested transaction -
      404 The transaction was not found -

    • getTransactionByIdWithHttpInfo

      public ApiResponse<TransactionResponse> getTransactionByIdWithHttpInfo(@Nonnull String planId, @Nonnull String transactionId) throws ApiException
      Get a transaction Returns a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      Returns:
      ApiResponse<TransactionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The requested transaction -
      404 The transaction was not found -

    • getTransactionByIdAsync

      public okhttp3.Call getTransactionByIdAsync(@Nonnull String planId, @Nonnull String transactionId, ApiCallback<TransactionResponse> _callback) throws ApiException
      Get a transaction (asynchronously) Returns a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The requested transaction -
      404 The transaction was not found -

    • getTransactionsCall

      public okhttp3.Call getTransactionsCall(@Nonnull String planId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getTransactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      400 An error occurred -
      404 No transactions were found -

    • getTransactions

      public TransactionsResponse getTransactions(@Nonnull String planId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all transactions Returns plan transactions, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      TransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      400 An error occurred -
      404 No transactions were found -

    • getTransactionsWithHttpInfo

      public ApiResponse<TransactionsResponse> getTransactionsWithHttpInfo(@Nonnull String planId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all transactions Returns plan transactions, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      ApiResponse<TransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      400 An error occurred -
      404 No transactions were found -

    • getTransactionsAsync

      public okhttp3.Call getTransactionsAsync(@Nonnull String planId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback<TransactionsResponse> _callback) throws ApiException
      Get all transactions (asynchronously) Returns plan transactions, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      400 An error occurred -
      404 No transactions were found -

    • getTransactionsByAccountCall

      public okhttp3.Call getTransactionsByAccountCall(@Nonnull String planId, @Nonnull String accountId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getTransactionsByAccount
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      accountId - The id of the account (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByAccount

      public TransactionsResponse getTransactionsByAccount(@Nonnull String planId, @Nonnull String accountId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all account transactions Returns all transactions for a specified account, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      accountId - The id of the account (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      TransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByAccountWithHttpInfo

      public ApiResponse<TransactionsResponse> getTransactionsByAccountWithHttpInfo(@Nonnull String planId, @Nonnull String accountId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all account transactions Returns all transactions for a specified account, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      accountId - The id of the account (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      ApiResponse<TransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByAccountAsync

      public okhttp3.Call getTransactionsByAccountAsync(@Nonnull String planId, @Nonnull String accountId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback<TransactionsResponse> _callback) throws ApiException
      Get all account transactions (asynchronously) Returns all transactions for a specified account, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      accountId - The id of the account (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByCategoryCall

      public okhttp3.Call getTransactionsByCategoryCall(@Nonnull String planId, @Nonnull String categoryId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getTransactionsByCategory
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      categoryId - The id of the category (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByCategory

      public HybridTransactionsResponse getTransactionsByCategory(@Nonnull String planId, @Nonnull String categoryId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all category transactions Returns all transactions for a specified category, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      categoryId - The id of the category (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      HybridTransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByCategoryWithHttpInfo

      public ApiResponse<HybridTransactionsResponse> getTransactionsByCategoryWithHttpInfo(@Nonnull String planId, @Nonnull String categoryId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all category transactions Returns all transactions for a specified category, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      categoryId - The id of the category (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      ApiResponse<HybridTransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByCategoryAsync

      public okhttp3.Call getTransactionsByCategoryAsync(@Nonnull String planId, @Nonnull String categoryId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback<HybridTransactionsResponse> _callback) throws ApiException
      Get all category transactions (asynchronously) Returns all transactions for a specified category, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      categoryId - The id of the category (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByMonthCall

      public okhttp3.Call getTransactionsByMonthCall(@Nonnull String planId, @Nonnull String month, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getTransactionsByMonth
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByMonth

      public TransactionsResponse getTransactionsByMonth(@Nonnull String planId, @Nonnull String month, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all plan month transactions Returns all transactions for a specified month, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      TransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByMonthWithHttpInfo

      public ApiResponse<TransactionsResponse> getTransactionsByMonthWithHttpInfo(@Nonnull String planId, @Nonnull String month, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all plan month transactions Returns all transactions for a specified month, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      ApiResponse<TransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByMonthAsync

      public okhttp3.Call getTransactionsByMonthAsync(@Nonnull String planId, @Nonnull String month, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback<TransactionsResponse> _callback) throws ApiException
      Get all plan month transactions (asynchronously) Returns all transactions for a specified month, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByPayeeCall

      public okhttp3.Call getTransactionsByPayeeCall(@Nonnull String planId, @Nonnull String payeeId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getTransactionsByPayee
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      payeeId - The id of the payee (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByPayee

      public HybridTransactionsResponse getTransactionsByPayee(@Nonnull String planId, @Nonnull String payeeId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all payee transactions Returns all transactions for a specified payee, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      payeeId - The id of the payee (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      HybridTransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByPayeeWithHttpInfo

      public ApiResponse<HybridTransactionsResponse> getTransactionsByPayeeWithHttpInfo(@Nonnull String planId, @Nonnull String payeeId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all payee transactions Returns all transactions for a specified payee, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      payeeId - The id of the payee (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      Returns:
      ApiResponse<HybridTransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • getTransactionsByPayeeAsync

      public okhttp3.Call getTransactionsByPayeeAsync(@Nonnull String planId, @Nonnull String payeeId, @Nullable LocalDate sinceDate, @Nullable String type, @Nullable Long lastKnowledgeOfServer, ApiCallback<HybridTransactionsResponse> _callback) throws ApiException
      Get all payee transactions (asynchronously) Returns all transactions for a specified payee, excluding any pending transactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      payeeId - The id of the payee (required)
      sinceDate - If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). (optional)
      type - If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported. (optional)
      lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The list of requested transactions -
      404 No transactions were found -

    • importTransactionsCall

      public okhttp3.Call importTransactionsCall(@Nonnull String planId, ApiCallback _callback) throws ApiException
      Build call for importTransactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The request was successful but there were no transactions to import -
      201 One or more transactions were imported successfully -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • importTransactions

      public TransactionsImportResponse importTransactions(@Nonnull String planId) throws ApiException
      Import transactions Imports available transactions on all linked accounts for the given plan. 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.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      Returns:
      TransactionsImportResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The request was successful but there were no transactions to import -
      201 One or more transactions were imported successfully -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • importTransactionsWithHttpInfo

      public ApiResponse<TransactionsImportResponse> importTransactionsWithHttpInfo(@Nonnull String planId) throws ApiException
      Import transactions Imports available transactions on all linked accounts for the given plan. 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.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      Returns:
      ApiResponse<TransactionsImportResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The request was successful but there were no transactions to import -
      201 One or more transactions were imported successfully -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • importTransactionsAsync

      public okhttp3.Call importTransactionsAsync(@Nonnull String planId, ApiCallback<TransactionsImportResponse> _callback) throws ApiException
      Import transactions (asynchronously) Imports available transactions on all linked accounts for the given plan. 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.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The request was successful but there were no transactions to import -
      201 One or more transactions were imported successfully -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateTransactionCall

      public okhttp3.Call updateTransactionCall(@Nonnull String planId, @Nonnull String transactionId, @Nonnull PutTransactionWrapper data, ApiCallback _callback) throws ApiException
      Build call for updateTransaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      data - The transaction to update (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateTransaction

      public TransactionResponse updateTransaction(@Nonnull String planId, @Nonnull String transactionId, @Nonnull PutTransactionWrapper data) throws ApiException
      Update a transaction Updates a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      data - The transaction to update (required)
      Returns:
      TransactionResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateTransactionWithHttpInfo

      public ApiResponse<TransactionResponse> updateTransactionWithHttpInfo(@Nonnull String planId, @Nonnull String transactionId, @Nonnull PutTransactionWrapper data) throws ApiException
      Update a transaction Updates a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      data - The transaction to update (required)
      Returns:
      ApiResponse<TransactionResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateTransactionAsync

      public okhttp3.Call updateTransactionAsync(@Nonnull String planId, @Nonnull String transactionId, @Nonnull PutTransactionWrapper data, ApiCallback<TransactionResponse> _callback) throws ApiException
      Update a transaction (asynchronously) Updates a single transaction
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      transactionId - The id of the transaction (required)
      data - The transaction to update (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      200 The transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateTransactionsCall

      public okhttp3.Call updateTransactionsCall(@Nonnull String planId, @Nonnull PatchTransactionsWrapper data, ApiCallback _callback) throws ApiException
      Build call for updateTransactions
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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 its `import_id`. If an `id` is specified, it will always be used for lookup. You should not specify both `id` and `import_id`. Updating an `import_id` on an existing transaction is not allowed; if an `import_id` is specified, it will only be used to lookup the transaction. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      209 The transactions were successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • updateTransactions

      public SaveTransactionsResponse updateTransactions(@Nonnull String planId, @Nonnull PatchTransactionsWrapper data) throws ApiException
      Update multiple transactions Updates multiple transactions, by `id` or `import_id`.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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 its `import_id`. If an `id` is specified, it will always be used for lookup. You should not specify both `id` and `import_id`. Updating an `import_id` on an existing transaction is not allowed; if an `import_id` is specified, it will only be used to lookup the transaction. (required)
      Returns:
      SaveTransactionsResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      209 The transactions were successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • updateTransactionsWithHttpInfo

      public ApiResponse<SaveTransactionsResponse> updateTransactionsWithHttpInfo(@Nonnull String planId, @Nonnull PatchTransactionsWrapper data) throws ApiException
      Update multiple transactions Updates multiple transactions, by `id` or `import_id`.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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 its `import_id`. If an `id` is specified, it will always be used for lookup. You should not specify both `id` and `import_id`. Updating an `import_id` on an existing transaction is not allowed; if an `import_id` is specified, it will only be used to lookup the transaction. (required)
      Returns:
      ApiResponse<SaveTransactionsResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details
      Response Details
      Status Code Description Response Headers
      209 The transactions were successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • updateTransactionsAsync

      public okhttp3.Call updateTransactionsAsync(@Nonnull String planId, @Nonnull PatchTransactionsWrapper data, ApiCallback<SaveTransactionsResponse> _callback) throws ApiException
      Update multiple transactions (asynchronously) Updates multiple transactions, by `id` or `import_id`.
      Parameters:
      planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)
      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 its `import_id`. If an `id` is specified, it will always be used for lookup. You should not specify both `id` and `import_id`. Updating an `import_id` on an existing transaction is not allowed; if an `import_id` is specified, it will only be used to lookup the transaction. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details
      Response Details
      Status Code Description Response Headers
      209 The transactions were successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s). -