Reports

Commission report

Returns the commission earned by each practitioner at the requested site for the given period, broken down by commission package. Money fields are decimal strings in the site's currency (rather than minor-unit integers) to preserve the precision of the underlying commission calculation.

For background CSV delivery use /shop/reports/commission/queue.

get/shop/reports/commission

Query parameters

site_idstring uuid required

Restrict the report to commission earned at the given site.

date_fromstring date required

Example:2026-06-01

Restrict to commission earned on or after this date.

date_tostring date required

Example:2026-06-30

Restrict to commission earned on or before this date.

earner_idstring

Restrict the report to a single earner (a Practitioner or User, per earner_type).

earner_type'practitioner' | 'user'

Restrict the report to earners of this type. Combine with earner_id to disambiguate an id that could otherwise refer to either a Practitioner or a User.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "practitioner_id": "60c72b2f9b1e8a001c8e4f1a",
      "practitioner_name": "Sarah Smith",
      "earner_id": "60c72b2f9b1e8a001c8e4f1a",
      "earner_name": "Sarah Smith",
      "earner_type": "practitioner",
      "commission_package_name": "Standard Therapist Commission",
      "total_sales": 45000,
      "total_commission": 4500,
      "total_gross_commission": 4500,
      "item_count": 9,
      "currency": "gbp"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.