Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/crm/compensation/settings

Update compensation settings

Creates or updates the compensation claim settings of an organization. Saving the settings enables compensation claims. The period length cannot change while submitted claims or claims with entries overlap the current period of the new length; empty drafts overlapping it are deleted and opened again with the new length. Organizations without accounting always book on the default compensation accounts of their accounting plan, others where no account is given. Approved claims are booked in the default mandate, or without one in the mandate chosen on approval; changing it requires access to the previous and the new default mandate, and with one, cost centers must be bookable in it. Contributors can only donate claims (waiver) with monthly or quarterly periods, set up donations and in countries whose donations know waived reimbursements; the donations are booked on the waiver revenue account. Entry fields are what contributors fill in for hours and flat rate entries, in the given order; dropdowns need at least one option. Changed fields also apply to draft claims, while submitted and approved claims keep theirs.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • crmSettings.edit
Also checked, depending on the request and the records it touches
  • mandate.read

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • cadencestringrequired
    month quarter halfYear year
  • submissionDeadlineDaysintegerrequired

    0–90

  • reminderDaysBeforeDeadlineintegerrequired

    0–30

  • entryFieldsobject[]required

    at most 10 items

    6 properties
    • _ididrequired
    • typestringrequired
      text select multiSelect
    • labelstringrequired

      1–60 characters

    • entryTypesstring[]required

      at most 4 items

      hours flatRates mileage expenses
    • requiredbooleanrequired
    • optionsstring[]required

      at most 50 items · each 1–100 characters

  • expensesobjectrequired
    6 properties
    • enabledbooleanrequired
    • accountintegerrequirednullable

      1–999999999

    • costCenter1numberrequirednullable

      1–99999999

    • costCenter2numberrequirednullable

      1–99999999

    • maxAmountintegerrequirednullable

      at most 9999999999

    • receiptRequiredbooleanrequired
  • correctionAccountintegerrequirednullable

    1–999999999

  • correctionCostCenter1numberrequirednullable

    1–99999999

  • correctionCostCenter2numberrequirednullable

    1–99999999

  • waiverobjectrequired
    2 properties
    • enabledbooleanrequired
    • accountintegerrequirednullable

      1–999999999

  • declarationTextstringrequired

    at most 4000 characters

  • reviewerUserIdsstring[]required

    at most 50 items · each at least 1 characters

  • defaultMandateidrequirednullable
  • ratesobject[]required

    at most 50 items

    10 properties
    • _idid
    • typestringrequired
      hourly flat mileage
    • labelstringrequired

      1–60 characters

    • amountintegerrequired

      0–999999

    • accountintegerrequirednullable

      1–999999999

    • costCenter1numberrequirednullable

      1–99999999

    • costCenter2numberrequirednullable

      1–99999999

    • activebooleanrequired
    • limitidrequirednullable
    • oncePerEntrybooleanrequired
  • limitsobject[]required

    at most 10 items

    5 properties
    • _ididrequired
    • labelstringrequired

      1–60 characters

    • amountintegerrequired

      at most 9999999

    • dailyAmountintegerrequirednullable

      at most 9999999

    • monthlyAmountintegerrequirednullable

      at most 9999999

  • reviewerRulesobject[]required

    at most 50 items

    2 properties
    • conditionobjectrequired
      2 properties
      • operatorstringrequired
        and or
      • conditions(object (recursive) | object)[]required

        at least 1 items

        4 properties
        • leftobject | object of anyrequired
          Variant 1: 1 property
          • variablestringrequired

            at least 1 characters

          Variant 2: 4 properties
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

          • lookupobjectrequirednullable
            1 property
            • variablestringrequired

              at least 1 characters

          • arraybooleanrequired
          • selectobject (recursive)required
          Variant 3: 2 properties
          • funcstringrequired
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • paramsobject (recursive)[]
          Variant 4: 1 property
          • literalnumber[] | numberrequired
          Variant 5: 3 properties
          • ifobject (recursive)required
          • thenobject (recursive)required
          • elseobject (recursive)required
        • cmpFuncstringrequired
          15 values
          eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
        • rightobject | object of any
          Variant 1: 1 property
          • variablestringrequired

            at least 1 characters

          Variant 2: 4 properties
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

          • lookupobjectrequirednullable
            1 property
            • variablestringrequired

              at least 1 characters

          • arraybooleanrequired
          • selectobject (recursive)required
          Variant 3: 2 properties
          • funcstringrequired
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • paramsobject (recursive)[]
          Variant 4: 1 property
          • literalnumber[] | numberrequired
          Variant 5: 3 properties
          • ifobject (recursive)required
          • thenobject (recursive)required
          • elseobject (recursive)required
        • negateboolean
    • reviewerUserIdsstring[]required

      1–50 items · each at least 1 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/settings' \
  --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

No response body is specified.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.