Skip to content

Commit

Permalink
Add getAccountBalance() API documentation (#403)
Browse files Browse the repository at this point in the history
  • Loading branch information
psybers authored Jul 12, 2024
1 parent c5c5d55 commit ba2f767
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/api/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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={[
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ba2f767

Please sign in to comment.