getTransaction — fetches a single transaction by ID.
Use with an AI agent
Export this page as Markdown or bundle it with a task for your agent.
Try a task
Preview the prompt that will be copied
Reference
Authentication: bearer token required (see how to get a token)
getTransaction — fetches a single transaction by ID.
The authenticated user must be the owner or a collaborator of the account the
transaction belongs to, or hold a PENDING or ACTIVE ownership share of it. A
household share grants access only while its holder and the payer are still
accepted members of a household together. Read access only — no role gate.
Account owners and collaborators get the full transaction (viewerRole PAYER).
A share holder gets the owner view instead (viewerRole OWNER): the name,
category, date, vendor, currency, their own share and the payer, but not the
account, the total amount, other owners' shares, Split With Others rows or the
bank payload. Receipts are included, with signed URLs, while the share is
ACTIVE.
Authentication: Required (Bearer token)
Parameters:
- transactionId (string, required): ID of the transaction to fetch
- includeExactAmount (boolean, optional): Include stored exact amounts, indexed secondary and split amounts, exact refund totals and summaries, and exactVersion when available.
Returns:
- viewerRole (string): PAYER or OWNER
- transaction (object): The transaction document, for PAYER
- ownerView (object): For OWNER, {id, name, category, categoryName?, currency,
transactedAt, vendor?, share, payer: {userId, displayName, avatarUrl?},
receipts: [{id, name, mimeType, url}]}
Errors:
- unauthenticated: No valid auth token provided
- permission_denied: User is not allowed to view this transaction
- invalid_params: transactionId missing, transaction not found, or account not found