Skip to content
campaiDeveloper
campai.com

Donation · Donations

POST/{organizationId}/{mandateId}/donation/donations/mergeDonations

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.edit and donation.remove permissions.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • donationIdsid[]required

    2–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'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • _idid
  • numberstring

    at 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

StatusErrorWhen
400Confirmed 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.
400Donations 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.
400Donations of unknown donators can not be merged.If any donation has an unknown donator, the endpoint returns HTTP 400 with key donation.mergeDonations.unknownDonator.
400Only donations of the same donator can be merged.If the donations have different donators, the endpoint returns HTTP 400 with key donation.mergeDonations.differentDonators.
400Only 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.
400Non-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.
404A mandate needs to be providedIf the mandate ID is a null object ID, the endpoint returns HTTP 404 with key organization.getMandate.nullMandateId.
404Mandate mandate ID not foundIf the mandate is not found in the organization, the endpoint returns HTTP 404 with key organization.getMandate.notFound.
404Select 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.