Skip to main content

Compensation settings upgrade: what changes and how to prepare

What is being upgraded, and why

We are upgrading compensation settings in PeopleForce. Instead of separate lists of compensation types and pay schedules, you will have a single directory, Compensation components. Each kind of pay your company uses is described there once, with its payout type and frequency.

The PeopleForce team carries out the upgrade, so you do not need to switch anything on. Your existing compensation records and history are kept, and no downtime is expected.

What you get:

  • One place to manage compensation. Base compensation, additional compensation and adjustments are all set up in one directory.

  • Fewer fields to fill in. When you assign compensation, you choose a component and its settings are filled in for you.

  • A separate Adjustments tab for corrections such as an underpayment from a previous period, a refund of an overpayment or a withholding. They are kept apart from bonuses, and deductions are shown as negative amounts.

💡 Not sure whether your account has been upgraded? Open Settings → Payroll. If you see Compensation components, the upgrade is done. If you see Compensation, it is still to come.

What to do before the upgrade

Most accounts do not need to do anything. Check these three points:

  • Pay schedule. If you use this field for your own records, copy its values. The field will be removed from the base compensation card.

  • Base compensation in a custom field. If you keep base compensation in a custom field rather than in the base compensation block, contact your Customer Success manager. Those amounts and currencies are not transferred automatically.

  • API integration. If you work with compensation through the PeopleForce API, share the API changes section below with whoever manages your integration.

What changes in your daily work

  • Assigning compensation. You choose a component, and the payout type and frequency are taken from it. For base compensation, the component also sets the calculation method (fixed amount or rate).

  • Changing a component. After a component is saved, you can change its name, code and description. If you need a different frequency, payout type or calculation method, create a new component.

  • Pay schedule. The field is removed. It did not affect any calculations. Pay frequency is now set in the Payroll module, under Payroll cycles.

  • Overtime. The checkbox is replaced by a ready-made Overtime component, with an amount and period visible in compensation history. To track overtime hours and special hours, use attendance policies in the Time module.

  • Base compensation history report. The exported file has two columns fewer: Pay schedule and Overtime. On screen the report looks the same.

  • Component codes. Each component has a code used in exports, history imports and the API. See Set up and manage compensation components for details.

What happens to your data

Compensation records and their history, both active and completed, are transferred automatically. Requests awaiting approval are carried over too, so they do not need to be submitted again. The only exception is base compensation kept in a custom field (see above).

You may see more components than you had compensation types. For example, if "Bonus" was paid both monthly and once-off, you will get two components: "Monthly Bonus" and "Once-off Bonus". You can rename components to match your own terms and delete the ones you do not need. Payouts that are already assigned stay in place.

Current limitations

  • Recurring variable additional compensation and adjustments cannot yet be added through forms or the API. Add them in the employee profile for now. Support in forms and the API is planned for the end of Q4 2026.

  • The component in a saved compensation record cannot be changed. If you chose the wrong one, delete the record and create it again.

  • The upgrade cannot be reversed. It is not possible to go back to the previous compensation settings.

API changes: for whoever manages your integration

If you use the PeopleForce API to work with compensation, the following changes apply after the upgrade:

  • Reading the list: use /compensation_components instead of /compensation_types.

  • Creating additional compensations: use /employees/{employee_id}/additional_compensations with compensation_component_id instead of compensation_type_id. Requests with the old field will be rejected.

  • API version: API v1 does not support components. Please move to API v3.

  • IDs: each compensation type becomes one or more components with new IDs. Employee records are moved automatically, but IDs stored in your integration might need to be re-mapped.

  • Not yet available via the API: recurring variable additional compensation and adjustments (planned for the end of Q4 2026).

🤝 If you need help with your integration, contact your Customer Success manager.

FAQ

I cannot find Compensation components in the menu.

Your account has not been upgraded yet. Until then, the menu shows Compensation.

The component list is empty when I assign compensation.

Each section shows only components of its own category and payout type. Create a component of the type you need in Settings → Payroll → Compensation components.

We need more time before the upgrade.

Contact your Customer Success Manager to discuss time limits.

Did this answer your question?