Skip to content
campaiDeveloper
campai.com

Crm · Compensation

GET/{organizationId}/{mandateId}/crm/compensation/contributors/{contactId}/summaryReads only

Get contributor compensation summary

Returns a contributor’s compensation summary for a year, using organizationId, nullable mandateId, contactId and a year from 2000 to 2999. It includes approved and open claim counts, approved claim amounts and minutes, waivers, and yearly allowance-limit usage across mandates. The summary is null if the contributor has no claims in that year.

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 mandate.read permission is required.
  • The compensationClaim.read permission is required.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • contactIdidrequired

Query parameters

  • yearintegerrequired

    2000–2999

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/contributors/YOUR_CONTACT_ID/summary' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • summaryobjectnullable

    summary is null when the contributor has no claims in the requested year.

    8 properties
    • approvedClaimsinteger
    • openClaimsinteger
    • minutesinteger
    • allowanceinteger
    • reimbursementinteger
    • payoutinteger
    • waiverinteger
    • limitsobject[]
      5 properties
      • labelstring
      • amountinteger
      • usedinteger
      • exemptinteger
      • taxableinteger
Response200
{
  "summary": {
    "approvedClaims": 1,
    "openClaims": 1,
    "minutes": 1,
    "allowance": 1,
    "reimbursement": 1,
    "payout": 1,
    "waiver": 1,
    "limits": [
      {
        "label": "string",
        "amount": 1,
        "used": 1,
        "exempt": 1,
        "taxable": 1
      }
    ]
  }
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.