Skip to content
campaiDeveloper
campai.com

Crm ยท Compensation

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

Revoke compensation claim approval

Moves an approved compensation claim back to review, cancels its receipt and removes the donation of its waiver. With a return deadline, the claim goes back to the contributor for changes instead, who then sees the message and declares any waiver again. Only possible while the receipt is unpaid, its credit transfer was not submitted and the donation is not confirmed.

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
  • compensationClaimApproval.edit
Also checked, depending on the request and the records it touches
  • receipt.edit

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • claimIdidrequired

Body

Content-Type: application/json

  • messagestringrequirednullable

    at most 2000 characters

  • returnDeadlineAtstringrequirednullable
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/revoke' \
  --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.