Please add `pot_account_id` to the structure returned by the `/pots` endpoint
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 116
- Forks
- 51
- Avg merge
- 1h 25m
- Merged PRs (30d)
- 1
Description
The /pots endpoint exposes a pot_id as id (e.g,. pot_xxxxx), and current_account_id, which is the account in which the pot resides. But you can't use this id in the /transactions endpoint, to get (for instance) the transactions for the interest earned.
However, if you can find a transaction to the main account to or from that pot, the metadata of that transaction will have both a pot_id and a pot_account_id, the latter of which looks like a normal account number (e.g,. acc_xxxxx). This value can be put into the /transactions field to get transactions on the pot (including the interest transactions).
Please add the pot_account_id to the structure returned by the /pots endpoint, so that users of the API can reliably programmatically get all the transactions for an account, including interest from savings pots.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for the /pots endpoint and its returned structure, then compare it with the pot metadata described for /transactions. Done means the response documents pot_account_id and explains that it can be used to retrieve transactions for the pot, including interest transactions.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100