Servers Playground How we check Add a server Log in

Buildium MCP by usefulapi

Working · 2.2 s

io.usefulapi/buildiumv1.20.0 Domain verified

Read Buildium properties, units, leases, tenants, balances and bills; manage work orders.

Local Services

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://buildium.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

buildium_create_todo_task Destructive

Create an internal to-do task assigned to a staff user, optionally tied to a property/unit and category, with a due date. Buildium: POST /v1/tasks/todorequests.

titlestring, required

Task title (max 127).

statusstring, required

Status.

prioritystring, required

Priority.

assigned_to_user_idinteger, required

Staff user id assigned to the task.

unit_idinteger

Unit id (must belong to property_id).

due_datestring

Due date, YYYY-MM-DD.

category_idinteger

Task category id.

descriptionstring

Task description.

property_idinteger

Active property id.

subcategory_idinteger

Task subcategory id.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Buildium MCP by usefulapi MCP server | mcptry

Buildium MCP by usefulapi

Working · 2.2 s

io.usefulapi/buildiumv1.20.0 Domain verified

Read Buildium properties, units, leases, tenants, balances and bills; manage work orders.

Local Services

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://buildium.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

buildium_create_todo_task Destructive

Create an internal to-do task assigned to a staff user, optionally tied to a property/unit and category, with a due date. Buildium: POST /v1/tasks/todorequests.

titlestring, required

Task title (max 127).

statusstring, required

Status.

prioritystring, required

Priority.

assigned_to_user_idinteger, required

Staff user id assigned to the task.

unit_idinteger

Unit id (must belong to property_id).

due_datestring

Due date, YYYY-MM-DD.

category_idinteger

Task category id.

descriptionstring

Task description.

property_idinteger

Active property id.

subcategory_idinteger

Task subcategory id.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (23)

buildium_create_todo_task

Create an internal to-do task assigned to a staff user, optionally tied to a property/unit and category, with a due date. Buildium: POST /v1/tasks/todorequests.

destructive

Argument	Type	Description
title*	string	Task title (max 127).
status*	string	Status.
unit_id	integer	Unit id (must belong to property_id).
due_date	string	Due date, YYYY-MM-DD.
priority*	string	Priority.
category_id	integer	Task category id.
description	string	Task description.
property_id	integer	Active property id.
subcategory_id	integer	Task subcategory id.
assigned_to_user_id*	integer	Staff user id assigned to the task.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title",
    "assigned_to_user_id",
    "priority",
    "status"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 127,
      "description": "Task title (max 127)."
    },
    "status": {
      "enum": [
        "New",
        "InProgress",
        "Completed",
        "Deferred",
        "Closed"
      ],
      "type": "string",
      "description": "Status."
    },
    "unit_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unit id (must belong to property_id).",
      "exclusiveMinimum": 0
    },
    "due_date": {
      "type": "string",
      "description": "Due date, YYYY-MM-DD."
    },
    "priority": {
      "enum": [
        "Low",
        "Normal",
        "High"
      ],
      "type": "string",
      "description": "Priority."
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Task category id.",
      "exclusiveMinimum": 0
    },
    "description": {
      "type": "string",
      "maxLength": 65500,
      "description": "Task description."
    },
    "property_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Active property id.",
      "exclusiveMinimum": 0
    },
    "subcategory_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Task subcategory id.",
      "exclusiveMinimum": 0
    },
    "assigned_to_user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Staff user id assigned to the task.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_create_work_order

Create a work order for a vendor. Attach it to an existing task (task_id) or create a new task with it (task: title, priority, status, assigned staff user, optional due date/property/unit). vendor_id and entry_allowed are required. Line items are optional (quantity x unit price, optional GL account). Buildium: POST /v1/workorders.

destructive

Argument	Type	Description
task	object	A new task to create and link to this work order (instead of task_id).
title	string	Work order title (max 127 chars).
task_id	integer	Existing task to attach this work order to.
vendor_id*	integer	Vendor id doing the work.
line_items	array	Work order line items.
entry_notes	string	Notes on entering the unit.
vendor_notes	string	Notes for the vendor.
work_details	string	Description of the work.
chargeable_to

buildium_get_lease

Fetch one lease by id, including tenants, cosigners, account details and move-out data. Buildium: GET /v1/leases/{leaseId}.

read-only

Argument	Type	Description
lease_id*	integer	The lease id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lease_id"
  ],
  "properties": {
    "lease_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The lease id.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_get_rental_property

Fetch one rental property by id. Buildium: GET /v1/rentals/{propertyId}.

read-only

Argument	Type	Description
property_id*	integer	The rental property id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_id"
  ],
  "properties": {
    "property_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The rental property id.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_get_rental_unit

Fetch one rental unit by id. Buildium: GET /v1/rentals/units/{unitId}.

read-only

Argument	Type	Description
unit_id*	integer	The rental unit id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "unit_id"
  ],
  "properties": {
    "unit_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The rental unit id.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_get_tenant

Fetch one rental tenant by id. Buildium: GET /v1/leases/tenants/{tenantId}.

read-only

Argument	Type	Description
tenant_id*	integer	The tenant id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "tenant_id"
  ],
  "properties": {
    "tenant_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The tenant id.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_get_work_order

Fetch one work order by id. Buildium: GET /v1/workorders/{workOrderId}.

read-only

Argument	Type	Description
work_order_id*	integer	The work order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "work_order_id"
  ],
  "properties": {
    "work_order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The work order id.",
      "exclusiveMinimum": 0
    }
  }
}

buildium_list_applicants

List rental applicants with contact details, status and their applications. Filter by application status, unit, name, email, submission date or entity. Buildium: GET /v1/applicants.

read-only

Argument	Type	Description
name	string	Applicant name contains this value.
email	string	Email contains this value.
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
unit_ids	array	Filter to these unit ids.
entity_id	integer	Property or rental owner id (per entity_type).
entity_type	string	Scope by entity type; required with entity_id.
submitted_to	string	Application submitted on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.

buildium_list_associations

List community/HOA associations with address, manager, reserve, fiscal year and operating bank account. Buildium: GET /v1/associations.

read-only

Argument	Type	Description
ids	array	Filter to these association ids.
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
status	string	Association status (both if omitted).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
location	string	City or state contains this value.
last_updated_to	string	Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.
last_updated_from	string	Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.
operating_bank_account_ids	array

buildium_list_bills

List vendor bills (accounts payable) with dates, memo, vendor, linked work order, reference number, approval status and lines. Read-only. Buildium: GET /v1/bills.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
entity_id	integer	Entity id with line items on the bill.
vendor_id	integer	Vendor id.
entity_type	string	Scope by entity type; required with entity_id.
paid_status	string	Paid status.
paid_date_to	string	Paid on or before — formatted YYYY-MM-DD.
paid_date_from	string	Paid on or after — formatted YYYY-MM-DD.

buildium_list_gl_accounts

List the chart of accounts: GL accounts with number, name, type/subtype, sub-accounts and bank/credit-card flags. Useful for finding the gl_account_id for work order line items. Buildium: GET /v1/glaccounts.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
account_types	array	Account types.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "account_types": {
      "type": "array",
      "items": {
        "enum": [
          "Asset",
          "Liability",
          "Equity",
          "Income",
          "Expense"
        ],
        "type": "string"
      },
      "description": "Account types."
    }
  }
}

buildium_list_lease_transactions

Read a lease's ledger: charges, payments, credits, refunds, deposits and other transactions with date, type, total amount and journal lines. Read-only — this server never posts to a ledger. Buildium: GET /v1/leases/{leaseId}/transactions.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
lease_id*	integer	The lease id.
transaction_types	array	Transaction types to include.
transaction_date_to	string	Transaction date on or before — formatted YYYY-MM-DD.
transaction_date_from	string	Transaction date on or after — formatted YYYY-MM-DD.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lease_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "lease_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The lease id.",
      "exclusiveMinimum": 0
    },
    "transaction_types": {
      "type": "array",
      "items": {
        "enum": [
          "Bill",
          "Check",
          "Charge",
          "Payment",
          "Credit",
          "Refund",
          "ApplyDeposit",
          "ElectronicFundsTransfer",
          "Other",
          "Deposit",
          "GeneralJournalEntry",
          "OwnerContribution",
          "ReversePayment",
          "ReverseElectronicFundsTransfer",
          "VendorCredit",
          "RentalApplicationFeePayment",
          "ReverseRentalApplicationFeePayment",
          "ReverseOwnerContribution",
          "VendorRefund",
          "UnreversedPayment",
          "UnreversedElectronicFundsTransfer",
          "UnreversedOwnerContribution",
          "UnreversedRentalApplicationFeePayment",
          "ReversedEftRefund",
          "CreditCardPurchase",
          "CreditCardPayment"
        ],
        "type": "string"
      },
      "description": "Transaction types to include."
    },
    "transaction_date_to": {
      "type": "string",
      "description": "Transaction date on or before — formatted YYYY-MM-DD."
    },
    "transaction_date_from": {
      "type": "string",
      "description": "Transaction date on or after — formatted YYYY-MM-DD."
    }
  }
}

buildium_list_leases

List leases with unit, dates, lease type/status, current tenants, rent/deposit account details and eviction flag. Filter by property, owner, unit number, tenant name, dates, lease type or status (Active/Past/Future). Buildium: GET /v1/leases.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
created_to	string	Created on or before — YYYY-MM-DD HH:MM:SS.
lease_types	array	Lease types.
tenant_name	string	A current tenant's name contains this value.
unit_number	string	Unit number contains this value.
created_from	string	Created on or after — YYYY-MM-DD HH:MM:SS.
property_ids

buildium_list_outstanding_balances

Delinquency report: leases that owe money, with aged buckets (0-30, 31-60, 61-90, 90+ days), total balance, past-due-email and eviction-pending dates. Leases with zero or credit balances are not returned. Buildium: GET /v1/leases/outstandingbalances.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
entity_id	integer	Property or rental owner id (per entity_type).
lease_ids	array	Filter to these lease ids.
entity_type	string	Scope by entity type; required with entity_id.
lease_statuses	array	Lease term statuses.
past_due_email	string	Past-due email state.
eviction_status

buildium_list_rental_owners

List rental owners (the landlords you manage for) with contact details, management-agreement dates and the property ids they own. Buildium: GET /v1/rentals/owners.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
phone	string	Phone number contains this value.
offset	integer	Zero-based record offset for paging (default 0).
status	string	Owner status (both if omitted).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
owner_name	string	Owner name contains this value.
property_ids	array	Filter to these property ids.
last_updated_to	string	Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.
last_updated_from	string

buildium_list_rental_properties

List rental properties (buildings) with address, unit count, type/subtype and manager. Filter by location (city/state contains), type, subtype, status, rental owner or property ids. Buildium: GET /v1/rentals.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
types	array	Rental types.
offset	integer	Zero-based record offset for paging (default 0).
status	string	Property status (both if omitted).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
location	string	City or state contains this value.
subtypes	array	Rental subtypes.
property_ids	array	Filter to these property ids.
last_updated_to	string	Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.

buildium_list_rental_units

List rental units with unit number, bedrooms/bathrooms, size, market rent and whether each unit is listed or occupied. Filter by property. Buildium: GET /v1/rentals/units.

read-only

Argument	Type	Description
limit	integer	Max results, 1-1000 (Buildium default 50).
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
property_ids	array	Filter to these property ids.
last_updated_to	string	Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.
last_updated_from	string	Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "property_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these property ids."
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    }
  }
}

buildium_list_tasks

List all tasks/requests — contact requests, resident requests, rental owner requests and to-dos — with category, property, unit, requester, assignee, status, priority and due date. Buildium: GET /v1/tasks.

read-only

Argument	Type	Description
type	string	Task type.
limit	integer	Max results, 1-1000 (Buildium default 50).
title	string	Title contains this value.
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
unit_id	integer	Unit id.
statuses	array	Task statuses.
entity_id	integer	Entity id (per entity_type).
priorities	array	Priorities.
due_date_to

buildium_list_tenants

List rental tenants with contact details, emergency contact, address and leases. Filter by name, email, phone, unit number, property, owner, unit ids or lease term status. Buildium: GET /v1/leases/tenants.

read-only

Argument	Type	Description
name	string	Tenant name contains this value.
email	string	Email contains this value.
limit	integer	Max results, 1-1000 (Buildium default 50).
phone	string	Phone number contains this value.
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
unit_ids	array	Filter to these unit ids.
unit_number	string	Unit number contains this value.
property_ids	array	Filter to these property ids.

buildium_list_vendors

List vendors (contractors, suppliers) with contact details, category, insurance and default expense GL account. Filter by name, email, phone, website, status or insurance expiration. Buildium: GET /v1/vendors.

read-only

Argument	Type	Description
name	string	Vendor name contains this value.
email	string	Email contains this value.
limit	integer	Max results, 1-1000 (Buildium default 50).
phone	string	Phone number contains this value.
offset	integer	Zero-based record offset for paging (default 0).
status	string	Vendor status (both if omitted).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
website	string	Website contains this value.
last_updated_to	string	Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ.

buildium_list_work_orders

List work orders with title, status, priority, due date, vendor, amount, line items, linked task and bill ids. Filter by entity, status, priority, task type, unit, vendor, assignee, dates, amount, billed flag or title. Buildium: GET /v1/workorders.

read-only

Argument	Type	Description
type	string	Type of the associated task.
limit	integer	Max results, 1-1000 (Buildium default 50).
title	string	Title contains this value.
offset	integer	Zero-based record offset for paging (default 0).
orderby	string	Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object.
unit_id	integer	Unit id.
statuses	array	Work order statuses.
task_ids	array	Filter to these task ids.
amount_to	number	Total amount at most this.

buildium_update_todo_task

Update a to-do task — change status (e.g. mark Completed), priority, assignee, due date, title or category, optionally with an update message. Buildium's PUT replaces the whole record, so this reads the current task first and only changes the fields you pass. Buildium: GET then PUT /v1/tasks/todorequests/{toDoTaskId}.

destructive

Argument	Type	Description
title	string	New title (max 127).
status	string	New status.
message	string	An update note recorded with this change.
unit_id	integer	New unit id.
due_date	string	New due date, YYYY-MM-DD.
priority	string	New priority.
category_id	integer	New task category id.
property_id	integer	New active property id.
todo_task_id*	integer	The to-do task id.

buildium_update_work_order

Update a work order's details. Buildium's PUT replaces the whole record, so this reads the current work order first and only changes the fields you pass — everything else (including line items and entry contacts) is preserved. Passing line_items REPLACES all existing line items. Status/priority/due date live on the linked task. Buildium: GET then PUT /v1/workorders/{workOrderId}.

destructive

Argument	Type	Description
title	string	New title (max 127).
vendor_id	integer	Reassign to this vendor id.
line_items	array	Replace ALL line items with this list.
entry_notes	string	Notes on entering the unit.
vendor_notes	string	Notes for the vendor.
work_details	string	New description of the work.
chargeable_to	string	Who will be charged (max 100).
entry_allowed	string	Whether entry to the unit is allowed.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "vendor_id",
    "entry_allowed"
  ],
  "properties": {
    "task": {
      "type": "object",
      "required": [
        "title",
        "priority",
        "status",
        "assigned_to_user_id"
      ],
      "properties": {
        "title": {
          "type": "string",
          "maxLength": 127,
          "description": "Task title (max 127)."
        },
        "status": {
          "enum": [
            "New",
            "InProgress",
            "Completed",
            "Deferred",
            "Closed"
          ],
          "type": "string",
          "description": "Task status."
        },
        "unit_id": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Unit id (must belong to property_id).",
          "exclusiveMinimum": 0
        },
        "due_date": {
          "type": "string",
          "description": "Due date, YYYY-MM-DD."
        },
        "priority": {
          "enum": [
            "Low",
            "Normal",
            "High"
          ],
          "type": "string",
          "description": "Task priority."
        },
        "property_id": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Active property id.",
          "exclusiveMinimum": 0
        },
        "assigned_to_user_id": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Staff user id assigned to the task.",
          "exclusiveMinimum": 0
        }
      },
      "description": "A new task to create and link to this work order (instead of task_id)."
    },
    "title": {
      "type": "string",
      "maxLength": 127,
      "description": "Work order title (max 127 chars)."
    },
    "task_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing task to attach this work order to.",
      "exclusiveMinimum": 0
    },
    "vendor_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Vendor id doing the work.",
      "exclusiveMinimum": 0
    },
    "line_items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "quantity",
          "unit_price"
        ],
        "properties": {
          "memo": {
            "type": "string",
            "description": "Line item memo."
          },
          "quantity": {
            "type": "number",
            "description": "Line item quantity."
          },
          "unit_price": {
            "type": "number",
            "description": "Line item unit price."
          },
          "gl_account_id": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "General ledger account id.",
            "exclusiveMinimum": 0
          }
        }
      },
      "description": "Work order line items."
    },
    "entry_notes": {
      "type": "string",
      "description": "Notes on entering the unit."
    },
    "vendor_notes": {
      "type": "string",
      "description": "Notes for the vendor."
    },
    "work_details": {
      "type": "string",
      "description": "Description of the work."
    },
    "chargeable_to": {
      "type": "string",
      "maxLength": 100,
      "description": "Who will be charged for the work (max 100)."
    },
    "entry_allowed": {
      "enum": [
        "Unknown",
        "Yes",
        "No"
      ],
      "type": "string",
      "description": "Whether entry to the unit is allowed."
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 50,
      "description": "Vendor invoice/reference number (max 50)."
    },
    "entry_contact_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Entry contact user ids (RentalTenant, AssociationOwner, Staff or RentalOwner)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "description": "Applicant name contains this value."
    },
    "email": {
      "type": "string",
      "description": "Email contains this value."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "unit_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these unit ids."
    },
    "entity_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Property or rental owner id (per entity_type).",
      "exclusiveMinimum": 0
    },
    "entity_type": {
      "enum": [
        "Rental",
        "RentalOwner"
      ],
      "type": "string",
      "description": "Scope by entity type; required with entity_id."
    },
    "submitted_to": {
      "type": "string",
      "description": "Application submitted on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "submitted_from": {
      "type": "string",
      "description": "Application submitted on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "application_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "Undecided",
          "Approved",
          "Rejected",
          "AddedToLease",
          "Cancelled",
          "Deferred",
          "New",
          "Draft",
          "AddedToDraftLease"
        ],
        "type": "string"
      },
      "description": "Application statuses."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "created_to": {
      "type": "string",
      "description": "Created on or before — YYYY-MM-DD HH:MM:SS."
    },
    "lease_types": {
      "type": "array",
      "items": {
        "enum": [
          "None",
          "Fixed",
          "FixedWithRollover",
          "AtWill"
        ],
        "type": "string"
      },
      "description": "Lease types."
    },
    "tenant_name": {
      "type": "string",
      "description": "A current tenant's name contains this value."
    },
    "unit_number": {
      "type": "string",
      "description": "Unit number contains this value."
    },
    "created_from": {
      "type": "string",
      "description": "Created on or after — YYYY-MM-DD HH:MM:SS."
    },
    "property_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these property ids."
    },
    "lease_date_to": {
      "type": "string",
      "description": "Lease end date on or before — formatted YYYY-MM-DD."
    },
    "lease_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "Active",
          "Past",
          "Future"
        ],
        "type": "string"
      },
      "description": "Lease term statuses."
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "lease_date_from": {
      "type": "string",
      "description": "Lease start date on or after — formatted YYYY-MM-DD."
    },
    "rental_owner_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these rental owner ids."
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "entity_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Property or rental owner id (per entity_type).",
      "exclusiveMinimum": 0
    },
    "lease_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these lease ids."
    },
    "entity_type": {
      "enum": [
        "Rental",
        "RentalOwner"
      ],
      "type": "string",
      "description": "Scope by entity type; required with entity_id."
    },
    "lease_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "Active",
          "Past",
          "Future"
        ],
        "type": "string"
      },
      "description": "Lease term statuses."
    },
    "past_due_email": {
      "enum": [
        "NoEmailAddress",
        "Sent"
      ],
      "type": "string",
      "description": "Past-due email state."
    },
    "eviction_status": {
      "enum": [
        "NotEvictionPending",
        "EvictionPending"
      ],
      "type": "string",
      "description": "Eviction status."
    },
    "balance_duration": {
      "enum": [
        "TotalBalance",
        "Balance0to30Days",
        "Balance31to60Days",
        "Balance61to90Days",
        "BalanceOver90Days"
      ],
      "type": "string",
      "description": "Only leases with a balance in this aging bucket."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "types": {
      "type": "array",
      "items": {
        "enum": [
          "Residential",
          "Commercial"
        ],
        "type": "string"
      },
      "description": "Rental types."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "status": {
      "enum": [
        "Active",
        "InActive"
      ],
      "type": "string",
      "description": "Property status (both if omitted)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "location": {
      "type": "string",
      "description": "City or state contains this value."
    },
    "subtypes": {
      "type": "array",
      "items": {
        "enum": [
          "CondoTownhome",
          "MultiFamily",
          "SingleFamily",
          "Industrial",
          "Office",
          "Retail",
          "ShoppingCenter",
          "Storage",
          "ParkingSpace"
        ],
        "type": "string"
      },
      "description": "Rental subtypes."
    },
    "property_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these property ids."
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "rental_owner_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these rental owner ids."
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "ContactRequest",
        "ResidentRequest",
        "Todo",
        "RentalOwnerRequest"
      ],
      "type": "string",
      "description": "Task type."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "title": {
      "type": "string",
      "description": "Title contains this value."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "unit_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unit id.",
      "exclusiveMinimum": 0
    },
    "statuses": {
      "type": "array",
      "items": {
        "enum": [
          "New",
          "InProgress",
          "Completed",
          "Deferred",
          "Closed"
        ],
        "type": "string"
      },
      "description": "Task statuses."
    },
    "entity_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Entity id (per entity_type).",
      "exclusiveMinimum": 0
    },
    "priorities": {
      "type": "array",
      "items": {
        "enum": [
          "Low",
          "Normal",
          "High"
        ],
        "type": "string"
      },
      "description": "Priorities."
    },
    "due_date_to": {
      "type": "string",
      "description": "Due on or before — formatted YYYY-MM-DD."
    },
    "entity_type": {
      "enum": [
        "Rental",
        "RentalOwner",
        "Association"
      ],
      "type": "string",
      "description": "Scope by entity type; required with entity_id."
    },
    "due_date_from": {
      "type": "string",
      "description": "Due on or after — formatted YYYY-MM-DD."
    },
    "assigned_to_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Assigned staff user id.",
      "exclusiveMinimum": 0
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — formatted YYYY-MM-DD."
    },
    "task_category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Task category id.",
      "exclusiveMinimum": 0
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — formatted YYYY-MM-DD."
    },
    "unit_agreement_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unit agreement (lease) id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "description": "Tenant name contains this value."
    },
    "email": {
      "type": "string",
      "description": "Email contains this value."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "phone": {
      "type": "string",
      "description": "Phone number contains this value."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "unit_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these unit ids."
    },
    "unit_number": {
      "type": "string",
      "description": "Unit number contains this value."
    },
    "property_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these property ids."
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "rental_owner_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these rental owner ids."
    },
    "building_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "Active",
          "InActive"
        ],
        "type": "string"
      },
      "description": "Status of the tenant's property."
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ."
    },
    "lease_term_statuses": {
      "type": "array",
      "items": {
        "enum": [
          "Active",
          "Past",
          "Future"
        ],
        "type": "string"
      },
      "description": "Lease term statuses."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "ContactRequest",
        "ResidentRequest",
        "Todo",
        "RentalOwnerRequest"
      ],
      "type": "string",
      "description": "Type of the associated task."
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Max results, 1-1000 (Buildium default 50)."
    },
    "title": {
      "type": "string",
      "description": "Title contains this value."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based record offset for paging (default 0)."
    },
    "orderby": {
      "type": "string",
      "description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". Any field of the returned object."
    },
    "unit_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unit id.",
      "exclusiveMinimum": 0
    },
    "statuses": {
      "type": "array",
      "items": {
        "enum": [
          "New",
          "InProgress",
          "Completed",
          "Deferred",
          "Closed"
        ],
        "type": "string"
      },
      "description": "Work order statuses."
    },
    "task_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these task ids."
    },
    "amount_to": {
      "type": "number",
      "description": "Total amount at most this."
    },
    "entity_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Entity id (per entity_type).",
      "exclusiveMinimum": 0
    },
    "is_billed": {
      "type": "boolean",
      "description": "Only work orders that do / do not have a bill."
    },
    "priorities": {
      "type": "array",
      "items": {
        "enum": [
          "Low",
          "Normal",
          "High"
        ],
        "type": "string"
      },
      "description": "Priorities."
    },
    "vendor_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Filter to these vendor ids."
    },
    "amount_from": {
      "type": "number",
      "description": "Total amount at least this."
    },
    "due_date_to": {
      "type": "string",
      "description": "Due on or before — formatted YYYY-MM-DD."
    },
    "entity_type": {
      "enum": [
        "Rental",
        "RentalOwner",
        "Association"
      ],
      "type": "string",
      "description": "Scope by entity type; required with entity_id."
    },
    "due_date_from": {
      "type": "string",
      "description": "Due on or after — formatted YYYY-MM-DD."
    },
    "assigned_to_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Assigned staff user id.",
      "exclusiveMinimum": 0
    },
    "last_updated_to": {
      "type": "string",
      "description": "Updated on or before — formatted YYYY-MM-DD."
    },
    "task_category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Task category id.",
      "exclusiveMinimum": 0
    },
    "last_updated_from": {
      "type": "string",
      "description": "Updated on or after — formatted YYYY-MM-DD."
    },
    "unit_agreement_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Unit agreement (lease) id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "work_order_id"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 127,
      "description": "New title (max 127)."
    },
    "vendor_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Reassign to this vendor id.",
      "exclusiveMinimum": 0
    },
    "line_items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "quantity",
          "unit_price"
        ],
        "properties": {
          "memo": {
            "type": "string",
            "description": "Line item memo."
          },
          "quantity": {
            "type": "number",
            "description": "Line item quantity."
          },
          "unit_price": {
            "type": "number",
            "description": "Line item unit price."
          },
          "gl_account_id": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "General ledger account id.",
            "exclusiveMinimum": 0
          }
        }
      },
      "description": "Replace ALL line items with this list."
    },
    "entry_notes": {
      "type": "string",
      "description": "Notes on entering the unit."
    },
    "vendor_notes": {
      "type": "string",
      "description": "Notes for the vendor."
    },
    "work_details": {
      "type": "string",
      "description": "New description of the work."
    },
    "chargeable_to": {
      "type": "string",
      "maxLength": 100,
      "description": "Who will be charged (max 100)."
    },
    "entry_allowed": {
      "enum": [
        "Unknown",
        "Yes",
        "No"
      ],
      "type": "string",
      "description": "Whether entry to the unit is allowed."
    },
    "work_order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The work order id.",
      "exclusiveMinimum": 0
    },
    "invoice_number": {
      "type": "string",
      "maxLength": 50,
      "description": "Vendor invoice/reference number (max 50)."
    },
    "entry_contact_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "description": "Replace the entry contact user ids."
    }
  }
}