Skip to content

A local-first personal finance app

:sparkles: (api) ability to run bank sync via the API (#350)

Matiss Janis Aboltins7360e35ace6f
diff --git a/docs/api/reference.md b/docs/api/reference.md
index 8f583e9ce5..b855c41f5c 100644
--- a/docs/api/reference.md
+++ b/docs/api/reference.md
@@ -51,6 +51,10 @@ This is the documentation of all available API methods. The API has not been rel
"deletePayee"
]} />
+<APIList title="Misc" sections={[
+"runBankSync"
+]} />
+
## Types of methods
API methods are categorized into one of four types:
@@ -426,3 +430,13 @@ Update fields of a payee. `fields` can specify any field described in [`Payee`](
<Method name="deletePayee" args={[{ name: 'id', type: 'id' }]} returns="Promise<null>" />
Delete a payee.
+
+## Misc
+
+#### Methods
+
+#### `runBankSync`
+
+<Method name="runBankSync" args={[{ properties: [{ name: 'accountId', type: 'string' }] }]} returns="Promise<void>" />
+
+Run the 3rd party (gocardless, simplefin) bank sync operation. This will download the transactions and insert them into the ledger.