Introduction
This hub centralizes Summit’s Canadian (excluding Quebec) property‑management system interface materials—field maps, saved‑report templates, and webhook event outlines—so property managers can align data flows with insurance workflows like COI compliance, incident intake, and renewals. For industry context, see Summit’s Property Management Insurance and our Claim Services.
Scope and assumptions
-
Platform focus: Yardi (Voyager/Breeze) and Buildium.
-
Data domains: property, unit, lease, tenant/occupant contacts, COI/insurance status, incidents.
-
Delivery patterns: bulk export/import, scheduled reports, and event webhooks.
-
Environment: production and sandbox; time is UTC unless otherwise specified.
-
Geography: Canada only, excluding Quebec.
-
Security and privacy: governed by Summit’s Privacy Policy. Do not transmit unnecessary personal information.
Resource index
| Resource | Purpose | Format | Availability | How to request |
|---|---|---|---|---|
| Yardi field map (Canada) | Normalizes core entities and attributes used for insurance/COI workflows across portfolios. | Spreadsheet/CSV data dictionary | Available on request | Contact Summit via Contact Us |
| Buildium saved‑report templates | Prebuilt saved‑report definitions to drive compliance and renewal tasks. | Saved‑report definitions + column specs | Available on request | Contact Summit via Contact Us |
| Webhook event schema outlines | Event attributes for lease, tenant, COI, and incident notifications. | JSON schema outline (documentation) | Available on request | Contact Summit via Contact Us |
Yardi field map (Canada)
What’s included
-
Entities: Property, Unit, Lease, Tenant/Occupant, Policy/Certificate, Incident.
-
Key data points (illustrative, vendor‑agnostic names):
-
Property identifier and address; Unit identifier; Portfolio tags.
-
Lease ID; lease start/end; status; occupants; responsible parties.
-
Tenant contact: legal name, email, phone; mailing address when applicable.
-
Insurance requirements: required/waived flag, liability limit requirement, additional‑insured requirement, effective/expiry dates.
-
COI tracking: carrier name, policy number, limits summary, additional insured confirmation, certificate file reference, review status, last verified date.
-
Incident basics: incident ID, location, date/time (ISO‑8601), description category, severity, attachments reference.
-
Conventions: stable unique IDs for cross‑system matching; ISO‑8601 datetimes; enumerations documented in the data dictionary; notes for portfolio‑level overrides.
Implementation notes
-
Data access: export or API depending on edition; principle of least privilege.
-
Matching: deterministic keys (Property+Unit+LeaseID) with fallbacks for merges/splits.
-
Refresh cadence: nightly full exports plus on‑demand deltas for urgent compliance tasks.
-
Data quality: required vs optional fields flagged; rejection criteria documented in the dictionary.
-
Privacy: only minimum personal data required; see Privacy Policy.
Buildium saved‑report templates (Canada)
Core templates
-
COI compliance—active leases: highlights leases missing valid certificates.
-
COI expirations—30/60/90 days: forward‑looking queue for renewals.
-
Move‑in/move‑out watchlist: triggers insurance checks around occupancy changes.
-
Incident log export: normalizes incident data for claims support.
Recommended columns (vendor‑agnostic names)
-
Property ID/Name; Unit; Lease ID; Tenant Name; Tenant Email; Lease Start/End; Lease Status.
-
Insurance Required (Y/N); Required Limit; Additional Insured (Y/N); Policy Number; Carrier; Effective/Expiry; COI Review Status; Last Verified.
-
Incident ID; Category; Open/Closed; Reported Date; Description Summary.
Export and delivery
-
Scheduling: daily/weekly to secure SFTP or approved email recipients.
-
File formats: CSV or XLSX with UTF‑8 encoding and header row.
-
Security: avoid sensitive notes where not needed; adhere to Privacy Policy.
Webhook event schema outlines
Event triggers (examples)
-
Lease created/updated/terminated.
-
Tenant contact created/updated.
-
COI uploaded, approved/rejected, or expiring.
-
Incident reported/updated/closed.
Payload composition (descriptive)
-
Envelope: event_type, event_id (UUID), occurred_at (ISO‑8601 UTC), source_system, version.
-
Context: organization_id, property_id, unit_identifier, lease_id, tenant_reference.
-
Insurance: requirement_flag, required_limit, additional_insured_required, status, effective_date, expiry_date, document_reference.
-
Links: document_url (if permitted), source_record_url (admin‑only).
-
Security: HMAC‑SHA256 signature header using shared secret; idempotency key for retries.
-
Delivery: HTTPS only, exponential backoff, dead‑letter procedures documented.
Accessing these materials
To receive the latest Canadian (excluding Quebec) Yardi field map, Buildium saved‑report templates, and webhook schema outlines, reach out via Contact Us. Include:
-
Company name and portfolio size (approx. units/doors).
-
PMS platform/edition (Yardi Voyager/Breeze, Buildium) and environment (prod/sandbox).
-
Preferred delivery method (secure link/SFTP) and primary technical contact email.