v1

latestSwagger 2.02026-07-13107162315.5 KB
ScheduleSeries

Updates an existing project work schedule booking.

put/api/ScheduleSeries/EditBooking

Request body

ScheduleSeriesIDinteger

The Schedule Series ID to update.

UserIDFKinteger

The user ID to schedule the booking for.

HoursPerDaynumber double

Hours to allocate per working day.

TotalDurationnumber double

Total hours across the booking (alternative to HoursPerDay).

DurationTypestring

Possible values are "HoursPerDay" or "TotalDuration"

ScheduleOnDaysOffboolean

Whether to include weekends and holidays.

ProjectIDFKinteger

The project to book time against.

CategoryIDFKinteger

The timesheet category for the booking.

TaskIDFKinteger

Optional task to link the booking to.

Notesstring

Additional notes for the booking.

StartDatestring date-time

Start date of the booking period.

EndDatestring date-time

End date of the booking period.

StartTimestring

Optional start time of day for the booking.

SendWebhooksboolean

If true, fires the scheduleseries_updated webhook event to any subscribed endpoints. Defaults to false to preserve existing integration behaviour.

Response

Returns the updated schedule booking details.

ScheduleSeriesIDinteger

Unique identifier for the schedule series.

AccountIDFKinteger

The Avaza account this schedule belongs to.

UserIDFKinteger

The user this schedule is assigned to.

Firstnamestring

Scheduled user's first name.

Lastnamestring

Scheduled user's last name.

ProjectIDFKinteger

The project this booking is for (null for leave).

ProjectTitlestring

Title of the associated project.

CompanyIDFKinteger

The customer company of the associated project.

CompanyNamestring

Name of the customer company.

TimeSheetCategoryIDFKinteger

The timesheet category for this booking.

TimeSheetCategoryNamestring

Name of the timesheet category.

LeaveTypeIDFKinteger

The leave type ID (for leave schedule entries).

LeaveTypeNamestring

Name of the leave type.

StartDatestring date-time

Start date of the schedule series.

EndDatestring date-time

End date of the schedule series.

HoursPerDaynumber double

Hours allocated per working day.

TotalDurationnumber double

Total hours across the entire schedule series.

ScheduleOnDaysOffboolean

Whether to include weekends and holidays in the schedule.

Notesstring

Additional notes on the schedule.

TaskIDFKinteger

The task this booking is linked to, if any.

TaskTitlestring

Title of the associated task.

DateCreatedstring date-time

Date and time the record was created.

DateUpdatedstring date-time

Date and time the record was last updated.

UpdatedByUserIDFKinteger

User ID of the person who last updated this schedule.

StartTimestring

Optional start time of day for the scheduled work.

EndTimestring

Optional end time of day for the scheduled work.

isBillableboolean

Whether this booking is billable, based on project billing method and category settings.

RateAmountnumber double

The applicable billing rate per hour for this booking.

CostAmountnumber double

The applicable cost rate per hour for this booking.