Getting started
Introduction
Coming soonWhat the Propvara API is, what's available today and what's coming.
The Propvara API lets you read and write the same records you see in the app: properties, units, tenancies, charges, payments, expenses, cases and short-term stays. It's a JSON REST API over HTTPS, versioned in the URL.
Base URL
All REST endpoints live under https://api.propvara.com/v1. Calendar feeds live on https://www.propvara.com/api/ical/.
Design principles
- Same permissions as the app. An API key acts as a workspace member and can never see more than that member could in the app. Mortgages stay owner-only; tenants never see owner financials.
- Money in integer cents. Every amount is an integer in cents with a
currencyfield (CAD by default). No floating-point rounding surprises. - Financial records are void-only. You can void a payment or expense with a reason, but not delete it. Voids appear in the audit log.
- Dates are ISO 8601. Calendar dates are
YYYY-MM-DD; timestamps are UTC with aZsuffix. - IDs are UUIDs prefixed by nothing. Store them as strings.
What you can build
- Sync tenancies and rent charges with your accounting system
- Push payments from your payment processor into tenant ledgers
- Create repair cases from a building sensor or call-centre system
- Pull rent rolls into an investor reporting dashboard
- Mirror short-term stays into a cleaning schedule app