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

A pipe represents how much money the user wants to come in or go out of a
bucket. In other words, it represents a flow of money from the tank to a bucket.

| Field     | Type   | Description                                              |
| --------- | ------ | -------------------------------------------------------- |
| id        | string |                                                          |
| amount    | number | The amount of money flowing through the pipe.            |
| period    | string | How long it takes for `amount` to flow through the pipe. |
| bucket_id | string | The ID of the bucket to which this pipe corresponds.     |

Constraints:

- `period` must be one of these options:
  - `day`
  - `week`
  - `month`
  - `year`

Sources: req-017, req-037