summaryrefslogtreecommitdiff
path: root/requirements/data_models/dml-bucket.md
blob: dc7749beadd0c0800023993b639f599ca3d2d841 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# dml-bucket

A bucket represents a real category of spending, like beer or holidays.

| Field             | Type   | Description                                               |
| ----------------- | ------ | --------------------------------------------------------- |
| id                | string | A unique identifier for the bucket.                       |
| name              | string | A short description of the real category of spending.     |
| balance           | number | The amount of money the user intends to be free to spend. |
| balance_cache_key | string | A cache key for the balance. See notes.                   |

Constraints:

- `name` must be unique.
- `id` must be equal to `name`, that is, `id` is an alias of the property, `name`.

Notes:

- `balance_cache_key` must be of the format: `<drip_id>:<transaction_id>`.

Sources: req-027, req-098, req-110, req-111