-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add more information about recentEnvelopes (#46)
- Loading branch information
1 parent
b10fef4
commit ef615b4
Showing
2 changed files
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: "Accounts" | ||
description: > | ||
This document describes Accounts in API version 2 | ||
--- | ||
|
||
## Recent Envelopes | ||
|
||
The `recentEnvelopes` field is a list of the 5 most common Envelopes that were used for the last 50 transactions where the account was the destination. | ||
The list is ordered by the frequency with the most common Envelope being the first one. If two Envelopes have been used the same amount of times, | ||
the one that was created **more recently** is first in the list. | ||
|
||
Income transactions are also counted in this list, with income appearing as the `null` value. | ||
|
||
Use this field to pre-fill the Envelope when creating transactions in a client. | ||
|
||
## Migrating from v1 | ||
|
||
- The `recentEnvelopes` field is now a list of IDs instead of a list envelope objects. Income is represented by `null` |