Tool Reference

This file is generated by scripts/generate-tools-doc.mjs. Do not edit by hand.

The server exposes 20 tools (13 read-only, 7 write). Write tools require an explicit confirm: true argument; without it they return a preview and make no change. See Security and Writes & Confirmation.

rentec_properties read-only

Properties — Read properties. Omit id to list (filter by occupancy, archived status, parent property, marketing inclusion, and creation date/age). Provide id to fetch one property in full.

Parameter Type Required Description
id number   Numeric record ID.
include_subunits boolean    
sub_of number    
archived boolean    
occupied boolean    
marketing boolean    
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
data_only boolean    

rentec_tenants read-only

Tenants — Read tenants. Omit id to list (filter by archived status and creation date/age). Provide id to fetch one tenant in full, including balances and properties.

Parameter Type Required Description
id number   Numeric record ID.
archived boolean    
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
data_only boolean    

rentec_leads read-only

Leads — Read leads (rental prospects). Omit id to list (filter by archived status and date/age). Provide id to fetch one lead in full.

Parameter Type Required Description
id number   Numeric record ID.
archived boolean    
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
data_only boolean    

rentec_create_lead WRITE

Create Lead — Create a new lead (prospect). WRITE OPERATION. Required: f_name, l_name, monthly_rent_max, search_city, search_state, and at least one of phone or mphone. Requires confirm:true.

Parameter Type Required Description
f_name string ✓ First name (required).
l_name string ✓ Last name (required).
monthly_rent_max number ✓ Maximum monthly rent desired (required).
search_city string ✓ Search city (required).
search_state string ✓ Search state abbreviation, e.g. OR (required).
phone string    
mphone string    
email string    
monthly_income number    
monthly_rent_min number    
move_in string    
occupants number    
bedrooms_min number    
bathrooms_min number    
search_range number    
allow_animals boolean    
allow_smokers boolean    
fiftyfive_plus boolean    
washer_dryer boolean    
washer_dryer_hookups boolean    
wheelchair_access boolean    
rental_assistance boolean    
garage_carport boolean    
air_conditioner boolean    
no_lease boolean    
notes string    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_owners read-only

Owners — Read property owners. Omit id to list (filter by archived status and date/age). Provide id to fetch one owner in full.

Parameter Type Required Description
id number   Numeric record ID.
archived boolean    
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
data_only boolean    

rentec_vendors read-only

Vendors — Read vendors (service providers). Omit id to list (filter by date/age). Provide id to fetch one vendor in full.

Parameter Type Required Description
id number   Numeric record ID.
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
data_only boolean    

rentec_create_vendor WRITE

Create Vendor — Create a new vendor. WRITE OPERATION. New vendors default to the “Repairs” category. Requires confirm:true to execute.

Parameter Type Required Description
name string ✓ Vendor name (required).
industry string    
contact string    
email string    
address string    
address2 string    
city string    
state string    
zip string    
phone string    
mphone string    
rate string    
notes string    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_leases read-only

Leases — Read leases (rental agreements). Omit id to list — by default only current and future leases are returned; provide start_date/end_date or age to widen the range, and filter by property or tenant. Provide id to fetch one lease in full, including balances.

Parameter Type Required Description
id number   Numeric record ID.
property_id number   Numeric record ID.
renter_id number   Numeric record ID.
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.

rentec_transactions read-only

Transactions — List financial transactions, in ascending date order, with running balances. Filter by exactly one of property_id, renter_id, bank_id, or category_id. Returns up to 300 records per page; use page to paginate.

Parameter Type Required Description
property_id number   Numeric record ID.
renter_id number   Numeric record ID.
bank_id number   Numeric record ID.
category_id number   Numeric record ID.
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
page number    

rentec_create_expense WRITE

Create Expense Transaction — Record an expense transaction. WRITE OPERATION affecting financial records. Required: category_id, amount (positive), pmt_type, and one of property_id or bank_id. Requires confirm:true to execute.

Parameter Type Required Description
category_id number ✓ Expense category ID (required).
amount number ✓ Expense amount as a positive number (required). Max 9999999.99.
pmt_type enum ✓ Payment type: CH=Check, PCH=Print Check, CA=Cash, CR=Credit Card, O=Other, ACH=ACH.
property_id number   Numeric record ID.
bank_id number   Numeric record ID.
renter_id number   Numeric record ID.
transaction_time string    
memo string    
check_num string    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_accounting read-only

Accounting Reference — Read accounting reference data. Choose resource: “accounts” (chart-of-accounts categories; Account types: I=Income, E=Expense, O=Other, A=Asset, L=Liability, Q=Equity.), “products” (product categories used for charges/income), or “banks” (bank accounts; routing numbers are masked). Omit id to list; provide id to fetch one record.

Parameter Type Required Description
resource enum ✓ Which accounting collection to read: accounts, products, or banks.
id number    
type string    
archived boolean    

rentec_work_orders read-only

Work Orders — Read maintenance Work Orders. Omit id to list (filter by status/property/date; defaults to the last 365 days). Provide id to fetch one Work Order including its notes. Statuses: OpenU/Unassigned, OpenA/Assigned, Parts (parts on order), Work (in progress), Finalized, Closed.

Parameter Type Required Description
id number   Numeric record ID.
status enum    
property_id number   Numeric record ID.
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.
archived boolean    

rentec_create_work_order WRITE

Create Work Order — Create a maintenance Work Order. WRITE OPERATION. Required: property_id and short_desc. Statuses: OpenU/Unassigned, OpenA/Assigned, Parts (parts on order), Work (in progress), Finalized, Closed. Requires confirm:true.

Parameter Type Required Description
property_id number ✓ Property ID (required).
short_desc string ✓ Short description, max 100 chars (required).
description string    
status enum    
priority number    
renter_id number   Numeric record ID.
contact_renter_id number   Numeric record ID.
vendor_id number   Numeric record ID.
date_received string   Date in YYYY-MM-DD format.
date_assigned string   Date in YYYY-MM-DD format.
date_resolved string   Date in YYYY-MM-DD format.
cost number    
tenant_view boolean    
owner_view boolean    
private_notes string    
email_manager boolean    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_add_work_order_note WRITE

Add Work Order Note — Add a note to an existing Work Order. WRITE OPERATION. Notes are private by default. Requires confirm:true.

Parameter Type Required Description
id number ✓ The Work Order ID to add the note to.
note string ✓ Note text (required).
private boolean    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_messages read-only

Messages — List communication records (emails/messages) for a tenant, prospect, owner, or vendor. Supports pagination and date/age filters.

Parameter Type Required Description
renter_id number   Numeric record ID.
prospect_id number   Numeric record ID.
owner_id number   Numeric record ID.
vendor_id number   Numeric record ID.
unread_only boolean    
page number    
page_size number    
age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
start_date string   Date in YYYY-MM-DD format.
end_date string   Date in YYYY-MM-DD format.

rentec_record_message WRITE

Record Message — Record a communication entry. WRITE OPERATION. Requires body and at least one of renter_id, prospect_id, owner_id, or vendor_id. Requires confirm:true.

Parameter Type Required Description
body string ✓ Message content (required).
subject string    
renter_id number   Numeric record ID.
prospect_id number   Numeric record ID.
owner_id number   Numeric record ID.
vendor_id number   Numeric record ID.
date string    
time string    
direction enum    
status string    
confirm boolean ✓ Set true to execute; omit to preview.

rentec_files read-only

Files — Read files. Omit id to list recent files, optionally filtered by associated entity (property, tenant, transaction, work order, vendor, split) or age. Provide id to get one file’s metadata; add save_to (a local path) to download its content to disk — bytes are written locally and kept out of the model context.

Parameter Type Required Description
id number   Numeric record ID.
save_to string    
age string    
property_id number   Numeric record ID.
renter_id number   Numeric record ID.
transaction_id number   Numeric record ID.
workorder_id number   Numeric record ID.
vendor_id number   Numeric record ID.
split_id number   Numeric record ID.

rentec_upload_file WRITE

Upload File — Upload a local file to Rentec Direct. WRITE OPERATION. Provide file_path (a local path) and optionally associate it with an entity. Requires confirm:true.

Parameter Type Required Description
file_path string ✓ Local absolute path of the file to upload (required).
workorder_id number   Numeric record ID.
renter_id number   Numeric record ID.
transaction_id number   Numeric record ID.
property_id number   Numeric record ID.
owner_id number   Numeric record ID.
vendor_id number   Numeric record ID.
confirm boolean ✓ Set true to execute; omit to preview.

rentec_lookup read-only

Lookup Contacts — Search contacts by email, phone, name, or company. scope selects what to search: “all” (default — tenants, leads, owners, and vendors, grouped by type; set flatten=true for one flat array) or a single type: “tenant”, “owner”, “vendor”, or “prospect”. At least one search criterion is required.

Parameter Type Required Description
scope enum    
email string    
phone string    
f_name string    
l_name string    
company string    
data_only boolean    
flatten boolean    

rentec_get_tenant_context read-only

Get Tenant Context (bundle) — Convenience bundle: fetch one tenant plus their leases and recent transaction ledger in a single call, instead of calling rentec_get_tenant, rentec_list_leases, and rentec_list_transactions separately. Use include to limit which sections are fetched (fewer sections = fewer API calls and a smaller result). Each section is fetched independently: if one fails (e.g. the tenant is archived), that section reports an error inline and the rest still return.

Parameter Type Required Description
renter_id number ✓ The tenant (renter) ID to assemble context for.
include array    
transactions_age string   Filter by age. Number + unit: d=days, h=hours, m=minutes, s=seconds. Bare number = days.
archived boolean    
data_only boolean