Crm · Compensation
Update compensation claim
Replaces the entries, payout account and corrections of a draft or submitted compensation claim on behalf of the contributor, who is notified when entries or corrections changed. Changes are recorded in the claim history. Changing the payout account also requires the right to edit creditors.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readcompensationClaim.edit
Also checked, depending on the request and the records it touches
creditor.edit
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
claimIdidrequired
Body
Content-Type: application/json
-
hoursobject[]requiredat most 500 items
8 properties
-
_idid -
datestringrequired -
startTimestringrequiredpattern
^(([01]\d|2[0-3]):[0-5][05]|24:00)$ -
endTimestringrequiredpattern
^(([01]\d|2[0-3]):[0-5][05]|24:00)$ -
rateidrequired -
fieldsobject[]requiredat most 50 items
2 properties
-
fieldidrequired -
valuesstring[]required1–50 items · each 1–100 characters
-
-
detailsstringrequiredat most 500 characters
-
eventidrequirednullable
-
-
flatRatesobject[]requiredat most 200 items
7 properties
-
_idid -
datestringrequired -
rateidrequired -
quantitynumberrequired0.5–99
-
fieldsobject[]requiredat most 50 items
2 properties
-
fieldidrequired -
valuesstring[]required1–50 items · each 1–100 characters
-
-
detailsstringrequiredat most 500 characters
-
eventidrequirednullable
-
-
mileageobject[]requiredat most 200 items
7 properties
-
_idid -
datestringrequired -
rateidrequired -
distanceintegerrequired1–9999
-
purposestringrequired2–100 characters
-
fieldsobject[]requiredat most 50 items
2 properties
-
fieldidrequired -
valuesstring[]required1–50 items · each 1–100 characters
-
-
detailsstringrequiredat most 500 characters
-
-
expensesobject[]requiredat most 100 items
7 properties
-
_idid -
datestringrequired -
amountintegerrequiredat most 9999999999
-
descriptionstringrequired2–100 characters
-
filesobject[]requiredat most 5 items
3 properties
-
fileNamestringat most 128 characters
-
resourcestringrequired -
idstringexactly 6 characters
-
-
fieldsobject[]requiredat most 50 items
2 properties
-
fieldidrequired -
valuesstring[]required1–50 items · each 1–100 characters
-
-
detailsstringrequiredat most 500 characters
-
-
payeeobjectnullable3 properties
-
accountHolderNamestringrequiredat most 80 characters
-
ibanstring · ibanrequired -
bicstringrequired
-
-
correctionsobject[]requiredat most 50 items
4 properties
-
descriptionstringrequired2–100 characters
-
amountintegerrequired -
_idid -
limitidrequirednullable
-
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/claims/YOUR_CLAIM_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/claims/YOUR_CLAIM_ID", {
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/YOUR_MANDATE_ID/crm/compensation/claims/YOUR_CLAIM_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;
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.