Crm · Compensation
List compensation claims
Lists the compensation claims of all accessible mandates with the reviewers they are routed to, optionally filtered by year, period start and a property filter. Users limited to their assigned claims only get those. Also returns the billing cycle, null when compensation claims are not set up, and the default mandate approved claims are booked in.
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.read
Also checked, depending on the request and the records it touches
creditor.readuser.readapiKey.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.readcontact.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
yearinteger2000–2999
-
periodFromstring -
userFilterstringnullable -
limitinteger1–200 · default
50 -
offsetintegerat least 0 · default
0
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/claims' \
--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", {
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/claims', 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
-
claimsobject[]17 properties
-
_idid -
mandatesid[] -
numberstringat most 30 characters
-
periodobject4 properties
-
yearinteger2000–2999
-
indexinteger1–12
-
fromstring -
tostring
-
-
deadlineAtstring -
statusstringdraftsubmittedapproved -
totalAmountintegerat most 9999999999
-
submittedAtstring · date-timenullable -
submittedByobjectnullable -
submittedOnBehalfboolean -
approvedAtstring · date-timenullable -
approvedByobjectnullable -
receiptobjectnullable3 properties
-
_idid -
receiptNumberstringat most 30 characters
-
mandateid
-
-
contactobject -
checkedboolean -
creditorAccountintegernullable -
reviewersobject[]
-
-
countinteger -
cadencestringnullablemonthquarterhalfYearyear -
defaultMandateidnullable
Response200
{
"claims": [
{
"_id": "000000000000000000000001",
"mandates": [
"000000000000000000000001"
],
"number": "string",
"period": {
"year": 2000,
"index": 1,
"from": "string",
"to": "string"
},
"deadlineAt": "string",
"status": "draft",
"totalAmount": 1,
"submittedAt": "2026-06-15T22:30:00Z",
"submittedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
},
"submittedOnBehalf": true,
"approvedAt": "2026-06-15T22:30:00Z",
"approvedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
},
"receipt": {
"_id": "000000000000000000000001",
"receiptNumber": "string",
"mandate": "000000000000000000000001"
},
"contact": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
},
"checked": true,
"creditorAccount": 1,
"reviewers": [
{
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
}
]
}
],
"count": 1,
"cadence": "month",
"defaultMandate": "000000000000000000000001"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.