DocumentationAPI Reference
API Reference

Update compensation planning cycle

put
https://{companyDomain}.bamboohr.com/api/v1/compensation/planning_cycles/

Update compensation planning cycle details and currency settings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params

Cycle details and currency settings to update

Request data for updating compensation planning cycle details and currency settings. Pre-condition: User must have permission to update cycle. Post-condition: Cycle configuration is updated.

string

ID of the cycle to update

string

Name of the cycle to update

string | null

Currency code for the cycle

date

Start date of the cycle window

date

End date of the cycle window

date

Date when recommendations are due

date

Date when approvals are due

date

Effective date of the cycle

boolean

Whether salary is included in this cycle

boolean

Whether bonus is included in this cycle

boolean

Whether equity is included in this cycle

cycleCurrencyConversionRates
array of objects

Currency conversion rates

cycleCurrencyConversionRates
date

Date of first paycheck with new compensation updates

Responses

Updated about 9 hours ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago