ARK TMS

MCP documentation | MCP docs for agents

ark_get_commission_report

ark.get_commission_report

Return permissioned commission detail rows, user summaries, or both for a date range and visible teams.

Availability
Expanded preview
Scopes
reports:read
ARK permissions
canViewReportscanViewCommissionReport
Team visibility
Required and enforced
Approval policy
none
ARK approval request
Not required
Idempotency
Not required
Read-only
Yes
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

fromstringrequired

Inclusive report start date in YYYY-MM-DD format.

tostringrequired

Inclusive report end date in YYYY-MM-DD format.

teamIdsarray<string>

Optional visible team IDs. Omit to use all teams available to the connection.

min items: 1; max items: 100

viewstring

one of: detail, summary, both; default: "both"

pageinteger

default: 1; min: 1

pageSizeinteger

default: 50; min: 1; max: 500

userIdstring

format: uuid

customerIdstring

format: uuid

isPaidboolean
dateFilterTypestring

one of: delivery_date, created_date, booking_date, pickup_date; default: "delivery_date"

paidDateFilterTypestring

one of: delivery_date, paid_date; default: "delivery_date"

customerCurrencystring

one of: USD, CAD, MXN

detailSortColumnstring

one of: date, loadNumber, customerName, userName, currencyCode, revenue, margin, marginCommission, revenueCommission, flatRateCommission, calculatedCommission, role; default: "date"

summarySortColumnstring

one of: userName, currencyCode, brokerCommission, salesRepCommission, csrCommission, managerCommission, totalCalculatedCommission; default: "totalCalculatedCommission"

sortDirectionstring

one of: asc, desc; default: "desc"

Result

The tool returns the canonical ark.get_commission_report operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.