Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.affonso.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

ToolDescriptionPermission
affonso_list_commissionsList commission transactionsread:commissions
affonso_get_commissionGet a single commissionread:commissions
affonso_create_commissionCreate a new commissionwrite:commissions
affonso_update_commissionUpdate commission statuswrite:commissions
affonso_delete_commissionDelete a commissiondelete:commissions

​
Commission Statuses

StatusDescription
PENDINGCommission created, awaiting approval
APPROVEDCommission approved, ready for payout
PAIDCommission has been paid out
REJECTEDCommission was rejected
REFUNDEDCommission was refunded due to return/chargeback

​
affonso_list_commissions

List and filter commission transactions.

​
Parameters

​
page
number
default:"1"
Page number for pagination
​
limit
number
default:"50"
Results per page (max 100)
​
affiliateId
string
Filter by affiliate ID
​
status
string
Filter by status: PENDING, APPROVED, PAID, REJECTED, REFUNDED
​
startDate
string
Filter from date (ISO 8601)
​
endDate
string
Filter to date (ISO 8601)
​
responseFormat
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

​
affonso_get_commission

Get detailed information about a specific commission.

​
Parameters

​
id
string
required
The commission ID (starts with txn_)
​
responseFormat
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.

​
affonso_create_commission

Create a new commission transaction manually.

​
Parameters

​
affiliateId
string
required
The affiliate ID for this commission
​
amount
number
required
Commission amount in cents
​
saleAmount
number
Original sale amount in cents
​
referralId
string
Associated referral ID
​
status
string
default:"PENDING"
Initial status: PENDING, APPROVED
​
description
string
Description or notes
​
responseFormat
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

​
id
string
required
The commission ID to update
​
status
string
New status: PENDING, APPROVED, REJECTED, REFUNDED
​
amount
number
Updated commission amount in cents
​
description
string
Updated description
​
responseFormat
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

​
id
string
required
The commission ID to delete
​
responseFormat
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

ErrorCauseSolution
NOT_FOUNDCommission ID doesn’t existVerify the ID is correct
ALREADY_PAIDCannot modify paid commissionCommission is locked after payout
INVALID_TRANSITIONInvalid status changeCheck allowed status transitions
PERMISSION_DENIEDMissing required scopeCheck your API key permissions