Skip to content

Enable Properties for a client

Properties is opt-in per client. Nothing happens for clients who don’t have it enabled — no sidebar entries, no crons running, no accounts created. The whole sub-module is gated behind a single client-level feature flag.

This guide walks through enabling it for a new client end-to-end.

1 — Flip the feature flag

  1. Open the client from the Books list.
  2. Go to Settings → Client settings inside the client’s Books file.
  3. Under Optional modules, toggle Properties on.
  4. Click Save.

Internally this writes client.features.propertiesEnabled = true. The crons (rent invoice generator, rent-change applier, escalation applier, depreciation) all filter on this flag — a client who opts out never has these jobs running against their data.

2 — Run the COA wizard

Properties needs 12 specific chart-of-accounts entries to post into (rent income, tenant deposits held, mortgage interest, depreciation, and so on). The wizard creates them in one click.

  1. Navigate to Settings → Books → Property account defaults.
  2. Review the suggested accounts and numbers. If the client already uses different account numbers, override them inline.
  3. Click Seed missing. Any accounts not already present are created with the suggested numbers + names.
  4. Click Save defaults. The workspace-level propertyAccountDefaults map is written.

See the COA Wizard reference for the full list of accounts and which flow reads each one.

3 — Create the first property

  1. Click Properties in the Books sidebar. The empty-state list appears.
  2. Click Add property.
  3. Enter a Name (e.g. “100 Main St”), Type (residential / commercial / mixed), Status (Construction for new builds, Operating for existing rentals), and the property address.
  4. For a new build, check Track as Construction — all tagged costs will accumulate in WIP until you convert the property to operating.
  5. Click Save. The property detail page opens.

4 — Add units, tenants, and leases

For multi-unit properties, add Units first from the Property detail Overview → Units subsection. Single-unit properties can skip Units entirely and tag directly to the Property.

With Units in place:

  1. Go to Tenants in the sidebar and click Add tenant to create each renter. A shadow Customer is created automatically.
  2. Back on the Property (or Unit) detail, click Add lease. Pick the tenant, term, base rent, frequency, and (optional) escalations.
  3. Save. The RentSchedule is materialised immediately — the rows will turn into invoices on the 1st of each month.

5 — Verify the rent invoice generator

On the 1st of the next month the cron generates draft invoices. To confirm the plumbing is working before that:

  1. Open a Lease detail.
  2. Go to the Rent Schedule tab.
  3. Click Generate next invoice. An invoice draft is created from the next pending row.
  4. Check the invoice carries the property, unit, and lease tags. For residential leases, confirm HST is zero.

If anything fails with a “default not configured” error, go back to the COA wizard and fill the missing slot.

Rolling back

Disabling Properties on the client (toggle off) stops the crons immediately. Existing data is preserved — properties, leases, rent history, attachments remain readable; the sidebar entries disappear. You can re-enable later and nothing is lost.