curl --request GET \
--url https://coreapi.io/api/commissions/plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/commissions/plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/commissions/plans/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/commissions/plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"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"
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}Get a commission plan
Beta. This endpoint is unstable and may still change without notice. Pin against the dated version and watch the changelog.
Fetch a single commission plan by id.
curl --request GET \
--url https://coreapi.io/api/commissions/plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/commissions/plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/commissions/plans/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/commissions/plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"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"
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}{
"status": 404,
"type": "PLAN__NOT_FOUND",
"title": "An error occurred",
"detail": "Plan not found."
}Autorisierungen
Bearer token of your Organisation with the commission-plans permission (read for GET, write for POST/PUT/DELETE). Send it as Authorization: Bearer .
Pfadparameter
The commission plan id.
Antwort
The commission plan.
Base commission rate as a decimal fraction.
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
War diese Seite hilfreich?