Skip to content
campaiDeveloper
campai.com

Crm · Compensation

GET/{organizationId}/crm/compensation/contributors/{contactId}Reads only

Get contributor compensation

Gets a contributor’s compensation and the rates and allowance limits that can be assigned. It takes an organization ID and a contact ID. Compensation is null when none is found; rates and limits are null when unavailable.

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 needs compensationClaim.read.
  • The caller needs contact:contributor.read.
  • The contact lookup is subject to a mandate filter based on the caller’s organization access.

Request

Path parameters

  • organizationIdidrequired
  • contactIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/compensation/contributors/YOUR_CONTACT_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • compensationobjectnullable

    compensation is null when the contact is not found or has no contributor compensation.

    4 properties
    • activeboolean
    • ratesid[]

      at most 50 items

    • limitAmountsobject[]

      at most 10 items

      2 properties
      • limitid
      • amountinteger

        0–9999999

    • socialInsuranceNumberstringnullable

      pattern ^\d{10}$

  • ratesobject[]nullable

    rates is null when compensation settings or their rates are absent.

    10 properties
    • _idid
    • typestring
      hourly flat mileage
    • labelstring

      1–60 characters

    • amountinteger

      0–999999

    • accountinteger

      1–999999999

    • costCenter1numbernullable

      1–99999999

    • costCenter2numbernullable

      1–99999999

    • activeboolean
    • limitidnullable
    • oncePerEntryboolean
  • limitsobject[]nullable

    limits is null when compensation settings or their limits are absent.

    5 properties
    • _idid
    • labelstring

      1–60 characters

    • amountinteger

      at most 9999999

    • dailyAmountintegernullable

      at most 9999999

    • monthlyAmountintegernullable

      at most 9999999

Response200
{
  "compensation": {
    "active": true,
    "rates": [
      "000000000000000000000001"
    ],
    "limitAmounts": [
      {
        "limit": "000000000000000000000001",
        "amount": 0
      }
    ],
    "socialInsuranceNumber": "string"
  },
  "rates": [
    {
      "_id": "000000000000000000000001",
      "type": "hourly",
      "label": "string",
      "amount": 0,
      "account": 1,
      "costCenter1": 1,
      "costCenter2": 1,
      "active": true,
      "limit": "000000000000000000000001",
      "oncePerEntry": true
    }
  ],
  "limits": [
    {
      "_id": "000000000000000000000001",
      "label": "string",
      "amount": 1,
      "dailyAmount": 1,
      "monthlyAmount": 1
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.