Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/{mandateId}/crm/compensation/yearlyOverview/exportReads only

Export yearly compensation overview

Exports the yearly compensation overview per contributor, the usage of each yearly allowance limit by approved claims and every line of the submitted and approved claims of that year. Where allowance reports identify contributors, the usage lists their birth date, address and social insurance number for staff allowed to read contributors.

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
Also checked, depending on the request and the records it touches
  • contact:contributor.read
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • yearintegerrequired

    2000–2999

  • formatstringrequired
    html pdf excel csv
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/yearlyOverview/export' \
  --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

Content-Type: application/json

  • namestring
  • dataobject
    2 properties
    • contentstring
    • zipboolean
  • emptyboolean
Response200
{
  "name": "string",
  "data": {
    "content": "string"
  },
  "empty": true
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.