Homebuzz

Login
POST /users/login

Request parameters

email
string optional
Example:
yichen@yichen.com
password
string optional
Example:
somepassword
Create Tenant
POST /tenants/create-by-admin

Request body

Object
unit
string
first_name
string
Example:
John
last_name
string
Example:
Doe
email
string
Example:
john@doe.com
extension_id
integer
Example:
135123
property_id
integer
Example:
280
recurring_charges
Array
Object
name
string
Example:
Rent
amount
integer
Example:
1500
Update Tenant
PUT /tenants/{id}

Path variables

id
string required

Tenants Payquad ID

Request body

Object
email
string
Example:
john@doe.com
extension_id
string
Example:
1351233
first_name
string
Example:
John
last_name
string
Example:
Doe
phone_number
string
Example:
5554443322
unit
string
Example:
108
status
string

if empty, missing or not equaling enabled, then it will disable the tenant

Example:
enabled
recurring_charges
Array

optional - if included will remove any existing charges in payquad that are not included in what is included in the call

Object
name
string
Example:
Rent
amount
integer
Example:
1600
Create Property
POST /properties

Available Payment Services

ID: Name

1 : Other

2 : Rent

3 : Last Month’s Rent

4 : Condo

5 : Strata

6 : Parking

7 : Bike Storage

8 : Storage

9 : Security Deposit

10: Maintenance

13: Rent & Parking

14: Balance

15: Application

Request body

Object
data
Object
payment_services
Array
Object
id
integer
Example:
1
checked
boolean
Example:
true
property_units
Array of string
Example:
['1','1B']
name
string
Example:
Api Test
address
string
Example:
100 Apitest Dr
city
string
Example:
Toronto
province
string
Example:
Ontario
postal_code
string
Example:
A1B 2C3
country
string
Example:
Canada
merchant_account_id
integer
Example:
68
Add Unit
POST /properties/{property_id}/add-unit

Path variables

property_id
string required

Request body

Object
unit
string
Example:
77