v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Compensation Planning

Public API

Update compensation planning cycle

Update compensation planning cycle details and currency settings.

OAuth Scopes: planning_cycles.write

put/api/v1/compensation/planning_cycles/{id}

idinteger required

idstring

ID of the cycle to update

cycleNamestring

Name of the cycle to update

cycleCurrencystring nullable

Currency code for the cycle

cycleWindowStartYmdstring date

Start date of the cycle window

cycleWindowEndYmdstring date

End date of the cycle window

recommendationsDueYmdstring date

Date when recommendations are due

approvalsDueYmdstring date

Date when approvals are due

cycleEffectiveDatestring date

Effective date of the cycle

salaryIncludedboolean

Whether salary is included in this cycle

bonusIncludedboolean

Whether bonus is included in this cycle

equityIncludedboolean

Whether equity is included in this cycle

paycheckDateYmdstring date

Date of first paycheck with new compensation updates

Cycle updated successfully

object required