Carrot reference
...
Fields
Data Types

PayInterval

A datatype used to represent a pay interval, which represents the amount and period that someone is paid -- for example, an annual salary or hourly rate.

Properties

Property

Type

Description







amount

Number

The amount of money, without the currency (same as pay.amount)

annualized

Money

The amount of money, converted to an annualized total.

asOrgCurrency

Converts the PayInterval to the org's default currency (using the current exchange rate in effect as-of the evaluation date).

currency

Currency

The currency being paid (same as pay.currency)

hourly

Money

The hourly rate if hourly, otherwise null

hoursPerWeek

Number

The number of expected hours per week (incorporated in annualized calculation)

interval

String

The interval being paid, either year or hour

pay

Money

The rate of pay

weeksPerYear

Number

The number of expected weeks per year (incorporated in annualized calculation)

yearly

Money

The yearly rate if yearly, otherwise null

Type Conversions and Money Math

If a Pay Interval is used together with Money in a formula, the Pay Interval is automatically converted to its annualized value.

Updated 20 Nov 2024
Doc contributor
Doc contributor
Did this page help you?