comecerodocs

Get the commissions report

GET
/reports/commissions

Totals the commissions Comecero owes your account, per currency, with one breakdown row per commission type. A commission is recorded when a payment is taken on a Comecero-owned gateway: the settlement total less tax, or the full total on an agent account. A refund records a negative commission.

Send accounting_id to get the commissions on one payout. With an accounting_id and no dates, every date is included. With no accounting_id and no dates, the report covers yesterday in the report time zone. A date_start later than today is refused.

Without currency, amounts stay in each commission's own currency, one group per currency. With one of your reporting currencies, every commission is converted into it and there is one group. Needs a secret or trusted token with permission to read reports.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

date_start?string

Only items on or after this date. Send ISO 8601 (2026-11-01T00:00:00Z or 2026-11-01T00:00:00-05:00) or a shorthand: 2026 means the start of 2026, 2026-11 the start of November, 2026-11-01 the start of that day. A date with no offset is read in timezone, or in the account's time zone when you send none. It must not be after date_end (400).

date_end?string

Only items on or before this date. Same formats as date_start, but a shorthand means the end of the period: 2026-11 is the last instant of November, 2026-11-30 the last instant of that day. A date with no offset is read in timezone, or in the account's time zone when you send none.

timezone?string

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

sort_by?string

How to order the currency groups. Any other value orders by total.

Default"total"
Value in"total""currency""transaction_count"
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse
accounting_id?string

Only count the commissions on this payout, for example C-AB1234P261130USD. It starts with C- and is 18 or 20 characters long.

currency?string

One of your two reporting currencies (Settings, General). Any other value is refused. Leave it out to keep each commission in its own currency.

Response Body

The commissions report.

application/json
  1. response

The commissions Comecero owes the account in a date range or on one payout, totalled per currency and broken down by commission type.

object?"report.commissions"

The object type. Always report.commissions.

Value in"report.commissions"
url?string

The URL that returns this report again, with the dates, filters and time zone it used.

Formaturi
account_id?|

The account the report is for.

date_created?string

When the report was run, in the report time zone.

Formatdate-time
date_start?|

The start of the range the report covers, in the report time zone.

Formatdate-time
date_end?|

The end of the range the report covers, in the report time zone.

Formatdate-time
timezone?string

The time zone used to read the dates.

test?boolean

True when the report covers test mode data.

type?|

Not used. Always null.

data?array<>

One group per currency. When you ask for a reporting currency, all commissions are converted into it and there is one group.

formatted?

The report dates as display text in the shopper's language. Only present when formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/reports/commissions'
Example Response
{  "object": "report.commissions",  "url": "https://api.comecero.com/api/v1/reports/commissions?date_start=2026-11-01T00:00:00&date_end=2026-11-06T23:59:59&timezone=UTC",  "account_id": "AB1234",  "date_created": "2026-11-07T14:12:44Z",  "date_start": "2026-11-01T00:00:00Z",  "date_end": "2026-11-06T23:59:59Z",  "timezone": "UTC",  "test": true,  "type": null,  "data": [    {      "currency": "USD",      "total": 249.9,      "transaction_count": 3,      "breakdowns": [        {          "type": "product_sales",          "total": 249.9,          "transaction_count": 3        }      ]    }  ]}