Update compensation planning cycle

Update compensation planning cycle details and currency settings.

OAuth Scopes: planning_cycles.write

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

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopesplanning_cycles.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/planning_cycles/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

idstring

ID of the cycle to update

cycleNamestring nullable

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 nullable

Whether salary is included in this cycle. Omit to leave the saved value unchanged.

bonusIncludedboolean nullable

Whether bonus is included in this cycle. Omit to leave the saved value unchanged.

equityIncludedboolean nullable

Whether equity is included in this cycle. Omit to leave the saved value unchanged.

paycheckDateYmdstring date

Date of first paycheck with new compensation updates

ratesLockedboolean nullable

Whether the cycle currency conversion rates are locked. When omitted, the stored value is preserved.

Cycle updated successfully

object required