Skip to content
campaiDeveloper
campai.com

Donation

GET/{organizationId}/donation/settingsReads only

Get donation settings

Gets donation settings for the organization identified by organizationId. Returns the organization's donation settings, including confirmation and country settings.

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.
  • The caller needs the donationsSettings.read permission.

Request

Path parameters

  • organizationIdidrequired

Query parameters

  • modifiedBeforestring · date-time
  • modifiedAfterstring · date-time
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/donation/settings' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • membershipFeesboolean
  • invoiceDonationAccountsinteger[]

    each 1–999999999

  • numberStartinteger

    1–99999999

  • overpaymentDonationsboolean
  • countrySettingsobject
    5 properties
    • deobject
      6 properties
      • signaturestring

        at most 30000 characters

      • purposestring

        at most 300 characters

      • onlineGeneratedMessagestring

        1–400 characters

      • requireAddressAboveAmountnumber

        at least 0

      • exemptionNoticeobjectnullable
        2 properties
        • fromstring
        • assessmentPeriodstring
      • determinationNoticeobjectnullable
        1 property
        • fromstring
    • luobject
      6 properties
      • signaturestring

        at most 30000 characters

      • purposestring

        at most 300 characters

      • onlineGeneratedMessagestring

        1–400 characters

      • requireAddressAboveAmountnumber

        at least 0

      • exemptionNoticeobjectnullable
        2 properties
        • fromstring
        • assessmentPeriodstring
      • determinationNoticeobjectnullable
        1 property
        • fromstring
    • chobject
      6 properties
      • signaturestring

        at most 30000 characters

      • purposestring

        at most 300 characters

      • onlineGeneratedMessagestring

        1–400 characters

      • requireAddressAboveAmountnumber

        at least 0

      • exemptionNoticeobjectnullable
        2 properties
        • fromstring
        • assessmentPeriodstring
      • determinationNoticeobjectnullable
        1 property
        • fromstring
    • atobject
      3 properties
      • fastNrOrgnumbernullable

        at most 999999999

      • bankParticipantIdstring

        at most 50 characters

      • orgTypestringnullable
        24 values
        AS BI FF FW GM KK KR MÖ MP NT ÖK ÖS PA PK PS SE SG SN SO SP SV UN ZG ZI
    • usany
  • confirmationobject
    9 properties
    • enabledboolean
    • sendboolean
    • templateid
    • useDocumentOnlyForLettersboolean
    • documentContentstring

      at most 4000 characters

    • fileNamePrefixstring

      1–40 characters

    • subjectstring

      1–998 characters

    • messagestring

      1–10000 characters

    • thankYouobject
      6 properties
      • thresholdintegernullable

        at most 9999999999

      • onlyThankYouLettersboolean
      • documentContentstring

        at most 4000 characters

      • fileNamePrefixstring

        1–40 characters

      • subjectstring

        1–998 characters

      • messagestring

        1–10000 characters

Response200
{
  "membershipFees": true,
  "invoiceDonationAccounts": [
    1
  ],
  "numberStart": 1,
  "overpaymentDonations": true,
  "countrySettings": {
    "de": {
      "signature": "string",
      "purpose": "string",
      "onlineGeneratedMessage": "string",
      "requireAddressAboveAmount": 0,
      "exemptionNotice": {
        "from": "string",
        "assessmentPeriod": "string"
      },
      "determinationNotice": {
        "from": "string"
      }
    },
    "lu": {
      "signature": "string",
      "purpose": "string",
      "onlineGeneratedMessage": "string",
      "requireAddressAboveAmount": 0,
      "exemptionNotice": {
        "from": "string",
        "assessmentPeriod": "string"
      },
      "determinationNotice": {
        "from": "string"
      }
    },
    "ch": {
      "signature": "string",
      "purpose": "string",
      "onlineGeneratedMessage": "string",
      "requireAddressAboveAmount": 0,
      "exemptionNotice": {
        "from": "string",
        "assessmentPeriod": "string"
      },
      "determinationNotice": {
        "from": "string"
      }
    }
  },
  "confirmation": {
    "enabled": true,
    "send": true,
    "template": "000000000000000000000001",
    "useDocumentOnlyForLetters": true,
    "documentContent": "string",
    "fileNamePrefix": "string",
    "subject": "string",
    "message": "string",
    "thankYou": {
      "threshold": 1,
      "onlyThankYouLetters": true,
      "documentContent": "string",
      "fileNamePrefix": "string",
      "subject": "string",
      "message": "string"
    }
  }
}

Errors

Other errors

StatusErrorWhen
404Donations settings are missingIf donation settings are missing, the endpoint returns HTTP 404 NOT_FOUND with message key donation.settings.getDonationsSettings.notFound.

Errors nearly every request can meet are listed under Errors.