Skip to content
campaiDeveloper
campai.com

Crm ยท Compensation

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

Approve compensation claim

Approves a submitted compensation claim. A positive claim is booked as expense receipt for the contact creditor with the claim document attached and, when the booking mandate has a default transfer account, a credit transfer for the payout. The part the contributor waived is not paid out but recorded as their pending donation, booked from the same expense accounts on the waiver account of the settings. The booking mandate is the default mandate of the compensation settings, otherwise the given one, which is only optional when the approver can access a single mandate. Fails when the approver is the contributor.

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • claimIdidrequired

Body

Content-Type: application/json

  • bookingMandateIdidnullable
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/approve' \
  --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.