github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-03-10 04:02:38 -05:00
Code Issues 250 Packages Projects Releases 53 Wiki Activity

[Docs] API documentation for splitting transactions #2528

New Issue
Open
opened 2026-02-28 20:17:11 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-02-28 20:17:11 -06:00
Owner
Copy Link

Originally created by @thromer on GitHub (Oct 8, 2025).

Verified issue does not already exist?

  • I have searched and found no existing issue

What happened?

The documentation for Split Transactions says

Subtransactions can specify the following fields, and amount is the only required field:
amount
category_id
notes

Also, the documentation for transaction immediately above says the subtransactions field is only available for get and create operations.

But empirically it is possible to split a transaction through the API. I found that in addition to amount I had to set account, date, parent_id, and is_child=true in each subtransaction; and set is_parent=true in the containing transaction.

There is at least one Discord discussion about this topic which I think reached the same conclusion.

Seems like just a doc change, unless there is some scenario where the docs as currently written are correct, or if this there is an imminent plan to add a different way to split transactions through the API. If someone can confirm I'd be happy to draft a PR. That would imply also documenting the parent_id, is_parent, and is_child fields. If there are concerns about API stability maybe mark it as experimental, but it is a pretty important use case (at least for me).

How can we reproduce the issue?

See above.

Where are you hosting Actual?

None

What browsers are you seeing the problem on?

No response

Operating System

None

Originally created by @thromer on GitHub (Oct 8, 2025). ### Verified issue does not already exist? - [x] I have searched and found no existing issue ### What happened? The documentation for [Split Transactions](https://actualbudget.org/docs/api/reference#split-transactions) says > Subtransactions can specify the following fields, and amount is the only required field: > `amount` > `category_id` > `notes` Also, the documentation for `transaction` immediately above says the `subtransactions` field is only available for get and create operations. But empirically it is possible to split a transaction through the API. I found that in addition to amount I had to set `account`, `date`, `parent_id`, and `is_child=true` in each subtransaction; and set `is_parent=true` in the containing transaction. There is at least [one Discord discussion](https://discord.com/channels/937901803608096828/1297859714536968266/1299142007821832303) about this topic which I think reached the same conclusion. Seems like just a doc change, unless there is some scenario where the docs as currently written are correct, or if this there is an imminent plan to add a different way to split transactions through the API. If someone can confirm I'd be happy to draft a PR. That would imply also documenting the `parent_id`, `is_parent`, and `is_child` fields. If there are concerns about API stability maybe mark it as experimental, but it is a pretty important use case (at least for me). ### How can we reproduce the issue? See above. ### Where are you hosting Actual? None ### What browsers are you seeing the problem on? _No response_ ### Operating System None
GiteaMirror added the documentation label 2026-02-28 20:17:11 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#2528
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?