github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-03-11 12:43:09 -05:00
Code Issues 250 Packages Projects Releases 53 Wiki Activity

API update learnCategory,runTransfers for addTransactions (#280)

Browse Source 
To match changes from https://github.com/actualbudget/actual/pull/1944
This commit is contained in:
DJ Mountney
2023-11-26 10:17:22 -08:00
committed by GitHub
parent a7e862acbb
commit f1dccec274
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api/reference.md
View File

@@ -134,13 +134,18 @@ If you want to create a transfer, use the transfer payee for the account you wis
#### `addTransactions`
<Method name="addTransactions" args={[{ name: 'accountId', type: 'id'}, { name: 'transactions', type: 'Transaction[]'}]} returns="Promise<id[]>" />
<Method name="addTransactions" args={[{ name: 'accountId', type: 'id'}, { name: 'transactions', type: 'Transaction[]'}, { name: 'runTransfers = false', type: 'bool?'}, { name: 'learnCategories = false', type: 'bool?'}]} returns="Promise<id[]>" />
Adds multiple transactions at once. Does not reconcile (see `importTransactions`). Returns an array of ids of the newly created transactions.
If a transfer payee is given, this method does **not** create a transfer. Use `importTransactions` if you want to create transfers.
This method does **not** avoid duplicates. Use `importTransactions` if you want the full reconcile behavior.
You probably want to use `importTransactions`. This method is mainly for custom importers that want to skip all the automatic stuff because it wants to create raw data.
This method has the following optional flags:
- `runTransfers`: create transfers for transactions where transfer payee is given (defaults to false)
- `learnCategories`: update Rules based on the category field in the transactions (defaults to false)
This method is mainly for custom importers that want to skip all the automatic stuff because it wants to create raw data. You probably want to use `importTransactions`.
#### `importTransactions`