ChangeTenantUserRateRequest

Changes a team member's current rates. When the user has no rate entries yet, one is
created. Otherwise PreserveHistory decides whether the previous rate is kept on record
(the open entry is closed and a new one starts at EffectiveFrom) or simply corrected
in place. Either way, rates already stamped on logged time are never changed.

Properties

Name	Type	Description
hourlyRate	number	Charge-out rate per hour. Null gives the user no rate of their own for the period, so the practice default applies.
Charge-out rate per hour. Null gives the user no rate of their own for the period, so the practice default applies.
costRate	number	Internal cost rate per hour. Setting a value requires the Cost Rates permission; callers without it leave the stored cost rate unchanged.
Internal cost rate per hour. Setting a value requires the Cost Rates permission; callers without it leave the stored cost rate unchanged.
preserveHistory	boolean	True keeps the previous rate on record for historical periods: the current entry is closed the day before EffectiveFrom and a new current entry begins. False corrects the current entry in place, as if the new rates had always applied.
True keeps the previous rate on record for historical periods: the current entry is closed the day before EffectiveFrom and a new current entry begins. False corrects the current entry in place, as if the new rates had always applied.
effectiveFrom	string	The first day the new rates apply. Required when preserving history (and when the user has closed entries but no current one); ignored when correcting in place.
The first day the new rates apply. Required when preserving history (and when the user has closed entries but no current one); ignored when correcting in place.

JSON Example

{
  "hourlyRate": 0,
  "costRate": 0,
  "preserveHistory": false,
  "effectiveFrom": "2024-01-01"
}

Used By Operations

POST Change User Rate
/tenants/{tenant}/users/{userCode}/rates