Skip to content
campaiDeveloper
campai.com

Crm · Compensation

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

Approve compensation claims

Approves up to 50 submitted compensation claims matching the filters, property filter and selection, all booked in the same mandate: the default mandate of the compensation settings, otherwise the given one, which is only optional when the approver can access a single mandate. Each claim is approved on its own, so failures are reported per claim while the others are approved. Claims of the approver as contributor are not approved.

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
  • compensationClaimApproval.edit

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • yearinteger

    2000–2999

  • periodFromstring
  • userFilterstringnullable

    A stringified json object representing a property filter

  • idsid[]

    at most 1000 items

  • excludeIdsid[]

    at most 1000 items

  • bookingMandateIdidnullable
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/approve' \
  --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

  • approvedinteger
  • failuresobject[]
    3 properties
    • claimIdid
    • numberstring
    • messagestring
Response200
{
  "approved": 1,
  "failures": [
    {
      "claimId": "000000000000000000000001",
      "number": "string",
      "message": "string"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.