---
title: "Reports produced and notices served"
method: GET
path: "/api/v1/notices"
tags: ["Files"]
---

# Reports produced and notices served

`GET /api/v1/notices`

## Request

- Base URL: `http://localhost:5180`
- URL: `http://localhost:5180/api/v1/notices`
- Auth: API key in cookie `better-auth.session_token`

What the product put in writing on the owner behalf. Reports carry the period they cover and what they were scoped to, an empty scope meaning the whole portfolio. The documents beside them are the three kinds that have legal weight when they are sent, so each one is worth being able to point at later.

## Response `200`

Reports and served notices.

- object
  - `ok` unknown, required
  - `data` object, required
    - `reports` object[], required: Statements and reports produced, newest first, with the recurring schedule where one is set.
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `kind` string, required: `owner_statement`, `rent_roll`, `profit_loss`, `tax_pack` and the rest.
      - `name` string, required
      - `periodStart` string, required: A calendar date, `YYYY-MM-DD`.
      - `periodEnd` string, required: A calendar date, `YYYY-MM-DD`.
      - `scope` object, required: What the report covers. An empty scope means the whole portfolio.
        - `teamIds` string[]
        - `buildingIds` string[]
        - `unitIds` string[]
      - `generatedAt` string, required: ISO 8601 timestamp.
      - `documentId` string: Stable record id, e.g. `lse_012`.
      - `schedule` object: Set when the report is delivered on a recurring basis.
        - `frequency` 'monthly' | 'quarterly' | 'yearly', required
        - `recipients` string[], required
        - `nextRunOn` string, required: A calendar date, `YYYY-MM-DD`.
      - `provenance` object, required
        - `actor` object, required
          - `kind` 'owner' | 'ai' | 'tenant' | 'contractor' | 'system' | 'channel', required: `ai` is Dardaris acting on the owner’s behalf. Everything it touches is marked.
          - `id` string: Stable record id, e.g. `lse_012`.
          - `name` string, required
        - `at` string, required: ISO 8601 timestamp.
        - `workflowRunId` string: Set when an automated run produced this, linking the record back to the run.
        - `reasoning` string: The rationale the AI recorded at the moment it acted.
    - `documents` object[], required: The served paper: formal notices, lease terminations and receipts.
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `name` string, required
      - `kind` string, required: `lease`, `invoice`, `certificate`, `inspection_report` and the rest. This is the product’s own filing.
      - `mimeType` string, required
      - `size` number, required: Bytes.
      - `createdAt` string, required: ISO 8601 timestamp.
      - `links` object[], required: Every place the document is shown. A document can hang off any record, and off more than one; `folderId` is the folder that place files it in.
        - `kind` string, required
        - `id` string, required: Stable record id, e.g. `lse_012`.
        - `folderId` string: Stable record id, e.g. `lse_012`.
      - `expiresOn` string: Set on anything that expires, which is what feeds the compliance calendar.
      - `generated` boolean, required: True when the AI produced it rather than the owner uploading it.
      - `templateId` string: Stable record id, e.g. `lse_012`.
      - `language` 'en' | 'nl' | 'fr' | 'de': One of the four the product itself authors wording in: the clause library, the seeded messages, the words on a notice.
      - `folderId` string: No longer written. The folder is kept per place, on each of `links`.
      - `tags` string[], required
      - `status` 'withdrawn': `withdrawn` on a generated letter filed for a case that has since closed paid. Absent means the document stands.
      - `provenance` object, required
        - `actor` object, required
          - `kind` 'owner' | 'ai' | 'tenant' | 'contractor' | 'system' | 'channel', required: `ai` is Dardaris acting on the owner’s behalf. Everything it touches is marked.
          - `id` string: Stable record id, e.g. `lse_012`.
          - `name` string, required
        - `at` string, required: ISO 8601 timestamp.
        - `workflowRunId` string: Set when an automated run produced this, linking the record back to the run.
        - `reasoning` string: The rationale the AI recorded at the moment it acted.
  - `meta` object, required
    - `requestId` string, required: Echoed in the x-request-id header. Quote it in a bug report.

---

[API](https://skmtc.dev/dardaris/apis/dardaris-api.md) · [All operations](https://skmtc.dev/dardaris/apis/dardaris-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dardaris/apis/dardaris-api/revisions/4aff33835c73?raw)