Skip to content
campaiDeveloper
campai.com

Crm · Compensation

GET/{organizationId}/{mandateId}/crm/compensation/claims/{claimId}Reads only

Get compensation claim

Gets a compensation claim by organization, mandate and claim ID. The response includes its entries and history, allowance usage, default booking mandate, waiver donation and qualification warnings, subject to the caller’s access.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access.
  • The caller needs mandate.read.
  • The caller also needs compensationClaim.read.
  • Callers restricted to assigned claims can only retrieve their assigned claims.
  • Without user.read, non-contact actors other than the current actor are masked.
  • Without apiKey.read, API-key actors are masked.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • claimIdidrequired
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/YOUR_CLAIM_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _idid
  • createdAtstring · date-timenullable
  • updatedAtstring · date-timenullable
  • removedAtstring · date-timenullable
  • createdByobjectnullable
  • updatedByobjectnullable
  • removedByobjectnullable
  • __ignoreTriggersstringnullable
  • organizationid
  • mandatesid[]
  • mandateScopestring
    selected all
  • numberstring

    at most 30 characters

  • contactobject
  • periodobject
    4 properties
    • yearinteger

      2000–2999

    • indexinteger

      1–12

    • fromstring
    • tostring
  • deadlineAtstring
  • reminderSentForDeadlinestringnullable
  • statusstring
    draft submitted approved
  • ratesobject[]

    at most 50 items

    6 properties
    • _idid
    • typestring
      hourly flat mileage
    • labelstring

      1–60 characters

    • amountinteger

      0–999999

    • limitidnullable
    • oncePerEntryboolean
  • entryFieldsobject[]

    at most 10 items

    6 properties
    • _idid
    • typestring
      text select multiSelect
    • labelstring

      1–60 characters

    • entryTypesstring[]

      at most 4 items

      hours flatRates mileage expenses
    • requiredboolean
    • optionsstring[]

      at most 50 items · each 1–100 characters

  • expensesEnabledboolean
  • expenseMaxAmountintegernullable

    at most 9999999999

  • expenseReceiptRequiredboolean
  • hoursobject[]

    at most 500 items

    8 properties
    • _idid
    • datestring
    • startTimestring

      pattern ^(([01]\d|2[0-3]):[0-5][05]|24:00)$

    • endTimestring

      pattern ^(([01]\d|2[0-3]):[0-5][05]|24:00)$

    • rateid
    • fieldsobject[]

      at most 50 items

      2 properties
      • fieldid
      • valuesstring[]

        1–50 items · each 1–100 characters

    • detailsstring

      at most 500 characters

    • eventidnullable
  • flatRatesobject[]

    at most 200 items

    7 properties
    • _idid
    • datestring
    • rateid
    • quantitynumber

      0.5–99

    • fieldsobject[]

      at most 50 items

      2 properties
      • fieldid
      • valuesstring[]

        1–50 items · each 1–100 characters

    • detailsstring

      at most 500 characters

    • eventidnullable
  • mileageobject[]

    at most 200 items

    7 properties
    • _idid
    • datestring
    • rateid
    • distanceinteger

      1–9999

    • purposestring

      2–100 characters

    • fieldsobject[]

      at most 50 items

      2 properties
      • fieldid
      • valuesstring[]

        1–50 items · each 1–100 characters

    • detailsstring

      at most 500 characters

  • expensesobject[]

    at most 100 items

    7 properties
    • _idid
    • datestring
    • amountinteger

      at most 9999999999

    • descriptionstring

      2–100 characters

    • filesobject[]

      at most 5 items

      5 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

      • idstring

        exactly 6 characters

    • fieldsobject[]

      at most 50 items

      2 properties
      • fieldid
      • valuesstring[]

        1–50 items · each 1–100 characters

    • detailsstring

      at most 500 characters

  • correctionsobject[]

    at most 50 items

    6 properties
    • _idid
    • descriptionstring

      2–100 characters

    • amountinteger
    • limitidnullable
    • createdAtstring · date-time
    • createdByobject
  • totalAmountinteger

    at most 9999999999

  • payeeobjectnullable
    3 properties
    • accountHolderNamestring

      at most 80 characters

    • ibanstring · iban
    • bicstring
  • declarationTextstring

    at most 4000 characters

  • submittedAtstring · date-timenullable
  • submittedByobjectnullable
  • submittedOnBehalfboolean
  • waiverobjectnullable
  • reviewsobject[]

    at most 1000 items

    4 properties
    • atstring · date-time
    • byobject
    • decisionstring
      submitted checked returned approved revoked
    • messagestringnullable

      at most 2000 characters

  • changesobject[]

    at most 1000 items

  • reviewerUserIdsstring[]

    at most 100 items · each at least 1 characters

  • notesobject[]
    6 properties
    • idstring

      exactly 6 characters

    • contentstring

      at most 4000 characters

    • writtenAtstring · date-time
    • writtenByobject
    • updatedAtstring · date-time
    • updatedByobject
  • approvedAtstring · date-timenullable
  • approvedByobjectnullable
  • documentobjectnullable
    4 properties
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

  • receiptobjectnullable
    3 properties
    • _idid
    • receiptNumberstring

      at most 30 characters

    • mandateid
  • waiverBookingsid[]

    at most 60 items

  • limitUsageobjectnullable

    limitUsage is null without limits or a contributor contact.

    3 properties
    • limitsobject[]
      5 properties
      • _idid
      • labelstring

        1–60 characters

      • amountinteger

        at most 9999999

      • dailyAmountintegernullable

        at most 9999999

      • monthlyAmountintegernullable

        at most 9999999

    • limitAmountsobject[]

      at most 10 items

      2 properties
      • limitid
      • amountinteger

        0–9999999

    • otherClaimsobject[]
      2 properties
      • fromstring
      • amountsobject[]
        3 properties
        • limitid
        • amountinteger
        • withinCapsinteger
  • defaultMandateidnullable

    defaultMandate is null when approvers choose the booking mandate.

  • waiverDonationobjectnullable

    waiverDonation is null if the claim has no waiver bookings or the caller lacks donation.read.

    3 properties
    • _idid
    • numberstring

      at least 1 characters

    • confirmationStatusstring
      pending notRequired created thanked
  • qualificationWarningsobject
    2 properties
    • proofsobject[]

      qualificationWarnings.proofs is empty without proof.read.

      qualificationWarnings.proofs is empty when the contributor has no proofs whose status is not confirmed.

      2 properties
      • typeNamestring
      • statusstring
        requested confirmed required due overdue expired
    • certificatesobject[]

      qualificationWarnings.certificates is empty without certificate.read.

      qualificationWarnings.certificates is empty when the contributor has no certificates whose status is not valid.

      2 properties
      • typeNamestring
      • statusstring
        valid willExpire expired

More about the fields

  • contact.user: For a visible contact actor other than the current actor, its nested user’s name and image are masked without user.read.
Response200
{
  "_id": "000000000000000000000001",
  "organization": "000000000000000000000001",
  "mandates": [
    "000000000000000000000001"
  ],
  "number": "string",
  "contact": {
    "name": "string",
    "type": "user",
    "userId": "string",
    "image": {
      "resource": "string"
    }
  },
  "period": {
    "year": 2000,
    "index": 1,
    "from": "string",
    "to": "string"
  },
  "deadlineAt": "string",
  "reminderSentForDeadline": "string",
  "status": "draft",
  "rates": [
    {
      "_id": "000000000000000000000001",
      "type": "hourly",
      "label": "string",
      "amount": 0,
      "limit": "000000000000000000000001",
      "oncePerEntry": true
    }
  ],
  "entryFields": [
    {
      "_id": "000000000000000000000001",
      "type": "text",
      "label": "string",
      "entryTypes": [
        "hours"
      ],
      "required": true,
      "options": [
        "string"
      ]
    }
  ],
  "expensesEnabled": true,
  "expenseMaxAmount": 1,
  "expenseReceiptRequired": true,
  "hours": [
    {
      "_id": "000000000000000000000001",
      "date": "string",
      "startTime": "string",
      "endTime": "string",
      "rate": "000000000000000000000001",
      "fields": [
        {
          "field": "000000000000000000000001",
          "values": [
            "string"
          ]
        }
      ],
      "details": "string",
      "event": "000000000000000000000001"
    }
  ],
  "flatRates": [
    {
      "_id": "000000000000000000000001",
      "date": "string",
      "rate": "000000000000000000000001",
      "quantity": 0.5,
      "fields": [
        {
          "field": "000000000000000000000001",
          "values": [
            "string"
          ]
        }
      ],
      "details": "string",
      "event": "000000000000000000000001"
    }
  ],
  "mileage": [
    {
      "_id": "000000000000000000000001",
      "date": "string",
      "rate": "000000000000000000000001",
      "distance": 1,
      "purpose": "string",
      "fields": [
        {
          "field": "000000000000000000000001",
          "values": [
            "string"
          ]
        }
      ],
      "details": "string"
    }
  ],
  "expenses": [
    {
      "_id": "000000000000000000000001",
      "date": "string",
      "amount": 1,
      "description": "string",
      "files": [
        {
          "resource": "string",
          "id": "string"
        }
      ],
      "fields": [
        {
          "field": "000000000000000000000001",
          "values": [
            "string"
          ]
        }
      ],
      "details": "string"
    }
  ],
  "corrections": [
    {
      "_id": "000000000000000000000001",
      "description": "string",
      "amount": 1,
      "limit": "000000000000000000000001",
      "createdAt": "2026-06-15T22:30:00Z",
      "createdBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      }
    }
  ],
  "totalAmount": 1,
  "payee": {
    "accountHolderName": "string",
    "iban": "string",
    "bic": "string"
  },
  "declarationText": "string",
  "submittedAt": "2026-06-15T22:30:00Z",
  "submittedBy": {
    "name": "string",
    "type": "user",
    "userId": "string",
    "image": {
      "resource": "string"
    }
  },
  "submittedOnBehalf": true,
  "waiver": {
    "type": "full"
  },
  "reviews": [
    {
      "at": "2026-06-15T22:30:00Z",
      "by": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "decision": "submitted",
      "message": "string"
    }
  ],
  "changes": [
    {
      "at": "2026-06-15T22:30:00Z",
      "by": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      },
      "type": "entries",
      "previousTotalAmount": 1,
      "totalAmount": 1
    }
  ],
  "reviewerUserIds": [
    "string"
  ],
  "notes": [
    {
      "id": "string",
      "content": "string",
      "writtenAt": "2026-06-15T22:30:00Z",
      "writtenBy": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      }
    }
  ],
  "approvedAt": "2026-06-15T22:30:00Z",
  "approvedBy": {
    "name": "string",
    "type": "user",
    "userId": "string",
    "image": {
      "resource": "string"
    }
  },
  "document": {
    "resource": "string"
  },
  "receipt": {
    "_id": "000000000000000000000001",
    "receiptNumber": "string",
    "mandate": "000000000000000000000001"
  },
  "waiverBookings": [
    "000000000000000000000001"
  ],
  "limitUsage": {
    "limits": [
      {
        "_id": "000000000000000000000001",
        "label": "string",
        "amount": 1,
        "dailyAmount": 1,
        "monthlyAmount": 1
      }
    ],
    "limitAmounts": [
      {
        "limit": "000000000000000000000001",
        "amount": 0
      }
    ],
    "otherClaims": [
      {
        "from": "string",
        "amounts": [
          {
            "limit": "000000000000000000000001",
            "amount": 1,
            "withinCaps": 1
          }
        ]
      }
    ]
  },
  "defaultMandate": "000000000000000000000001",
  "waiverDonation": {
    "_id": "000000000000000000000001",
    "number": "string",
    "confirmationStatus": "pending"
  },
  "qualificationWarnings": {
    "proofs": [
      {
        "typeName": "string",
        "status": "requested"
      }
    ],
    "certificates": [
      {
        "typeName": "string",
        "status": "valid"
      }
    ]
  }
}

Errors

Other errors

StatusErrorWhen
404Claim not found.If the claim is not found within the caller’s accessible scope, the endpoint returns HTTP 404 with compensation.errors.claimNotFound.

Errors nearly every request can meet are listed under Errors.