Skip to main content
PocketSmith logo
  • Category: accounting
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: POCKETSMITH
  • Version: 20261101_00

Tools

Slug: POCKETSMITH_CREATE_CATEGORYCreate one category for a PocketSmith user with optional hierarchy and budgeting behavior.

Input Parameters

string
CSS hexadecimal color in #RRGGBB format.
string
required
Category title.
boolean
Whether this is a bill category.
boolean
Whether budget figures should roll up into the parent category.
integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.
boolean
Whether this is a transfer category.
string ("debits_are_deductions" | "credits_are_refunds")
How PocketSmith should treat refunds in this category.
integer
Existing category ID that should become this category’s parent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_CREATE_TRANSACTIONCreate one transaction in a specified transaction account and return the created financial record.

Input Parameters

string
required
Date the transaction occurred in YYYY-MM-DD format.
string
Memo for the transaction.
string
Detailed note for the transaction.
string
required
Payee or merchant for the transaction.
number
required
Signed amount: positive for a credit and negative for a debit.
array
Labels to assign to the transaction.
integer
Category ID to assign to the transaction.
boolean
Whether this transaction represents a transfer.
boolean
Whether the transaction should be marked for review.
string
Cheque number associated with the transaction.
integer
required
Transaction-account ID returned by POCKETSMITH_LIST_TRANSACTION_ACCOUNTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_GET_BUDGETReturn 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

boolean
Whether parent-category actual and forecast totals should include child categories. Child categories still appear separately.
integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_GET_BUDGET_SUMMARYAnalyze a user’s combined income and expense budget, excluding transfer categories, over a required date range and period interval.

Input Parameters

string ("weeks" | "months" | "years" | "event")
required
Unit used to group the analysis; event works only when gathered budget events align.
integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.
string
required
End of the analysis range in YYYY-MM-DD format; PocketSmith may expand it to complete periods.
integer
required
Number of period units in each analysis bucket, such as 2 weeks for fortnightly results.
string
required
Start of the analysis range in YYYY-MM-DD format; PocketSmith may expand it to complete periods.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_GET_CURRENT_USERReturn the PocketSmith user authorized by the connected developer key, including the user ID needed by user-scoped tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_GET_TRANSACTIONReturn one PocketSmith transaction by ID with its amount, date, payee, category, labels, and review state.

Input Parameters

integer
required
ID of the transaction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_LIST_ACCOUNTSReturn all financial accounts belonging to a PocketSmith user, including account, primary transaction-account, and scenario IDs.

Input Parameters

integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_LIST_CATEGORIESReturn all categories belonging to a PocketSmith user, including hierarchy and budgeting flags.

Input Parameters

integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_LIST_TRANSACTION_ACCOUNTSReturn the transaction accounts belonging to a PocketSmith user, including IDs and balances needed to create and query transactions.

Input Parameters

integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_LIST_TRANSACTIONSReturn one page of a user’s transactions with optional date, state, type, and keyword filters, plus a cursor for the next page.

Input Parameters

Keyword matched against amount, account, payee, category, note, labels, and date.
integer
required
PocketSmith user ID returned by POCKETSMITH_GET_CURRENT_USER.
string
Latest transaction date, inclusive. Supply together with start_date.
integer
Maximum transactions in this page (10-1000).
string
Earliest transaction date, inclusive. Supply together with end_date.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
boolean
When true, return only transactions marked for review.
boolean
When true, return only uncategorized transactions.
string
Return only transactions updated since this ISO 8601 timestamp.
string ("debit" | "credit")
Return only debit or credit transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_UPDATE_ACCOUNTUpdate selected metadata on one financial account without deleting it or changing transaction-account balances.

Input Parameters

string
New account title.
integer
required
ID of the financial account to update, returned by POCKETSMITH_LIST_ACCOUNTS.
string ("bank" | "credits" | "cash" | "loans" | "mortgage" | "stocks" | "vehicle" | "property" | "insurance" | "other_asset" | "other_liability")
New PocketSmith account type.
boolean
Whether PocketSmith should include the account in net worth.
string
New PocketSmith currency code, such as USD or NZD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_UPDATE_CATEGORYUpdate selected hierarchy, display, and budgeting fields on one category without deleting it.

Input Parameters

string
New CSS hexadecimal color in #RRGGBB format.
string
New category title.
boolean
Whether this is a bill category.
boolean
Whether budget figures roll up into the parent category.
integer
required
ID of the category to update.
boolean
Whether this is a transfer category.
string ("debits_are_deductions" | "credits_are_refunds")
New refund treatment for this category.
integer
New parent category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_UPDATE_TRANSACTIONUpdate selected fields on one existing transaction without deleting or splitting it.

Input Parameters

string
New transaction date in YYYY-MM-DD format.
string
New transaction memo.
string
New detailed transaction note.
string
New payee or merchant.
number
New signed amount: positive for a credit and negative for a debit.
array
Replacement labels. Supply an empty list to remove all labels.
integer
New category ID for the transaction.
boolean
Whether this transaction represents a transfer.
boolean
Whether the transaction needs review.
string
New cheque number.
boolean
Set true to remove the transaction’s current category.
integer
required
ID of the transaction to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POCKETSMITH_UPDATE_TRANSACTIONSUpdate 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

array
required
Ordered updates for 1-20 distinct transactions. Each item is sent as a separate sequential PocketSmith request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not