API Reference

Complete reference for all BillGauge API endpoints, request/response formats, and examples.

Properties

Manage your rental properties. Create, update, and retrieve property information and settings.

GET POST PATCH DELETE /api/v1/properties

Manage rental units and tenant information. Handle unit details, tenant records, and occupancy.

GET POST PATCH DELETE /api/v1/units, /api/v1/tenants

Access invoice data and update invoice status. Invoices are automatically generated from utility bills and sharing rules.

GET PATCH /api/v1/invoices

View utility bill information and payment status. Access bills that have been processed for charge calculations and tenant invoicing.

GET /api/v1/utility-bills

Configure cost sharing rules and split methods. Define how expenses are distributed across units.

GET POST PUT DELETE /api/v1/sharerules, /api/v1/split-methods

All API requests require authentication using your API key. Include it in the Authorization header as a Bearer token.

Learn how to authenticate your API requests

Understand API rate limiting and best practices