---
title: "See Your Commission"
method: POST
path: "/v4/commission_reports/reports"
tags: ["Gateway Features", "Billing & Commission"]
---

# See Your Commission

`POST /v4/commission_reports/reports`

> ❗️ Never Use Real API Keys
>
> Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.
<details>
<summary>Usage</summary>
This will let you see what billing has occurred on merchants under your partner account 
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- SeeYourCommissionRequest
  - `month` string, required — Required. Month requested for the response.
  - `year` string, required — Required. Year requested for the response.
  - `offset` string, required — Required. "offset": 0 // Like all reports and search endpoints, you can specify the offset, which is the start point for the responses
  - `maxResults` string, required — Required. Value must be between 1-1000.

## Response `200`

Success

- SeeYourCommissionResponse
  - `objectType` 'serviceConfig' — The type of object that was returned as a result of the request.
  - `reportId` number — The ID of the report.
  - `offset` number — The first N skipped results.
  - `maxResults` number — The max number results.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — If are there more results for the search.
  - `links` object[] — Links for querying results.
    - `first` string — First page of query results.
    - `last` string — Last page of query results.
    - `next` string — Next page of current query results.
    - `previous` string — Previous page of current query results.
  - `results` object[] — Results for the search.
    - `objectType` string — Type of the returned response object
    - `rowId` string — The ID for the row.
    - `parentAffiliate` string — The ID of the affiliate directly above the merchant.
    - `merchant` object
      - `company` string — Merchant's company name
      - `id` string — The ID of the merchant
      - `externalIdentifier` string — A description to further describe or identify the merchant
    - `commission` object
      - `name` string — The name of the commission
      - `mcc` string — The Merchant Category Code
    - `processor` object
      - `id` string — The id of the processor
      - `name` string — The name of the processor
    - `service` object
      - `id` string — The id of the service
      - `name` string — The name of the service
    - `quantity` string — The quantity of the commission
    - `resale` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the resale
      - `currency` string — The currency of the resale
    - `totalResale` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the total resale
      - `currency` string — The currency of the total resale
    - `cost` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the cost
      - `currency` string — The currency of the cost
    - `totalCost` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the total cost
      - `currency` string — The currency of the total cost
    - `commissionEarned` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the commission earned
      - `currency` string — The currency of the commission earned
    - `recollections` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the recollections
      - `currency` string — The currency of the recollections
    - `returns` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the returns
      - `currency` string — The currency of the returns
    - `totalCommission` object
      - `objectType` string — The type of object that was returned as a result of the request
      - `amount` string — The amount of the total commission
      - `currency` string — The currency of the total commission
    - `subAffiliate` string — The quantity of the commission

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/versions/45c2ecda3685/schema)
