Skip to content
campaiDeveloper
campai.com

Crm · Compensation

POST/{organizationId}/{mandateId}/crm/compensation/claims/export

Export compensation claims

Exports the compensation claims of all accessible mandates as CSV or Excel, optionally filtered by year, period start, a property filter and a selection. Users limited to their assigned claims only get those. Large exports are queued and sent as a notification once ready. Contributor and user names are left out without access to contacts or users.

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.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • user.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • formatstringrequired
    csv xlsx
  • formatOptionsobject
    1 property
    • xlsxobject
      2 properties
      • arrayFormatstring
        line comma columns
      • unmergedGroupHeaderboolean
  • propertyPathsstring[]

    1–1000 items · each at least 1 characters

  • selectionobject
    2 properties
    • excludeIdsid[]

      1–1000 items

    • idsid[]

      1–1000 items

  • yearinteger

    2000–2999

  • periodFromstring
  • userFilterstringnullable

    A stringified json object representing a property filter

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/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

object

Response200
{
  "state": "empty"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.