summaryrefslogtreecommitdiff
path: root/requirements/data_models/dml-pipe.md
blob: a701ea33606ce300bf8984b526ded50312c4dae1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
# 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.     |

Source: req-017