Skip to content
MCP tools
View as Markdown
Read-onlyCommission ledgerMCP tool

commission_ledger_list

List commission ledger entries visible to the caller, newest first.

List commission ledger entries visible to the caller, newest first. Standard agents see only their own entries; brokers/team leads see their brokerage/team. Use to review upcoming or past commission payouts, or to find an entry's ID before updating it. Filter by status, agent, side, and payout-date range. Returns a paginated summary (id, escrow_number, property_address, side, agent_name, amounts, status, payout dates).

Parameters#

ParameterTypeRequiredDescription
querystringNoFree-text search across escrow number, property address, and agent name
statusenumNoFilter by payment status · One of: pending, processing, paid, cancelled
agent_idstringNoFilter by agent UUID (users.id) · Format: UUID
sideenumNoFilter by deal side · One of: listing, buyer, both
start_datestringNoOnly entries with a payout date on/after this date (YYYY-MM-DD) · Format: Date (YYYY-MM-DD)
end_datestringNoOnly entries with a payout date on/before this date (YYYY-MM-DD) · Format: Date (YYYY-MM-DD)
limitnumberNoMax results (default 25, cap 100) · Max: 100 · Min: 1
offsetnumberNoSkip N records for pagination (default 0) · Min: 0

Example prompts#

  • "Show me my commission ledger."

Safety#

Read-only. This tool never changes your data — it only looks things up. Safe to run anytime.