# Money

> Budgets, audited financial statements and their lines, published fees, and open bids and tenders.

Audited financial statements, read into lines. A statement is published only when its sums tie. Amounts are given as printed and in cents.

## Budgets

Budget and financial statement documents as a government publishes them, with their links. They are documents, not budget data: the statement lines below are the audited numbers.

### `GET /v1/budgets`

**List budgets and financial statements.** Budget and financial statement DOCUMENTS a government publishes (kind budget or financial_statement), with their links: documents, not budget data. The audited statements read into lines are GET /v1/financial-lines. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

[Reference and playground for list budgets and financial statements](https://data.heytownhall.com/docs/reference/money/get-v1-budgets)

| Parameter      | What it takes                                                            |
| -------------- | ------------------------------------------------------------------------ |
| `jurisdiction` | A jurisdiction id.                                                       |
| `region`       | A two-letter province or state code.                                     |
| `country`      | CA or US.                                                                |
| `kind`         | budget or financial_statement.                                           |
| `from`         | On or after this date (YYYY-MM-DD).                                      |
| `to`           | On or before this date (YYYY-MM-DD).                                     |
| `since`        | Records read at or after this instant: what is new since your last read. |

Pages with `limit` and `cursor` ([pagination](https://data.heytownhall.com/docs/pagination)).

| Field             | Type           | What it holds                                                                 |
| ----------------- | -------------- | ----------------------------------------------------------------------------- |
| `id`              | string         |                                                                               |
| `jurisdiction_id` | string         |                                                                               |
| `country`         | string or null |                                                                               |
| `region`          | string or null |                                                                               |
| `kind`            | string or null | staff_report, budget, plan, bylaw, agenda, minutes, notice, map, form, other. |
| `title`           | string or null |                                                                               |
| `bylaw_number`    | string or null |                                                                               |
| `dated_on`        | string or null | YYYY-MM-DD.                                                                   |
| `text_available`  | boolean        |                                                                               |
| `last_changed_at` | string or null | ISO 8601 instant, UTC.                                                        |
| `source_url`      | string or null | The page, document, video or platform the record was read from.               |
| `read_at`         | string or null | When it was read.                                                             |

## Financial statements

### `GET /v1/financial-reports`

**List financial statements.** Audited financial statements read into lines, each statement published only when its sums tie. Billed as one records request a page. Filters: jurisdiction, region, country, since.

[Reference and playground for list financial statements](https://data.heytownhall.com/docs/reference/money/get-v1-financial-reports)

| Parameter      | What it takes                                                            |
| -------------- | ------------------------------------------------------------------------ |
| `jurisdiction` | A jurisdiction id.                                                       |
| `region`       | A two-letter province or state code.                                     |
| `country`      | CA or US.                                                                |
| `since`        | Records read at or after this instant: what is new since your last read. |

Pages with `limit` and `cursor` ([pagination](https://data.heytownhall.com/docs/pagination)).

| Field             | Type           | What it holds                                                   |
| ----------------- | -------------- | --------------------------------------------------------------- |
| `id`              | string         |                                                                 |
| `jurisdiction_id` | string         |                                                                 |
| `country`         | string or null |                                                                 |
| `region`          | string or null |                                                                 |
| `fiscal_year`     | number         |                                                                 |
| `approved_on`     | string or null | YYYY-MM-DD.                                                     |
| `auditor`         | string or null |                                                                 |
| `page_count`      | number or null |                                                                 |
| `title`           | string or null |                                                                 |
| `source_url`      | string or null | The page, document, video or platform the record was read from. |
| `read_at`         | string or null | When it was read.                                               |

## Statement lines

Pass a statement's id as `report` to read its lines.

### `GET /v1/financial-lines`

**List financial statement lines.** The lines of a statement, as printed and in cents. Never an employee by name. Billed as one records request a page. Filters: jurisdiction, kind, since, report.

[Reference and playground for list financial statement lines](https://data.heytownhall.com/docs/reference/money/get-v1-financial-lines)

| Parameter      | What it takes                                                            |
| -------------- | ------------------------------------------------------------------------ |
| `jurisdiction` | A jurisdiction id.                                                       |
| `kind`         | The statement, such as statement_of_operations.                          |
| `since`        | Records read at or after this instant: what is new since your last read. |
| `report`       | A financial report id.                                                   |

Pages with `limit` and `cursor` ([pagination](https://data.heytownhall.com/docs/pagination)).

| Field             | Type           | What it holds                                                   |
| ----------------- | -------------- | --------------------------------------------------------------- |
| `id`              | string         |                                                                 |
| `report_id`       | string         |                                                                 |
| `jurisdiction_id` | string         |                                                                 |
| `fiscal_year`     | number         |                                                                 |
| `statement`       | string         |                                                                 |
| `seq`             | number         |                                                                 |
| `col`             | number         |                                                                 |
| `part`            | string or null |                                                                 |
| `section`         | string or null |                                                                 |
| `label`           | string or null |                                                                 |
| `label_plain`     | string or null |                                                                 |
| `detail`          | string or null |                                                                 |
| `heading`         | string or null |                                                                 |
| `role`            | string or null |                                                                 |
| `printed`         | string or null | The figure as printed.                                          |
| `amount_cents`    | number or null |                                                                 |
| `page_printed`    | number or null |                                                                 |
| `source_url`      | string or null | The page, document, video or platform the record was read from. |
| `read_at`         | string or null | When it was read.                                               |

## Fees

Each fee row a permit's fee page prints, the label and amount as printed, never parsed. A government's whole fees and charges schedule is a bylaw: see [Laws](https://data.heytownhall.com/docs/records/laws).

### `GET /v1/fees`

**List published fees.** Each fee row a permit's fee page prints, label and amount as printed. A body's full fees and charges schedule is a bylaw (GET /v1/bylaws?subject=fees_charges); its rows are in the bylaw's text, not here. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

[Reference and playground for list published fees](https://data.heytownhall.com/docs/reference/land-use/get-v1-fees)

| Parameter      | What it takes                                                            |
| -------------- | ------------------------------------------------------------------------ |
| `jurisdiction` | A jurisdiction id.                                                       |
| `region`       | A two-letter province or state code.                                     |
| `country`      | CA or US.                                                                |
| `kind`         | The permit kind whose fee page prints the row, such as building.         |
| `since`        | Records read at or after this instant: what is new since your last read. |

Pages with `limit` and `cursor` ([pagination](https://data.heytownhall.com/docs/pagination)).

| Field              | Type           | What it holds                                                   |
| ------------------ | -------------- | --------------------------------------------------------------- |
| `id`               | string         |                                                                 |
| `jurisdiction_id`  | string         |                                                                 |
| `country`          | string or null |                                                                 |
| `region`           | string or null |                                                                 |
| `permit_kind`      | string         |                                                                 |
| `position`         | number         |                                                                 |
| `label`            | string or null | The row as the fee page prints it.                              |
| `amount_printed`   | string or null | The amount as printed, never parsed or summed.                  |
| `fee_heading`      | string or null |                                                                 |
| `fee_bylaw_number` | string or null | The fees bylaw the page names, when it names one.               |
| `source_url`       | string or null | The page, document, video or platform the record was read from. |
| `read_at`          | string or null | When it was read.                                               |

## Bids and tenders

### `GET /v1/bids`

**List open bids and tenders.** Open requests for proposals, tenders and quotes, with their closing time. Billed as one records request a page. Filters: jurisdiction, region, country, from, to, since.

[Reference and playground for list open bids and tenders](https://data.heytownhall.com/docs/reference/posts/get-v1-bids)

| Parameter      | What it takes                                                            |
| -------------- | ------------------------------------------------------------------------ |
| `jurisdiction` | A jurisdiction id.                                                       |
| `region`       | A two-letter province or state code.                                     |
| `country`      | CA or US.                                                                |
| `from`         | On or after this date (YYYY-MM-DD).                                      |
| `to`           | On or before this date (YYYY-MM-DD).                                     |
| `since`        | Records read at or after this instant: what is new since your last read. |

Pages with `limit` and `cursor` ([pagination](https://data.heytownhall.com/docs/pagination)).

| Field             | Type                    | What it holds                                                   |
| ----------------- | ----------------------- | --------------------------------------------------------------- |
| `id`              | string                  |                                                                 |
| `jurisdiction_id` | string                  |                                                                 |
| `country`         | string or null          |                                                                 |
| `region`          | string or null          |                                                                 |
| `title`           | string                  |                                                                 |
| `summary`         | string or null          |                                                                 |
| `published_at`    | string or null          | ISO 8601 instant, UTC.                                          |
| `closes_at`       | string or null          | ISO 8601 instant, UTC.                                          |
| `categories`      | array of string or null |                                                                 |
| `first_seen_at`   | string                  | ISO 8601 instant, UTC.                                          |
| `source_url`      | string or null          | The page, document, video or platform the record was read from. |
| `read_at`         | string or null          | When it was read.                                               |