An agent can read what an affiliate has earned.
API and MCP access needs the Plus plan. The reads below also need a company API key.
A merchant might ask, "What has Jordan Lee earned, and is order 1040 paid?"
Two surfaces can answer that. MCP is at https://directsales.software/mcp. The REST
contract is https://directsales.software/api/v1/openapi.json. Both use
Authorization: Bearer and the company API key.
MCP tools for this question
get_company_contextreturns the company name, tier, capabilities, and discovery URLs. The API guide says to call it first.find_distributorresolves an affiliate by id, email, or name.get_distributor_earningsis the earnings read named in the public tool list.get_commission_overviewis the overview read named in the same list.get_salereturns an order summary by order number or sale id.
The public docs name these tools. They do not publish a separate parameter table for them. If a client needs field names, use the OpenAPI file.
REST fields that answer "was it paid?"
GET /api/v1/sales and GET /api/v1/sales/{saleId}
include simpleCommCommissionAmount, simpleCommIsPaid,
simpleCommPlanName, and the affiliate id and name.
GET /api/v1/ledger/entries returns ledger rows with
amount (positive is a credit, negative is a debit),
transactionType, lastKnownStatus,
payoutType, and simpleCommIsPaid.
Real-time commission plans are available at
GET /api/v1/commission-plans on the tier that includes them.
A plan has a name, a percent rate (25 means 25 percent), a basis type, and
flags for active and default. The tier that uses commission runs does not
get those real-time plan routes. Rank definitions are edited in the plan
editor, not via the API.
About 600 requests per 60 seconds are allowed per company key, shared by
REST and MCP. A 429 response includes Retry-After: 60.