Skip to content
campaiDeveloper
campai.com

Crm · Compensation

GET/{organizationId}/{mandateId}/crm/compensation/claimsReads only

List compensation claims

Lists the compensation claims of all accessible mandates with the reviewers they are routed to, optionally filtered by year, period start and a property filter. Users limited to their assigned claims only get those. Also returns the billing cycle, null when compensation claims are not set up, and the default mandate approved claims are booked in.

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

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • yearinteger

    2000–2999

  • periodFromstring
  • userFilterstringnullable
  • limitinteger

    1–200 · default 50

  • offsetinteger

    at least 0 · default 0

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

Response

200 Successful response

Content-Type: application/json

  • claimsobject[]
    17 properties
    • _idid
    • mandatesid[]
    • numberstring

      at most 30 characters

    • periodobject
      4 properties
      • yearinteger

        2000–2999

      • indexinteger

        1–12

      • fromstring
      • tostring
    • deadlineAtstring
    • statusstring
      draft submitted approved
    • totalAmountinteger

      at most 9999999999

    • submittedAtstring · date-timenullable
    • submittedByobjectnullable
    • submittedOnBehalfboolean
    • approvedAtstring · date-timenullable
    • approvedByobjectnullable
    • receiptobjectnullable
      3 properties
      • _idid
      • receiptNumberstring

        at most 30 characters

      • mandateid
    • contactobject
    • checkedboolean
    • creditorAccountintegernullable
    • reviewersobject[]
  • countinteger
  • cadencestringnullable
    month quarter halfYear year
  • defaultMandateidnullable
Response200
{
  "claims": [
    {
      "_id": "000000000000000000000001",
      "mandates": [
        "000000000000000000000001"
      ],
      "number": "string",
      "period": {
        "year": 2000,
        "index": 1,
        "from": "string",
        "to": "string"
      },
      "deadlineAt": "string",
      "status": "draft",
      "totalAmount": 1,
      "submittedAt": "2026-06-15T22:30:00Z",
      "submittedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "submittedOnBehalf": true,
      "approvedAt": "2026-06-15T22:30:00Z",
      "approvedBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "receipt": {
        "_id": "000000000000000000000001",
        "receiptNumber": "string",
        "mandate": "000000000000000000000001"
      },
      "contact": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "checked": true,
      "creditorAccount": 1,
      "reviewers": [
        {
          "name": "string",
          "type": "user",
          "userId": "string",
          "image": {
            "resource": "string"
          }
        }
      ]
    }
  ],
  "count": 1,
  "cadence": "month",
  "defaultMandate": "000000000000000000000001"
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.