Donation ยท Donations
Import donations
Imports received donations without booking them, i.e. from an export of another system. Each donation is matched to the debtor with the given account, or to the only debtor with the same name and the same IBAN, email or zip. Otherwise the given donator data is used. Donations confirmed in the other system keep their status without creating a confirmation, rows matching an earlier donation by date, amount and donator are skipped. Equal rows of the same import are separate donations. Campaigns are matched by name, also unavailable ones, and created when missing
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonation.insert
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
donationsobject[]required1โ1000 items
15 properties
-
confirmationStatusstringrequiredpendingnotRequiredcreatedthanked -
typestringrequiredcashmembershipFeeassetStockrefund -
valueintegerrequiredat most 9999999999
-
datestringrequired -
descriptionstringrequiredat most 400 characters
-
donatorAccountintegerrequirednullable1โ999999999
-
donatorNamestringrequired1โ81 characters
-
donatorTypestringrequiredbusinessperson -
donatorEmailstringrequired -
addressLinestringrequiredat most 45 characters
-
addressDetailsstringrequiredat most 45 characters
-
zipstringrequiredat most 10 characters
-
citystringrequiredat most 45 characters
-
ibanstringrequiredat most 34 characters
-
campaignNamestringrequired
-
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/importDonations' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/importDonations", {
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/importDonations', 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
-
insertedintegerat least 0
-
duplicatesintegerat least 0
-
failedintegerat least 0
-
failuresobject[]2 properties
-
rowinteger -
messagestring
-
{
"inserted": 0,
"duplicates": 0,
"failed": 0,
"failures": [
{
"row": 1,
"message": "string"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.