mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-11 20:44:32 -05:00
Add getAccountBalance() API documentation (#403)
Docs for https://github.com/actualbudget/actual/pull/2930.
This commit is contained in:
@@ -30,7 +30,8 @@ This is the documentation of all available API methods. The API has not been rel
|
||||
"updateAccount",
|
||||
"closeAccount",
|
||||
"reopenAccount",
|
||||
"deleteAccount"
|
||||
"deleteAccount",
|
||||
"getAccountBalance"
|
||||
]} />
|
||||
|
||||
<APIList title="Categories" sections={[
|
||||
@@ -306,6 +307,12 @@ Reopen a closed account.
|
||||
|
||||
Delete an account.
|
||||
|
||||
#### `getAccountBalance`
|
||||
|
||||
<Method name="getAccountBalance" args={[{ name: 'id', type: 'id' }, { name: 'cutoff', type: 'Date?'}]} returns="Promise<number>" />
|
||||
|
||||
Gets the balance for an account. If a cutoff is given, it gives the account balance as of that date. If no cutoff is given, it uses the current date as the cutoff.
|
||||
|
||||
#### Examples
|
||||
|
||||
```js
|
||||
|
||||
Reference in New Issue
Block a user