Skip to content
campaiDeveloper
campai.com

Crm ยท Compensation

GET/{organizationId}/{mandateId}/crm/compensation/claim-countersReads only

Get compensation claim counters

Returns whether compensation claims are set up, how many claims were submitted this month and in the same days of the previous month, how many submitted claims wait for review, and how many drafts missed their deadline. Users limited to their assigned claims only get the figures of those

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.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/compensation/claim-counters' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • enabledboolean
  • submittedThisMonthinteger

    at least 0

  • previousMonthSubmittedinteger

    at least 0

  • toReviewinteger

    at least 0

  • overdueinteger

    at least 0

Response200
{
  "enabled": true,
  "submittedThisMonth": 0,
  "previousMonthSubmitted": 0,
  "toReview": 0,
  "overdue": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.