Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/{mandateId}/crm/compensation/claims/{claimId}

Update compensation claim

Replaces the entries, payout account and corrections of a draft or submitted compensation claim on behalf of the contributor, who is notified when entries or corrections changed. Changes are recorded in the claim history. Changing the payout account also requires the right to edit creditors.

Permissions

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

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • claimIdidrequired

Body

Content-Type: application/json

  • hoursobject[]required

    at most 500 items

    8 properties
    • _idid
    • datestringrequired
    • startTimestringrequired

      pattern ^(([01]\d|2[0-3]):[0-5][05]|24:00)$

    • endTimestringrequired

      pattern ^(([01]\d|2[0-3]):[0-5][05]|24:00)$

    • rateidrequired
    • fieldsobject[]required

      at most 50 items

      2 properties
      • fieldidrequired
      • valuesstring[]required

        1–50 items · each 1–100 characters

    • detailsstringrequired

      at most 500 characters

    • eventidrequirednullable
  • flatRatesobject[]required

    at most 200 items

    7 properties
    • _idid
    • datestringrequired
    • rateidrequired
    • quantitynumberrequired

      0.5–99

    • fieldsobject[]required

      at most 50 items

      2 properties
      • fieldidrequired
      • valuesstring[]required

        1–50 items · each 1–100 characters

    • detailsstringrequired

      at most 500 characters

    • eventidrequirednullable
  • mileageobject[]required

    at most 200 items

    7 properties
    • _idid
    • datestringrequired
    • rateidrequired
    • distanceintegerrequired

      1–9999

    • purposestringrequired

      2–100 characters

    • fieldsobject[]required

      at most 50 items

      2 properties
      • fieldidrequired
      • valuesstring[]required

        1–50 items · each 1–100 characters

    • detailsstringrequired

      at most 500 characters

  • expensesobject[]required

    at most 100 items

    7 properties
    • _idid
    • datestringrequired
    • amountintegerrequired

      at most 9999999999

    • descriptionstringrequired

      2–100 characters

    • filesobject[]required

      at most 5 items

      3 properties
      • fileNamestring

        at most 128 characters

      • resourcestringrequired
      • idstring

        exactly 6 characters

    • fieldsobject[]required

      at most 50 items

      2 properties
      • fieldidrequired
      • valuesstring[]required

        1–50 items · each 1–100 characters

    • detailsstringrequired

      at most 500 characters

  • payeeobjectnullable
    3 properties
    • accountHolderNamestringrequired

      at most 80 characters

    • ibanstring · ibanrequired
    • bicstringrequired
  • correctionsobject[]required

    at most 50 items

    4 properties
    • descriptionstringrequired

      2–100 characters

    • amountintegerrequired
    • _idid
    • limitidrequirednullable
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/crm/compensation/claims/YOUR_CLAIM_ID' \
  --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.