---
title: "One lease dossier"
method: GET
path: "/api/v1/leases/{id}"
tags: ["Leases"]
---

# One lease dossier

`GET /api/v1/leases/{id}`

## Request

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

The lease and everything hanging off it: its unit and building, its tenants, its invoices, its deposit and any open arrears case.

## Path parameters

- `id` string, required

## Response `200`

The dossier.

- object
  - `ok` unknown, required
  - `data` object, required
    - `lease` object, required
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `reference` string, required
      - `parties` object[], required: Everyone the tenancy names. Absent is refused: every read resolves a tenant through it.
        - `contactId` string, required: Stable record id, e.g. `lse_012`.
        - `role` 'tenant' | 'co_tenant' | 'guarantor' | 'occupant', required
        - `jointlyLiable` boolean, required
        - `sharePct` number: A decimal ratio. 0.21 is 21%.
      - `custom` object
      - `unitId` string, required: Stable record id, e.g. `lse_012`.
      - `extraUnits` object[]: Further units let under this lease, a parking space or a cellar. `rent` is each one’s own part of the lease’s rent; absent comes with the main unit.
        - `unitId` string, required: Stable record id, e.g. `lse_012`.
        - `rent` integer: Money, always in integer cents. €1,250.00 is 125000.
      - `type` string, required
      - `status` 'draft' | 'pending_signature' | 'active' | 'notice_given' | 'ended' | 'terminated_early' | 'cancelled', required
      - `startDate` string, required: A calendar date, `YYYY-MM-DD`.
      - `endDate` string, nullable, required: A calendar date, `YYYY-MM-DD`.
      - `signedOn` string: The day the lease was signed, when it was signed outside the product.
      - `signedByOwnerAt` string: When the owner signed it in the product, which is the last signature a lease signed here takes.
      - `rent` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `rentFrequency` string, required
      - `rentDueDay` number, required: Day of the month rent falls due.
      - `chargesProvision` integer, required: Monthly provision for service charges, settled annually.
      - `currency` string, required
    - `unit` object
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `buildingId` string, required: Stable record id, e.g. `lse_012`.
      - `label` string, required: Unique within its building: "3A", "Ground floor", "Parking 12".
      - `kind` string, required
      - `mode` string, required
      - `status` string, required
      - `furnished` boolean, required
      - `marketRent` integer: Market rent estimate. Drives vacancy-cost and yield maths.
      - `custom` object
    - `building` object
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `teamId` string, required: Stable record id, e.g. `lse_012`.
      - `name` string, required: The address. Stays the address so search and paperwork still match.
      - `alias` string: What the owner calls it. Shown instead of `name` wherever one is set.
      - `coverDocumentId` string: The photo pinned as its picture. Absent, the newest photo filed against it is shown.
      - `kind` string, required
      - `jurisdictionId` string, required: Jurisdiction pack id: `be-fl`, `be-bru`, `nl`, `fr`, `generic`.
      - `custom` object
    - `tenants` object[], required
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `kind` string, required
      - `firstName` string, required
      - `lastName` string, required
      - `companyName` string
      - `email` string
      - `phone` string
      - `language` string, required
    - `invoices` object[], required
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `number` string, required
      - `leaseId` string: Stable record id, e.g. `lse_012`.
      - `contactId` string, required: Stable record id, e.g. `lse_012`.
      - `teamId` string, required: Stable record id, e.g. `lse_012`.
      - `kind` string, required
      - `status` string, required
      - `issueDate` string, required: A calendar date, `YYYY-MM-DD`.
      - `dueDate` string, required: A calendar date, `YYYY-MM-DD`.
      - `subtotal` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `vatTotal` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `total` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `paidAmount` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `structuredRef` string: Belgian-style structured reference, the key to automatic reconciliation.
      - `currency` string, required
    - `deposits` object[], required
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `leaseId` string, required: Stable record id, e.g. `lse_012`.
      - `amount` integer, required: Money, always in integer cents. €1,250.00 is 125000.
      - `months` number: Expressed as months of rent, for the statutory cap check.
      - `form` string, required
      - `status` 'awaiting' | 'held' | 'partially_released' | 'released' | 'disputed', required
      - `receivedOn` string: A calendar date, `YYYY-MM-DD`.
      - `lodgedOn` string: When it reached the scheme, the public body or the blocked account the law names.
      - `releasedOn` string: A calendar date, `YYYY-MM-DD`.
    - `arrears` object, nullable, required: The case still being chased, or null. A case that was resolved or closed is not this lease’s arrears any more.
      - `id` string, required: Stable record id, e.g. `lse_012`.
      - `leaseId` string, required: Stable record id, e.g. `lse_012`.
      - `contactId` string, required: Stable record id, e.g. `lse_012`.
      - `openedOn` string, required: A calendar date, `YYYY-MM-DD`.
      - `stage` string, required: How far dunning has gone. `none` and `resolved` are not counted as open.
      - `balance` integer, required: Total outstanding across all overdue invoices, recomputed on read.
      - `oldestDueDate` string, required: A calendar date, `YYYY-MM-DD`.
      - `daysOverdue` number, required
      - `invoiceIds` string[], required
      - `snoozedUntil` string: Pauses automation, e.g. after a payment promise.
      - `closedOn` string: A calendar date, `YYYY-MM-DD`.
  - `meta` object, required
    - `requestId` string, required: Echoed in the x-request-id header. Quote it in a bug report.

## Other responses

- `404`: No lease with that id belongs to you.

---

[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)