Commission Tools

Overview

The commission tools allow you to track and manage commission transactions for your affiliates. All tools support both Markdown and JSON response formats.

Available Tools

Tool	Description	Permission
`affonso_list_commissions`	List commission transactions	`read:commissions`
`affonso_get_commission`	Get a single commission	`read:commissions`
`affonso_create_commission`	Create a new commission	`write:commissions`
`affonso_update_commission`	Update commission status	`write:commissions`
`affonso_delete_commission`	Delete a commission	`delete:commissions`

Commission Statuses

Status	Description
`PENDING`	Commission created, awaiting approval
`APPROVED`	Commission approved, ready for payout
`PAID`	Commission has been paid out
`REJECTED`	Commission was rejected
`REFUNDED`	Commission was refunded due to return/chargeback

affonso_list_commissions

List and filter commission transactions.

Parameters

number

default:"1"

Page number for pagination

number

default:"50"

Results per page (max 100)

string

Filter by affiliate ID

string

Filter by status: PENDING, APPROVED, PAID, REJECTED, REFUNDED

string

Filter from date (ISO 8601)

string

Filter to date (ISO 8601)

string

default:"markdown"

Response format: markdown or json

Example Prompts

List all commissions
Show pending commissions
Get commissions for affiliate aff_abc123
Show approved commissions from last month
What commissions are ready for payout?

Response

## Commissions (Page 1 of 3)

### txn_abc123
- **Affiliate:** John Smith (aff_123)
- **Amount:** $9.90
- **Sale Amount:** $99.00
- **Status:** APPROVED
- **Created:** Jan 15, 2024

### txn_def456
- **Affiliate:** Jane Doe (aff_456)
- **Amount:** $15.00
- **Sale Amount:** $150.00
- **Status:** PENDING
- **Created:** Jan 14, 2024

---
**Total:** $24.90 across 2 commissions

{
  "commissions": [
    {
      "id": "txn_abc123",
      "affiliateId": "aff_123",
      "affiliateName": "John Smith",
      "amount": 990,
      "saleAmount": 9900,
      "status": "APPROVED",
      "createdAt": "2024-01-15T10:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 25,
    "totalPages": 1
  },
  "summary": {
    "totalAmount": 2490
  }
}

affonso_get_commission

Get detailed information about a specific commission.

Parameters

string

required

The commission ID (starts with txn_)

string

default:"markdown"

Response format: markdown or json

Example Prompts

Get commission txn_abc123
Show details for commission txn_xyz789
What's the status of transaction txn_pending123

Response

## Commission: txn_abc123

| Field | Value |
|-------|-------|
| Affiliate | John Smith (aff_123) |
| Commission | $9.90 |
| Sale Amount | $99.00 |
| Rate | 10% |
| Status | APPROVED |
| Referral | ref_xyz789 |
| Created | Jan 15, 2024 |
| Approved | Jan 16, 2024 |

### Notes
Commission approved after 30-day refund window.

{
  "id": "txn_abc123",
  "affiliateId": "aff_123",
  "affiliateName": "John Smith",
  "amount": 990,
  "saleAmount": 9900,
  "rate": 10,
  "status": "APPROVED",
  "referralId": "ref_xyz789",
  "createdAt": "2024-01-15T10:00:00.000Z",
  "approvedAt": "2024-01-16T10:00:00.000Z"
}

affonso_create_commission

Create a new commission transaction manually.

Parameters

string

required

The affiliate ID for this commission

number

required

Commission amount in cents

number

Original sale amount in cents

string

Associated referral ID

string

default:"PENDING"

Initial status: PENDING, APPROVED

string

Description or notes

string

default:"markdown"

Response format: markdown or json

Example Prompts

Create a $50 commission for affiliate aff_abc123
Add a commission of $25.50 for aff_xyz from sale of $255
Create an approved commission for aff_123 with amount $100
Record a bonus commission of $50 for affiliate aff_top with description "Q1 bonus"

Response

## Commission Created

| Field | Value |
|-------|-------|
| ID | txn_new123 |
| Affiliate | John Smith (aff_abc123) |
| Commission | $50.00 |
| Status | PENDING |
| Created | Jan 15, 2024 |

The commission is pending approval.

affonso_update_commission

Update an existing commission’s status or information.

Parameters

string

required

The commission ID to update

string

New status: PENDING, APPROVED, REJECTED, REFUNDED

number

Updated commission amount in cents

string

Updated description

string

default:"markdown"

Response format: markdown or json

Example Prompts

Approve commission txn_abc123
Reject commission txn_xyz due to fraud
Mark commission txn_123 as refunded
Update commission txn_456 amount to $75

Response

## Commission Updated

**txn_abc123** has been updated:
- Status: PENDING → APPROVED

This commission is now ready for payout.

affonso_delete_commission

This is a destructive operation. Commissions that have been paid cannot be deleted.

Parameters

string

required

The commission ID to delete

string

default:"markdown"

Response format: markdown or json

Example Prompts

Delete commission txn_abc123
Remove commission txn_test456

Response

## Commission Deleted

Commission **txn_abc123** has been permanently deleted.

Bulk Operations

Approve Multiple Commissions

"List all pending commissions from before January 1st"
"Approve commissions txn_abc, txn_def, and txn_ghi"

Monthly Commission Report

"Show me all approved commissions from last month grouped by affiliate"
"What's the total commission amount for January?"

Error Handling

Error	Cause	Solution
`NOT_FOUND`	Commission ID doesn’t exist	Verify the ID is correct
`ALREADY_PAID`	Cannot modify paid commission	Commission is locked after payout
`INVALID_TRANSITION`	Invalid status change	Check allowed status transitions
`PERMISSION_DENIED`	Missing required scope	Check your API key permissions

Getting Started

Setup

Tools

Overview

Available Tools

Commission Statuses

affonso_list_commissions

Parameters

Example Prompts

Response

affonso_get_commission

Parameters

Example Prompts

Response

affonso_create_commission

Parameters

Example Prompts

Response

affonso_update_commission

Parameters

Example Prompts

Response

affonso_delete_commission

Parameters

Example Prompts

Response

Bulk Operations

Approve Multiple Commissions

Monthly Commission Report

Error Handling

​Overview

​Available Tools

​Commission Statuses

​affonso_list_commissions

​Parameters

​Example Prompts

​Response

​affonso_get_commission

​Parameters

​Example Prompts

​Response

​affonso_create_commission

​Parameters

​Example Prompts

​Response

​affonso_update_commission

​Parameters

​Example Prompts

​Response

​affonso_delete_commission

​Parameters

​Example Prompts

​Response

​Bulk Operations

​Approve Multiple Commissions

​Monthly Commission Report

​Error Handling

Overview

Available Tools

Commission Statuses

affonso_list_commissions

Parameters

Example Prompts

Response

affonso_get_commission

Parameters

Example Prompts

Response

affonso_create_commission

Parameters

Example Prompts

Response

affonso_update_commission

Parameters

Example Prompts

Response

affonso_delete_commission

Parameters

Example Prompts

Response

Bulk Operations

Approve Multiple Commissions

Monthly Commission Report

Error Handling