Carrot reference
Functions

compHistory()

Returns the value of base or variable compensation on a given date.

Syntax

compHistory([date]).comp

  • date - (optional) the date to be evaluated. The default value is the current date.
  • comp - the type of compensation to be returned.
    • Accepted values are base and variable
  • Return type: Comp

Sample usage

compHistory('2017-07-01').base returns the value of base compensation on the given date.

compHistory().variable returns the value of variable compensation on the current date.

Supported data types

Input type

Return type

Logic

Date

Money

Function will return the value of the specified compensation type on the input date.

Unsupported data types

Null

Unsupported data types return Null.



Updated 04 Oct 2023
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
boolean()
NEXT
compBetween()
Docs powered by Archbee