Donation · Donations
Merge donations
Merges 2 to 100 selected donations from the same mandate, donator and calendar year. The donation with the earliest position date keeps its number, and the response contains its _id and number.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access and the
mandate.read,donation.editanddonation.removepermissions.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
donationIdsid[]required2–100 items
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/mergeDonations' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/mergeDonations", {
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/donation/donations/mergeDonations', 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
-
_idid -
numberstringat least 1 characters
Response200
{
"_id": "000000000000000000000001",
"number": "string"
}
What else happens
- The retained donation receives the combined positions and distinct receipt numbers.
- The other selected donations are deleted.
- For moved positions with cash transaction bookings, matching cash transaction assignments are updated to refer to the retained donation.
- Statistics are updated for campaigns referenced by the merged positions.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | Confirmed donations have to be revoked before they can be merged. | If a donation has a confirmation status other than pending or notRequired, the endpoint returns HTTP 400 with key donation.mergeDonations.alreadyConfirmed. |
| 400 | Donations with and without a wanted confirmation can not be merged. Align their confirmation first. | If the donations have different confirmation statuses, the endpoint returns HTTP 400 with key donation.mergeDonations.differentConfirmation. |
| 400 | Donations of unknown donators can not be merged. | If any donation has an unknown donator, the endpoint returns HTTP 400 with key donation.mergeDonations.unknownDonator. |
| 400 | Only donations of the same donator can be merged. | If the donations have different donators, the endpoint returns HTTP 400 with key donation.mergeDonations.differentDonators. |
| 400 | Only donations of the same calendar year can be merged. | If the position dates span different UTC calendar years, the endpoint returns HTTP 400 with key donation.mergeDonations.differentYears. |
| 400 | Non-cash donations always get a confirmation of their own and can not be merged. | If a position is a non-cash donation, the endpoint returns HTTP 400 with key donation.mergeDonations.nonCash. |
| 404 | A mandate needs to be provided | If the mandate ID is a null object ID, the endpoint returns HTTP 404 with key organization.getMandate.nullMandateId. |
| 404 | Mandate mandate ID not found | If the mandate is not found in the organization, the endpoint returns HTTP 404 with key organization.getMandate.notFound. |
| 404 | Select at least two donations of the same mandate. Revoked donations can not be merged. | If fewer than two eligible donations are found, or not all selected donations are found in the organization and mandate without being revoked, the endpoint returns HTTP 404 with key donation.mergeDonations.noDonations. |
Marked words such as mandate ID are filled in with the actual value when the error happens.
Errors nearly every request can meet are listed under Errors.