> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.papertracc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.papertracc.com/_mcp/server.

# List Commissions

GET https://api.papertracc.com/v1/commissions?limit=20

Lists commission accruals, newest first by `accrued_at`. Read-only: rows are written when an invoice carrying a sales personnel is posted, and settled when a commission run bills them. A clawback appears as its own row with a negative `amount`, so a rep's balance is the sum of their rows.

The `X-Total-Amount` response header carries the net total for the whole filter, not just the page in hand.

Each row carries `sales_personnel`. The document objects (`invoice`, `receipt`, `bill`, `account`) are resolved on the single-commission endpoint only.

Reference: https://api-docs.papertracc.com/papertracc/sales/commissions/list-commissions

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.
- `identity` header (required) — The identity for the active project.

## Servers

- `https://api.papertracc.com/v1` (Production, default)
- `https://api.papertracc.com/rc-1` (Release Candidate 1)

## Request

### Query parameters

- `limit` (integer, optional) — Optional. Number of records to return.
- `status` (enum, optional) — Optional. Only accruals in this state. `ACCRUED` is what a run would pick up.
  - Allowed values: `ACCRUED`, `BILLED`, `PAID`, `REVERSED`
- `sales_personnel_id` (string, optional) — Optional. Only what this rep has earned.
- `invoice_id` (string, optional) — Optional. Only what this invoice earned.
- `bill_id` (string, optional) — Optional. Only the accruals a given commission bill settled.
- `from` (date, optional) — Optional. Earliest `accrued_at`, inclusive.
- `to` (date, optional) — Optional. Latest `accrued_at`, inclusive.

## Response

### 200

OK

- `data` (list of object, required)
  - `id` (string, required)
  - `project_id` (string, required)
  - `sales_personnel_id` (string, required)
  - `rate_type` (enum, required)
    - Allowed values: `PERCENTAGE_RATE`, `FLAT_RATE`
  - `basis` (enum, required)
    - Allowed values: `SUBTOTAL`, `TOTAL`, `MARGIN`
  - `status` (enum, required)
    - Allowed values: `ACCRUED`, `BILLED`, `PAID`, `REVERSED`
  - `currency_code` (string, required)
  - `rate` (string, required)
  - `basis_amount` (string, required) — The figure the rate was applied to.
  - `amount` (string, required) — What the rep earned. Negative on a clawback.
  - `exchange_rate` (string, required)
  - `accrued_at` (datetime, required) — When the commission was earned, not when the row was written. Filter on this with from/to.
  - `created_at` (datetime, required)
  - `vendor_id` (string, optional, nullable)
  - `invoice_id` (string, optional, nullable)
  - `receipt_id` (string, optional, nullable)
  - `bill_id` (string, optional, nullable)
  - `journal_entry_id` (string, optional, nullable)
  - `reversal_of` (string, optional, nullable) — Set on a clawback row, pointing at the accrual it reverses.
  - `account_id` (string, optional, nullable)
  - `sales_personnel` (object, optional, nullable) — The rep the commission belongs to.
    - `id` (string, optional)
    - `contact_id` (string, optional, nullable)
    - `project_id` (string, optional)
    - `display_name` (string, optional)
    - `first_name` (string, optional, nullable)
    - `last_name` (string, optional, nullable)
    - `email` (string, optional, nullable)
    - `phone` (string, optional, nullable)
    - `is_active` (boolean, optional)
    - `commission` (object, optional, nullable) — The rep's own default terms, which an invoice may override.
      - `rate_type` (string, optional)
      - `basis` (string, optional)
      - `rate` (string, optional)
    - `created_at` (datetime, optional)
- `page` (integer, required)
- `count` (integer, required)
- `pages` (integer, required)
- `status` (boolean, required)
- `message` (string, required)
- `keyset` (string, optional, nullable)
- `last_id` (string, optional, nullable)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "6b7d54b0-b53c-4ceb-b60f-b81c3ecb42db",
      "project_id": "spruce-demo",
      "sales_personnel_id": "acb38c3f-87e1-4392-abe8-97a5ebf199a0",
      "rate_type": "PERCENTAGE_RATE",
      "basis": "SUBTOTAL",
      "status": "ACCRUED",
      "currency_code": "NGN",
      "rate": "15",
      "basis_amount": "7500.00",
      "amount": "1125.00",
      "exchange_rate": "1",
      "accrued_at": "2026-07-29T23:00:00Z",
      "created_at": "2026-08-01T19:54:11.239121Z",
      "vendor_id": null,
      "invoice_id": "005c4076-5062-45ab-af01-aaf78c0197b0",
      "receipt_id": null,
      "bill_id": null,
      "journal_entry_id": "97df71d5-ec2e-4bf7-9f0b-cafd73bdff28",
      "reversal_of": null,
      "account_id": "47797956-a827-4e10-a222-20b3d6b2518a",
      "sales_personnel": {
        "id": "acb38c3f-87e1-4392-abe8-97a5ebf199a0",
        "contact_id": "26a34c73-5353-4f1e-b4aa-0740105f64f4",
        "project_id": "spruce-demo",
        "display_name": "Jane Smith",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@example.com",
        "phone": "+2348023456789",
        "is_active": true,
        "commission": {
          "rate_type": "PERCENTAGE_RATE",
          "basis": "SUBTOTAL",
          "rate": "15"
        },
        "created_at": "2026-06-18T10:00:00Z"
      }
    }
  ],
  "page": 1,
  "count": 1,
  "pages": 1,
  "status": true,
  "message": "Successfully fetched commissions",
  "keyset": null,
  "last_id": null
}
```

**SDK Code**

```python Sales_Commissions_List Commissions_example
import requests

url = "https://api.papertracc.com/v1/commissions"

querystring = {"from":"2026-01-01","limit":"20","to":"2026-12-31"}

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Sales_Commissions_List Commissions_example
const url = 'https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Sales_Commissions_List Commissions_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Sales_Commissions_List Commissions_example
require 'uri'
require 'net/http'

url = URI("https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java Sales_Commissions_List Commissions_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php Sales_Commissions_List Commissions_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Sales_Commissions_List Commissions_example
using RestSharp;

var client = new RestClient("https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Sales_Commissions_List Commissions_example
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.papertracc.com/v1/commissions?from=2026-01-01&limit=20&to=2026-12-31")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```