github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-07-15 22:54:03 -05:00
Code Issues 3.0k Packages Projects Releases 58 Wiki Activity

[PR #7593] [MERGED] Updated API Documentation for Splitting Transactions #69642

New Issue
Closed
opened 2026-05-14 04:31:36 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-14 04:31:36 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7593
Author: @rboadu
Created: 4/22/2026
Status: ✅ Merged
Merged: 4/29/2026
Merged by: @youngcw

Base: master ← Head: issue-6180

📝 Commits (10+)

  • e40b5d1 Updated API Documentation for Splitting Transactions
  • 6a4dba0 Update check-spelling metadata
  • 176dc17 Updated category name in example
  • 5e1f461 Update packages/docs/docs/api/reference.md
  • 49445e0 Fixed documentation to CodeRabbits feedback
  • 9bedc68 Merge branch 'master' into issue-6180
  • 3355f9d Update packages/docs/docs/api/reference.md
  • a530545 Updated wording of reference document
  • 81f6920 Merge branch 'master' into issue-6180
  • 759f985 Merge branch 'master' into issue-6180

📊 Changes

2 files changed (+59 additions, -5 deletions)

View changed files

📝 .github/actions/docs-spelling/expect.txt (+1 -3)
📝 packages/docs/docs/api/reference.md (+58 -2)

📄 Description

Description

This PR updates the Split Transactions API documentation to reflect actual behavior observed when creating and managing split transactions via the API.

The current docs state that subtransactions only require amount, but in practice they must satisfy full transaction constraints, including fields like account and date. Additionally, certain flags (is_parent, is_child, and parent_id) are required for split transactions to function correctly.

This PR:

  • Clarifies the required fields for subtransactions
  • Documents the need to set is_parent: true on the parent transaction before adding subtransactions
  • Explains that subtransactions behave as full transaction records, not lightweight objects
  • Adds a working example payload demonstrating correct usage
  • Notes limitations around updating subtransactions individually

These changes improve developer experience and reduce confusion when working with split transactions via the API.

Related issue(s)

Fixes #6180

Testing

  • Verified behavior by creating split transactions via the API using the documented fields (account, date, parent_id, is_child, is_parent)
  • Confirmed that omitting fields like account or date results in validation errors
  • Tested that is_parent: true must be set on the parent transaction before subtransactions are properly recognized
  • Confirmed that updating subtransactions individually leads to inconsistent behavior, supporting the added documentation note
  • Ensured the provided example payload reflects a working configuration

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7593 **Author:** [@rboadu](https://github.com/rboadu) **Created:** 4/22/2026 **Status:** ✅ Merged **Merged:** 4/29/2026 **Merged by:** [@youngcw](https://github.com/youngcw) **Base:** `master` ← **Head:** `issue-6180` --- ### 📝 Commits (10+) - [`e40b5d1`](https://github.com/actualbudget/actual/commit/e40b5d1377e91441ffde9c767f0b82642f154b2b) Updated API Documentation for Splitting Transactions - [`6a4dba0`](https://github.com/actualbudget/actual/commit/6a4dba024dd8e07da8b71ed959b19d6c0fd07ea4) Update check-spelling metadata - [`176dc17`](https://github.com/actualbudget/actual/commit/176dc178d197c6b40f56d3522f3436ae3ebe6974) Updated category name in example - [`5e1f461`](https://github.com/actualbudget/actual/commit/5e1f461770c89a17829c9171f473227fcdfb40d0) Update packages/docs/docs/api/reference.md - [`49445e0`](https://github.com/actualbudget/actual/commit/49445e0da8ffc9af43cde96b5501a6f5ae5245e0) Fixed documentation to CodeRabbits feedback - [`9bedc68`](https://github.com/actualbudget/actual/commit/9bedc687cc1d7cb72e8297c8ee6f8b1a3128f61d) Merge branch 'master' into issue-6180 - [`3355f9d`](https://github.com/actualbudget/actual/commit/3355f9d715fd17909955db3f93b5a821164fe0a0) Update packages/docs/docs/api/reference.md - [`a530545`](https://github.com/actualbudget/actual/commit/a5305459dd07699ce5091bae8b318cbcfd66349a) Updated wording of reference document - [`81f6920`](https://github.com/actualbudget/actual/commit/81f6920ad49f05c6130b2802adc17d6926ca92b7) Merge branch 'master' into issue-6180 - [`759f985`](https://github.com/actualbudget/actual/commit/759f98504d6b58041451c2a5b4e218e8eeda337b) Merge branch 'master' into issue-6180 ### 📊 Changes **2 files changed** (+59 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `.github/actions/docs-spelling/expect.txt` (+1 -3) 📝 `packages/docs/docs/api/reference.md` (+58 -2) </details> ### 📄 Description <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description <!-- What does this PR do? Why is it needed? Please give context on the "why?": why do we need this change? What problem is it solving for you?--> This PR updates the Split Transactions API documentation to reflect actual behavior observed when creating and managing split transactions via the API. The current docs state that subtransactions only require `amount`, but in practice they must satisfy full transaction constraints, including fields like `account` and `date`. Additionally, certain flags (`is_parent`, `is_child`, and `parent_id`) are required for split transactions to function correctly. This PR: - Clarifies the required fields for subtransactions - Documents the need to set `is_parent: true` on the parent transaction before adding subtransactions - Explains that subtransactions behave as full transaction records, not lightweight objects - Adds a working example payload demonstrating correct usage - Notes limitations around updating subtransactions individually These changes improve developer experience and reduce confusion when working with split transactions via the API. ## Related issue(s) <!-- e.g. Fixes #123, Relates to #456 --> Fixes #6180 ## Testing <!-- What did you test? How can we reproduce the issue you are fixing or how can we test the feature you built? --> - Verified behavior by creating split transactions via the API using the documented fields (`account`, `date`, `parent_id`, `is_child`, `is_parent`) - Confirmed that omitting fields like `account` or `date` results in validation errors - Tested that `is_parent: true` must be set on the parent transaction before subtransactions are properly recognized - Confirmed that updating subtransactions individually leads to inconsistent behavior, supporting the added documentation note - Ensured the provided example payload reflects a working configuration ## Checklist - [x] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-05-14 04:31:36 -05: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
tech-support
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
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#69642
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?