Getting Started
Introduction to VRPlatform API concepts and architecture
Getting Started with VRPlatform
VRPlatform is a comprehensive property management and accounting platform designed for vacation rental businesses. This knowledge base explains the core concepts you'll encounter when integrating with our API.
Platform Overview
VRPlatform helps property managers and owners track:
- Properties (Listings) and their ownership
- Reservations from booking channels
- Financial transactions (deposits, expenses, payouts)
- Recurring fees like management fees
- Owner statements for transparent reporting
What Makes VRPlatform Powerful
Double-Entry Accounting
Every financial transaction creates balanced journal entries automatically. When you record a $1,000 guest payment:
- Debit: Bank Account +$1,000
- Credit: Accounts Receivable -$1,000
This ensures your books always balance and provides a complete audit trail. You work with simple transactions - we handle the accounting complexity behind the scenes.
Pro-Rata Revenue Recognition
Revenue can be distributed precisely across stay nights. A 5-night reservation doesn't have to post all revenue on check-in - it can spread evenly across each night. This is essential for:
- Accurate monthly statements when stays span month boundaries
- Correct attribution when property ownership changes mid-stay
- Compliance with accrual accounting standards
Formula-Based Fee Calculations
Recurring fees support sophisticated calculations:
Management Fee = 20% of (rent + cleaning - discount)Fees reference specific accounts and can build on each other. Configure once, and every reservation calculates automatically.
Trust Account Reconciliation
Track owner funds with precision. The platform maintains expected balances per owner and per property, so you can reconcile your trust account and identify discrepancies instantly.
Multi-Currency Support
Each listing operates in its own currency. The platform handles currency-specific formatting and keeps financial data clean across mixed portfolios.
Real-Time Balance Tracking
Every reservation, transaction, and fee updates account balances immediately. Owner statements reflect current data, and you always know exactly what's owed to whom.
Automatic Issue Detection
The platform continuously validates your data:
- Unbalanced entries are flagged immediately
- Missing account mappings surface as errors
- Payment mismatches appear as warnings
Issues appear in API responses so integrations can handle them gracefully.
Core Entities
Listings
Properties available for rent. Each listing can have multiple ownership periods defining who owns it and when.
Reservations
Guest bookings synced from your booking channels. Reservations contain payment lines (charges and fees) and can have manual adjustments. Learn more in Reservations.
Contacts
People in your system - either owners (property owners) or vendors (service providers). See Contacts.
Transactions
Manual financial entries you create:
- Deposits: Money received (guest payments, channel payouts)
- Expenses: Costs incurred (repairs, utilities)
- Transfers: Owner payouts and fund movements
Learn more in Transactions.
Accounts
Financial accounts for tracking where money goes. The platform includes default accounts but you can create custom ones. See Accounts.
Key Concepts
Ownership Periods
Properties can change ownership over time. Each ownership period defines the date range and how revenue is split between owners. This is fundamental to accurate owner statements.
Recurring Fees
Automated fee calculations applied to reservations - management fees, cleaning fees, channel fees, etc. Fees can use flat rates or percentage-based formulas.
Owner Statements
Periodic financial reports for property owners showing revenue, expenses, and payouts. Statements can be customized with layouts and sections.
Locking & Books Closed
The platform prevents modifications to historical data to maintain accounting integrity. Understanding locking rules is essential for API integrations.
Next Steps
- Understand your data model: Start with Ownership Periods and Reservations
- Learn financial operations: Review Transactions and Recurring Fees
- Explore reporting: Check out Owner Statements
- Know the rules: Read Locking to understand data constraints
API Reference
For detailed endpoint documentation, see the API Specification.