Crm · Work hours
Settle work hours accounts
Settles up to 50 open accounts of ended periods. Missing approved work is billed with the fee of the rule as membership fee invoice of the payer’s debtor, collected by direct debit or paid by transfer like membership fees; accounts with nothing missing are settled without a receipt. Entries still waiting for review do not count. Fees are booked in the default mandate of the settings, otherwise in the given one. Accounts that cannot be settled are returned with the reason, the others are settled. Users limited to their assigned entries cannot settle accounts.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readworkHours.readworkHoursSettlement.edit
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
accountIdsid[]requiredat least 1 items
-
bookingMandateIdidrequirednullable -
sepaDirectDebitCashAccountIdidrequirednullable -
sepaCreditTransferCashAccountIdidrequirednullable -
sendReceiptsbooleanrequired
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/work-hours/accounts/settle' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/accounts/settle", {
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/work-hours/accounts/settle', 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
-
settledinteger -
failedobject[]2 properties
-
accountIdid -
messagestring
-
{
"settled": 1,
"failed": [
{
"accountId": "000000000000000000000001",
"message": "string"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.