Crm · Compensation
Get contributor compensation summary
Returns a contributor’s compensation summary for a year, using organizationId, nullable mandateId, contactId and a year from 2000 to 2999. It includes approved and open claim counts, approved claim amounts and minutes, waivers, and yearly allowance-limit usage across mandates. The summary is null if the contributor has no claims in that year.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access is required.
- The
mandate.readpermission is required. - The
compensationClaim.readpermission is required.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
contactIdidrequired
Query parameters
-
yearintegerrequired2000–2999
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/contributors/YOUR_CONTACT_ID/summary' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/contributors/YOUR_CONTACT_ID/summary", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/contributors/YOUR_CONTACT_ID/summary', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
summaryobjectnullablesummaryis null when the contributor has no claims in the requested year.8 properties
-
approvedClaimsinteger -
openClaimsinteger -
minutesinteger -
allowanceinteger -
reimbursementinteger -
payoutinteger -
waiverinteger -
limitsobject[]5 properties
-
labelstring -
amountinteger -
usedinteger -
exemptinteger -
taxableinteger
-
-
Response200
{
"summary": {
"approvedClaims": 1,
"openClaims": 1,
"minutes": 1,
"allowance": 1,
"reimbursement": 1,
"payout": 1,
"waiver": 1,
"limits": [
{
"label": "string",
"amount": 1,
"used": 1,
"exempt": 1,
"taxable": 1
}
]
}
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.