List Commissions | Papertracc Docs

{
  "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
}

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.

Requires the can_view_sales_invoice permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring

The identity for the active workspace.

Query parameters

limitintegerOptional

Optional. Number of records to return.

statusenumOptional

Optional. Only accruals in this state. ACCRUED is what a run would pick up.

Allowed values:

sales_personnel_idstringOptionalformat: "uuid"

Optional. Only what this rep has earned.

invoice_idstringOptionalformat: "uuid"

Optional. Only what this invoice earned.

bill_idstringOptionalformat: "uuid"

Optional. Only the accruals a given commission bill settled.

fromdateOptional

Optional. Earliest accrued_at, inclusive.

todateOptional

Optional. Latest accrued_at, inclusive.

Response

datalist of objects

pageinteger

countinteger

pagesinteger

statusboolean

messagestring

keysetstring or nullOptional

last_idstring or nullOptional

Errors

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error