Crm · Compensation
Export compensation claims
Exports the compensation claims of all accessible mandates as CSV or Excel, optionally filtered by year, period start, a property filter and a selection. Users limited to their assigned claims only get those. Large exports are queued and sent as a notification once ready. Contributor and user names are left out without access to contacts or users.
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
contact.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.readuser.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
formatstringrequiredcsvxlsx -
formatOptionsobject1 property
-
xlsxobject2 properties
-
arrayFormatstringlinecommacolumns -
unmergedGroupHeaderboolean
-
-
-
propertyPathsstring[]1–1000 items · each at least 1 characters
-
selectionobject2 properties
-
excludeIdsid[]1–1000 items
-
idsid[]1–1000 items
-
-
yearinteger2000–2999
-
periodFromstring -
userFilterstringnullableA stringified json object representing a property filter
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/export' \
--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/export", {
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/export', 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
Content-Type: application/json
object
{
"state": "empty"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.