PocketSmith

Tools (58)

Extracted live via the executor SDK.

• accounts.deleteAccountsId

  Deletes an account and all its data by ID, optionally merge scenarios into another account.

• accounts.getAccountsId

  Gets an account by its ID.

• accounts.getInstitutionsIdAccounts

  Lists accounts belonging to an institution by its ID.

• accounts.getUsersIdAccounts

  Lists all accounts belonging to the user by their ID.

• accounts.postUsersIdAccounts

  Creates and returns an account belonging to the user by their ID.

• accounts.putAccountsId

  Updates and returns an account by its ID.

• accounts.putUsersIdAccounts

  Updates the display order of accounts belonging to the user, by accepting an array of accounts in their new display order.

• attachments.deleteAttachmentsId

  Deletes a particular attachment by its ID.

• attachments.deleteTransactionsTransactionIdAttachmentsAttachmentId

  Unassigns a particular attachment by its ID from the transaction ID. This does not delete the attachment, it only removes its association from the transaction.

• attachments.getAttachmentsId

  Gets a particular attachment by its ID.

• attachments.getTransactionsIdAttachments

  Lists attachments belonging to a transaction by their ID.

• attachments.getUsersIdAttachments

  Lists attachments belonging to a user by their ID.

• attachments.postTransactionsIdAttachments

  Assigns an attachment to the transaction by their ID.

• attachments.postUsersIdAttachments

  Creates an attachment belonging to the user by their ID.

• attachments.putAttachmentsId

  Updates the title of the attachment.

• budgeting.deleteUsersIdForecastCache

  Delete the user's cached forecast by recalculating the forecast.

• budgeting.getUsersIdBudget

  Lists the user's budget, consisting of one or more budget analysis packages, one per category. Akin to the list on the Budget page in PocketSmith.

• budgeting.getUsersIdBudgetSummary

  Get the user's budget summary, containing an expense and income analysis for all categories (excluding transfer categories) for the given period and date range. Akin to the overall budget shown on the Budget page in PocketSmith.

• budgeting.getUsersIdTrendAnalysis

  Get an income and/or expense budget analysis for the given date range and period across any number of categories and scenarios. Akin to the Trends page in PocketSmith.

• categories.deleteCategoriesId

  Deletes a particular category by its ID. This will delete all budgets within the category, and uncategorize all transactions assigned to the category.

• categories.getCategoriesId

  Gets a particular category by its ID.

• categories.getUsersIdCategories

  Lists all categories belonging to a user by their ID.

• categories.postUsersIdCategories

  Creates a category belonging to the user by their ID.

• categories.putCategoriesId

  Updates a category by its ID.

• categoryRules.getUsersIdCategoryRules

  Lists all category rules belonging to a user by their ID.

• categoryRules.postCategoriesIdCategoryRules

  Creates a rule to allocate a category to transactions.

• currencies.getCurrencies

  Lists currencies supported by PocketSmith.

• currencies.getCurrenciesId

  Gets a particular currency by its ID.

• events.deleteEventsId

  Deletes an event by its ID.

• events.getEventsId

  Gets a particular event by its ID.

• events.getScenariosIdEvents

  Lists events belonging to a scenario by their ID.

• events.getUsersIdEvents

  Lists events belonging to a user by their ID.

• events.postScenariosIdEvents

  Creates an event in a scenario by its ID.

• events.putEventsId

  Updates an event by its ID.

• institutions.deleteInstitutionsId

  Deletes an institution and all data within. Alternatively, another institution can be provided to merge the data into to avoid losing it.

• institutions.getInstitutionsId

  Gets an institution by its ID.

• institutions.getUsersIdInstitutions

  Lists all the institutions belonging to the user.

• institutions.postUsersIdInstitutions

  Creates an institution belonging to a user.

• institutions.putInstitutionsId

  Updates the title and currency code for an institution.

• labels.getUsersIdLabels

  Lists labels belonging to a user by their ID.

• savedSearches.getUsersIdSavedSearches

  Lists saved searches belonging to a user by their ID.

• timeZones.getTimeZones

  Lists time zones.

• transactionAccounts.getTransactionAccountsId

  Gets a transaction account by its ID.

• transactionAccounts.getUsersIdTransactionAccounts

  List all transaction accounts belonging to a user.

• transactionAccounts.putTransactionAccountsId

  Updates the transaction account by its ID.

• transactions.deleteTransactionsId

  Deletes a transaction and all its data by ID.

• transactions.getAccountsIdTransactions

  Lists transactions belonging to an account by its ID.

• transactions.getCategoriesIdTransactions

  Lists transactions belonging to one or more categories by their IDs.

• transactions.getTransactionAccountsIdTransactions

  Lists transactions belonging to a transaction account by its ID.

• transactions.getTransactionsId

  Gets a transaction by its ID.

• transactions.getUsersIdTransactions

  Lists transactions belonging to a user by their ID.

• transactions.postTransactionAccountsIdTransactions

  Creates a transaction in a transaction account by its ID.

• transactions.putTransactionsId

  Updates a transaction by its ID.

• users.getMe

  Gets the user that corresponds to the access token used in the request.

• users.getUsersId

  Gets a user by ID. You must be authorised as the target user in order to make this request.

• users.putUsersId

  Updates the user by their ID. You must be authorised as the target user in order to make this request.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools