> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PocketSmith

> PocketSmith is a personal finance platform for tracking accounts and transactions, managing budgets, and forecasting financial outcomes.

![PocketSmith logo](https://mintcdn.com/composio-preview/HvfZXDijhFOaKyF5/images/toolkits/pocketsmith.svg?fit=max\&auto=format\&n=HvfZXDijhFOaKyF5\&q=85\&s=e852d70c0118ba035d83e2b3fc31a3d9)

* **Category:** accounting
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `POCKETSMITH`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Category
>
> **Slug:** `POCKETSMITH_CREATE_CATEGORY`
>
> Create one category for a PocketSmith user with optional hierarchy and budgeting behavior.
>
> #### Input Parameters
>
> **color** `string`
>
> CSS hexadecimal color in #RRGGBB format.
>
> **title** `string` *required*
>
> Category title.
>
> **is\_bill** `boolean`
>
> Whether this is a bill category.
>
> **roll\_up** `boolean`
>
> Whether budget figures should roll up into the parent category.
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> **is\_transfer** `boolean`
>
> Whether this is a transfer category.
>
> **refund\_behavior** `string ("debits_are_deductions" | "credits_are_refunds")`
>
> How PocketSmith should treat refunds in this category.
>
> **parent\_category\_id** `integer`
>
> Existing category ID that should become this category's parent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Transaction
>
> **Slug:** `POCKETSMITH_CREATE_TRANSACTION`
>
> Create one transaction in a specified transaction account and return the created financial record.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Date the transaction occurred in YYYY-MM-DD format.
>
> **memo** `string`
>
> Memo for the transaction.
>
> **note** `string`
>
> Detailed note for the transaction.
>
> **payee** `string` *required*
>
> Payee or merchant for the transaction.
>
> **amount** `number` *required*
>
> Signed amount: positive for a credit and negative for a debit.
>
> **labels** `array`
>
> Labels to assign to the transaction.
>
> **category\_id** `integer`
>
> Category ID to assign to the transaction.
>
> **is\_transfer** `boolean`
>
> Whether this transaction represents a transfer.
>
> **needs\_review** `boolean`
>
> Whether the transaction should be marked for review.
>
> **cheque\_number** `string`
>
> Cheque number associated with the transaction.
>
> **transaction\_account\_id** `integer` *required*
>
> Transaction-account ID returned by POCKETSMITH\_LIST\_TRANSACTION\_ACCOUNTS.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Budget
>
> **Slug:** `POCKETSMITH_GET_BUDGET`
>
> Return a PocketSmith user's current category-level actual and forecast budget analysis. During probing, this read coincided with forecast cache access/update timestamps changing to the call timestamp and the forecast start date also changing; PocketSmith may therefore refresh derived forecast-cache metadata while serving it, although the probe did not establish that every call does so.
>
> #### Input Parameters
>
> **roll\_up** `boolean`
>
> Whether parent-category actual and forecast totals should include child categories. Child categories still appear separately.
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Budget Summary
>
> **Slug:** `POCKETSMITH_GET_BUDGET_SUMMARY`
>
> Analyze a user's combined income and expense budget, excluding transfer categories, over a required date range and period interval.
>
> #### Input Parameters
>
> **period** `string ("weeks" | "months" | "years" | "event")` *required*
>
> Unit used to group the analysis; event works only when gathered budget events align.
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> **end\_date** `string` *required*
>
> End of the analysis range in YYYY-MM-DD format; PocketSmith may expand it to complete periods.
>
> **interval** `integer` *required*
>
> Number of period units in each analysis bucket, such as 2 weeks for fortnightly results.
>
> **start\_date** `string` *required*
>
> Start of the analysis range in YYYY-MM-DD format; PocketSmith may expand it to complete periods.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `POCKETSMITH_GET_CURRENT_USER`
>
> Return the PocketSmith user authorized by the connected developer key, including the user ID needed by user-scoped tools.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transaction
>
> **Slug:** `POCKETSMITH_GET_TRANSACTION`
>
> Return one PocketSmith transaction by ID with its amount, date, payee, category, labels, and review state.
>
> #### Input Parameters
>
> **transaction\_id** `integer` *required*
>
> ID of the transaction to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Accounts
>
> **Slug:** `POCKETSMITH_LIST_ACCOUNTS`
>
> Return all financial accounts belonging to a PocketSmith user, including account, primary transaction-account, and scenario IDs.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Categories
>
> **Slug:** `POCKETSMITH_LIST_CATEGORIES`
>
> Return all categories belonging to a PocketSmith user, including hierarchy and budgeting flags.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transaction Accounts
>
> **Slug:** `POCKETSMITH_LIST_TRANSACTION_ACCOUNTS`
>
> Return the transaction accounts belonging to a PocketSmith user, including IDs and balances needed to create and query transactions.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transactions
>
> **Slug:** `POCKETSMITH_LIST_TRANSACTIONS`
>
> Return one page of a user's transactions with optional date, state, type, and keyword filters, plus a cursor for the next page.
>
> #### Input Parameters
>
> **search** `string`
>
> Keyword matched against amount, account, payee, category, note, labels, and date.
>
> **user\_id** `integer` *required*
>
> PocketSmith user ID returned by POCKETSMITH\_GET\_CURRENT\_USER.
>
> **end\_date** `string`
>
> Latest transaction date, inclusive. Supply together with start\_date.
>
> **per\_page** `integer`
>
> Maximum transactions in this page (10-1000).
>
> **start\_date** `string`
>
> Earliest transaction date, inclusive. Supply together with end\_date.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by the previous call; omit for the first page.
>
> **needs\_review** `boolean`
>
> When true, return only transactions marked for review.
>
> **uncategorized** `boolean`
>
> When true, return only uncategorized transactions.
>
> **updated\_since** `string`
>
> Return only transactions updated since this ISO 8601 timestamp.
>
> **transaction\_type** `string ("debit" | "credit")`
>
> Return only debit or credit transactions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Account
>
> **Slug:** `POCKETSMITH_UPDATE_ACCOUNT`
>
> Update selected metadata on one financial account without deleting it or changing transaction-account balances.
>
> #### Input Parameters
>
> **title** `string`
>
> New account title.
>
> **account\_id** `integer` *required*
>
> ID of the financial account to update, returned by POCKETSMITH\_LIST\_ACCOUNTS.
>
> **account\_type** `string ("bank" | "credits" | "cash" | "loans" | "mortgage" | "stocks" | "vehicle" | "property" | "insurance" | "other_asset" | "other_liability")`
>
> New PocketSmith account type.
>
> **is\_net\_worth** `boolean`
>
> Whether PocketSmith should include the account in net worth.
>
> **currency\_code** `string`
>
> New PocketSmith currency code, such as USD or NZD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Category
>
> **Slug:** `POCKETSMITH_UPDATE_CATEGORY`
>
> Update selected hierarchy, display, and budgeting fields on one category without deleting it.
>
> #### Input Parameters
>
> **color** `string`
>
> New CSS hexadecimal color in #RRGGBB format.
>
> **title** `string`
>
> New category title.
>
> **is\_bill** `boolean`
>
> Whether this is a bill category.
>
> **roll\_up** `boolean`
>
> Whether budget figures roll up into the parent category.
>
> **category\_id** `integer` *required*
>
> ID of the category to update.
>
> **is\_transfer** `boolean`
>
> Whether this is a transfer category.
>
> **refund\_behavior** `string ("debits_are_deductions" | "credits_are_refunds")`
>
> New refund treatment for this category.
>
> **parent\_category\_id** `integer`
>
> New parent category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Transaction
>
> **Slug:** `POCKETSMITH_UPDATE_TRANSACTION`
>
> Update selected fields on one existing transaction without deleting or splitting it.
>
> #### Input Parameters
>
> **date** `string`
>
> New transaction date in YYYY-MM-DD format.
>
> **memo** `string`
>
> New transaction memo.
>
> **note** `string`
>
> New detailed transaction note.
>
> **payee** `string`
>
> New payee or merchant.
>
> **amount** `number`
>
> New signed amount: positive for a credit and negative for a debit.
>
> **labels** `array`
>
> Replacement labels. Supply an empty list to remove all labels.
>
> **category\_id** `integer`
>
> New category ID for the transaction.
>
> **is\_transfer** `boolean`
>
> Whether this transaction represents a transfer.
>
> **needs\_review** `boolean`
>
> Whether the transaction needs review.
>
> **cheque\_number** `string`
>
> New cheque number.
>
> **clear\_category** `boolean`
>
> Set true to remove the transaction's current category.
>
> **transaction\_id** `integer` *required*
>
> ID of the transaction to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Transactions
>
> **Slug:** `POCKETSMITH_UPDATE_TRANSACTIONS`
>
> Update 1–20 distinct transactions sequentially without rolling back successful updates. When processing completes, it reports per-item outcomes; processing stops after an authentication, permission, rate-limit, server, unexpected-response, or ambiguous transport failure.
>
> #### Input Parameters
>
> **updates** `array` *required*
>
> Ordered updates for 1-20 distinct transactions. Each item is sent as a separate sequential PocketSmith request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
