Crm · Compensation
Update compensation settings
Creates or updates the compensation claim settings of an organization. Saving the settings enables compensation claims. The period length cannot change while submitted claims or claims with entries overlap the current period of the new length; empty drafts overlapping it are deleted and opened again with the new length. Organizations without accounting always book on the default compensation accounts of their accounting plan, others where no account is given. Approved claims are booked in the default mandate, or without one in the mandate chosen on approval; changing it requires access to the previous and the new default mandate, and with one, cost centers must be bookable in it. Contributors can only donate claims (waiver) with monthly or quarterly periods, set up donations and in countries whose donations know waived reimbursements; the donations are booked on the waiver revenue account. Entry fields are what contributors fill in for hours and flat rate entries, in the given order; dropdowns need at least one option. Changed fields also apply to draft claims, while submitted and approved claims keep theirs.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
crmSettings.edit
Also checked, depending on the request and the records it touches
mandate.read
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
cadencestringrequiredmonthquarterhalfYearyear -
submissionDeadlineDaysintegerrequired0–90
-
reminderDaysBeforeDeadlineintegerrequired0–30
-
entryFieldsobject[]requiredat most 10 items
6 properties
-
_ididrequired -
typestringrequiredtextselectmultiSelect -
labelstringrequired1–60 characters
-
entryTypesstring[]requiredat most 4 items
hoursflatRatesmileageexpenses -
requiredbooleanrequired -
optionsstring[]requiredat most 50 items · each 1–100 characters
-
-
expensesobjectrequired6 properties
-
enabledbooleanrequired -
accountintegerrequirednullable1–999999999
-
costCenter1numberrequirednullable1–99999999
-
costCenter2numberrequirednullable1–99999999
-
maxAmountintegerrequirednullableat most 9999999999
-
receiptRequiredbooleanrequired
-
-
correctionAccountintegerrequirednullable1–999999999
-
correctionCostCenter1numberrequirednullable1–99999999
-
correctionCostCenter2numberrequirednullable1–99999999
-
waiverobjectrequired2 properties
-
enabledbooleanrequired -
accountintegerrequirednullable1–999999999
-
-
declarationTextstringrequiredat most 4000 characters
-
reviewerUserIdsstring[]requiredat most 50 items · each at least 1 characters
-
defaultMandateidrequirednullable -
ratesobject[]requiredat most 50 items
10 properties
-
_idid -
typestringrequiredhourlyflatmileage -
labelstringrequired1–60 characters
-
amountintegerrequired0–999999
-
accountintegerrequirednullable1–999999999
-
costCenter1numberrequirednullable1–99999999
-
costCenter2numberrequirednullable1–99999999
-
activebooleanrequired -
limitidrequirednullable -
oncePerEntrybooleanrequired
-
-
limitsobject[]requiredat most 10 items
5 properties
-
_ididrequired -
labelstringrequired1–60 characters
-
amountintegerrequiredat most 9999999
-
dailyAmountintegerrequirednullableat most 9999999
-
monthlyAmountintegerrequirednullableat most 9999999
-
-
reviewerRulesobject[]requiredat most 50 items
2 properties
-
conditionobjectrequired2 properties
-
operatorstringrequiredandor -
conditions(object (recursive) | object)[]requiredat least 1 items
4 properties
-
leftobject | object of anyrequiredVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
cmpFuncstringrequired15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
negateboolean
-
-
-
reviewerUserIdsstring[]required1–50 items · each at least 1 characters
-
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/settings' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/settings", {
method: "POST",
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' => 'POST',
'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/settings', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.