---
title: Comp Band
slug: pkTE-comp-band
createdAt: 2022-06-25T15:57:53.000Z
---

A *Carrot* datatype that stores compensation band levels.&#x20;

:::hint{type="info"}
The `Comp Band` datatype is not currently supported in Custom fields.&#x20;
:::

## Properties

The `Comp Band` datatype supports the following properties:

### Job Level

| **Field Name**          | **Property**        | **Definition**                                     | **Examples**                          |
| ----------------------- | ------------------- | -------------------------------------------------- | ------------------------------------- |
| Comp Band  - Job Family | `compBand.tier`     | The top-level grouping of your compensation bands. | `Sales`, `Product`, `Engineering`     |
| Comp Band - Job Level   | `compBand.jobLevel` | The universal job level for the given band.        | `Entry Level`, `Associate`, `Manager` |

### Equity

| **Field Name**                                 | **Property**                         | **Definition**                                                                | **Examples** |
| ---------------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | ------------ |
| Comp Band Equity - Target (money)              | `compBand.equityTargetValue`         | The target equity amount, specified as a monetary value.                      | `$10,000`    |
| Comp Band Equity - Target (shares)             | `compBand.equityTargetShares`        | The target equity amount, specified in number of shares.                      | `45`         |
| Comp Band Equity - Target (percentage of base) | `compBand.equityTargetPercentOfBase` | The target equity amount, specified as a percentage of the job's actual base. | `5`          |

### Base

| **Field Name**                             | **Property**                       | **Definition**                                                                                                                                                                                      | **Examples**       |
| ------------------------------------------ | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| Comp Band Base - Target                    | `compBand.baseTarget`              | A guideline value for the band which may be different from the midpoint.                                                                                                                            | `$100000`          |
| Comp Band Base - Target Percentile         | `compBand.baseTargetPercentile`    | A guideline value for the band which may be different from the midpoint, specified as a percentile between baseMin and baseMax.                                                                     | `$75000`           |
| Comp Band Base - Interval                  | `compBand.baseInterval`            | The pay interval that the compensation range is specified in.                                                                                                                                       | `Hourly`, `Salary` |
| Comp Band Base - Pay Range                 | `compBand.baseSpread`              | The percentage above and below the midpoint that defines the upper and lower bounds of the band. For example, a value of 30% with a midpoint of 100,000 would create a pay range of 70,000-130,000. | `30`               |
| Comp Band Base - Maximum                   | `compBand.baseMax`                 | The upper bound of the base compensation range.                                                                                                                                                     | `$200000`          |
| Comp Band Base - Maximum With Multipliers  | `compBand.baseMax.withMultipliers` | The upper bound of the base compensation range, with all applicable multipliers applied.                                                                                                            | `$200000`          |
| Comp Band Base - Minimum                   | `compBand.baseMin`                 | The lower bound of the base compensation range.                                                                                                                                                     | `$80000`           |
| Comp Band Base - Minimum With Multipliers  | `compBand.baseMin.withMultipliers` | The lower bound of the base compensation range, with all applicable multipliers applied.                                                                                                            | `$75000`           |
| Comp Band Base - Midpoint                  | `compBand.baseMid`                 | The midpoint of the base compensation range.                                                                                                                                                        | `$100000`          |
| Comp Band Base - Midpoint With Multipliers | `compBand.baseMid.withMultipliers` | The midpoint of the base compensation range, with all applicable multipliers applied.                                                                                                               | `$110000`          |

### Variable

| **Field** **Name**                               | **Property**                     | **Definition**                                                                      | **Examples** |
| ------------------------------------------------ | -------------------------------- | ----------------------------------------------------------------------------------- | ------------ |
| Comp Band Variable - Target (money)              | `compBand.variableValue`         | The target variable pay amount, specified as a monetary value.                      | `$300000`    |
| Comp Band Variable - Target (percentage of base) | `compBand.variablePercentOfBase` | The target variable pay amount, specified as a percentage of the job's actual base. | `25`         |

