Skip to content
campaiDeveloper
campai.com

Crm ยท Compensation

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

Check compensation claim

Marks a submitted compensation claim as checked, with a review message, while leaving the claim submitted. A claim that is already checked is left unchanged. The endpoint returns no response body.

Permissions

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

Who may call it

  • Organization access is required.
  • The caller needs mandate.read.
  • The caller needs compensationClaim.edit.
  • The claim lookup is subject to the caller's mandate access filter.
  • The claim lookup is subject to the assigned-only access filter for compensationClaim.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • claimIdidrequired

Body

Content-Type: application/json

  • messagestringrequirednullable

    at most 2000 characters

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/check' \
  --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.

What else happens

  • For an unchecked submitted claim, the endpoint adds a checked review with the time, actor and trimmed message. A blank or missing message is stored as null.
  • Checking an already checked claim adds no review.
  • Checking leaves the claim's update time unchanged.

Errors

Other errors

StatusErrorWhen
400This claim can no longer be changed.If the claim is not already checked and the update does not match a submitted claim, the endpoint returns 400 with compensation.errors.notEditable.
404Claim not found.If the claim is not found, the endpoint returns 404 with compensation.errors.claimNotFound.

Errors nearly every request can meet are listed under Errors.