Zum Hauptinhalt springen
GET
/
api
/
commissions
/
plans
/
{id}
Get a commission plan
curl --request GET \
  --url https://coreapi.io/api/commissions/plans/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "percentage": "<string>",
  "basisType": "<string>",
  "triggerEvent": "<string>",
  "commissionScope": "<string>",
  "requireDeal": true,
  "payoutThresholdAmount": {
    "amount": 123,
    "displayAmount": 123,
    "currency": "<string>",
    "precision": 123
  },
  "monthlyRevenueThreshold": {
    "amount": 123,
    "displayAmount": 123,
    "currency": "<string>",
    "precision": 123
  },
  "isActive": true,
  "rules": [
    {
      "id": "<string>",
      "productId": "<string>",
      "externalProductReference": "<string>",
      "percentage": "<string>",
      "priority": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Autorisierungen

Authorization
string
header
erforderlich

Bearer token of your Organisation with the commission-plans permission (read for GET, write for POST/PUT/DELETE). Send it as Authorization: Bearer .

Pfadparameter

id
string
erforderlich

The commission plan id.

Antwort

The commission plan.

id
string
name
string
type
string
percentage
string | null

Base commission rate as a decimal fraction.

basisType
string | null
triggerEvent
string
commissionScope
string
requireDeal
boolean
payoutThresholdAmount
object

Minimum commission a sales rep must accumulate on this plan within a calendar month for that month's commissions to be paid out. Evaluated per sales rep, per plan, per month. Null means no minimum.

monthlyRevenueThreshold
object

Minimum invoice revenue a sales rep must generate on this plan within a calendar month before any commission for that month is paid out. If the revenue stays below this, the whole month is withheld. Evaluated per sales rep, per plan, per month. Null means no minimum.

isActive
boolean
rules
object[]
createdAt
string<date-time>
updatedAt
string<date-time>