API Docs / Schemas / UpdateTenantUserRateRequest

UpdateTenantUserRateRequest

Full replacement of one rate entry — for correcting a historical entry's rates or dates.
The edited entry must not overlap the user's other entries, and at most one entry may be
left without an end date. Rates already stamped on logged time are never changed.

Properties

Name Type Description
hourlyRatenumber

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.

costRatenumber

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.

effectiveFromstring

The first day the rates apply. Null means "since forever".

The first day the rates apply. Null means "since forever".

effectiveTostring

The last day the rates apply (inclusive). Null makes this the current rate — at most
one entry per user may be open.

The last day the rates apply (inclusive). Null makes this the current rate — at most
one entry per user may be open.

JSON Example

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

Used By Operations