Skip to main content

Get Monthly Breakdown by Rep

GET 
/api/reporting/sales-rep-commissions/monthly-breakdown-by-rep

Month-by-month commission for each sales rep, ready to render as a grid.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

months lists every YYYY-MM bucket the requested period touches, in order, including months with no activity. Each rep's monthly_data is keyed by those same values, so every rep has an entry for every month — zeroed where there were no orders.

Rows are ordered by total commission, highest first. Reps with no qualifying orders in the period are omitted entirely.

How commission is earned is an account-level setting:

  • Sale basis — commission is earned when the order is placed, and the period is measured on the order date.
  • Fulfillment basis — commission is earned when the order ships, and the period is measured on the fulfillment date. Fully and over-fulfilled orders count in full. Partially fulfilled orders are only included if the account enables them, and then contribute only the value of the units that actually shipped.

Cancelled orders are excluded unless the account opts to include them, and an account may further restrict the report to a list of qualifying order statuses.

Sales figures are the product subtotal of each order's warehoused lines, converted to your account currency at the rate stored on the order. Commission is that value multiplied by the rep's commission rate.

Dates are interpreted in your account's timezone.

Authentication: Requires Bearer token. Scope: reports (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type