Crm · Compensation
Get contributor compensation
Gets a contributor’s compensation and the rates and allowance limits that can be assigned. It takes an organization ID and a contact ID. Compensation is null when none is found; rates and limits are null when unavailable.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
mandate.read. - The caller needs
compensationClaim.read. - The caller needs
contact:contributor.read. - The contact lookup is subject to a mandate filter based on the caller’s organization access.
Request
Path parameters
-
organizationIdidrequired -
contactIdidrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/contributors/YOUR_CONTACT_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/contributors/YOUR_CONTACT_ID", {
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/crm/compensation/contributors/YOUR_CONTACT_ID', 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
-
compensationobjectnullablecompensationis null when the contact is not found or has no contributor compensation.4 properties
-
activeboolean -
ratesid[]at most 50 items
-
limitAmountsobject[]at most 10 items
2 properties
-
limitid -
amountinteger0–9999999
-
-
socialInsuranceNumberstringnullablepattern
^\d{10}$
-
-
ratesobject[]nullableratesis null when compensation settings or their rates are absent.10 properties
-
_idid -
typestringhourlyflatmileage -
labelstring1–60 characters
-
amountinteger0–999999
-
accountinteger1–999999999
-
costCenter1numbernullable1–99999999
-
costCenter2numbernullable1–99999999
-
activeboolean -
limitidnullable -
oncePerEntryboolean
-
-
limitsobject[]nullablelimitsis null when compensation settings or their limits are absent.5 properties
-
_idid -
labelstring1–60 characters
-
amountintegerat most 9999999
-
dailyAmountintegernullableat most 9999999
-
monthlyAmountintegernullableat most 9999999
-
{
"compensation": {
"active": true,
"rates": [
"000000000000000000000001"
],
"limitAmounts": [
{
"limit": "000000000000000000000001",
"amount": 0
}
],
"socialInsuranceNumber": "string"
},
"rates": [
{
"_id": "000000000000000000000001",
"type": "hourly",
"label": "string",
"amount": 0,
"account": 1,
"costCenter1": 1,
"costCenter2": 1,
"active": true,
"limit": "000000000000000000000001",
"oncePerEntry": true
}
],
"limits": [
{
"_id": "000000000000000000000001",
"label": "string",
"amount": 1,
"dailyAmount": 1,
"monthlyAmount": 1
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.