From d9c23eec7ed63dfb9de266b1c8d2a2d3c8adb74a Mon Sep 17 00:00:00 2001 From: DJ Mountney Date: Thu, 23 Nov 2023 10:55:06 -0800 Subject: [PATCH] API update learnCategory,runTransfers for addTransactions To match changes from https://github.com/actualbudget/actual/pull/1944 --- docs/api/reference.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/api/reference.md b/docs/api/reference.md index e2985ab09..e6cab0eca 100644 --- a/docs/api/reference.md +++ b/docs/api/reference.md @@ -134,13 +134,18 @@ If you want to create a transfer, use the transfer payee for the account you wis #### `addTransactions` - + 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`