v1

Swagger 2.02026-07-13107162315.5 KB
Timesheet

Creates a new timesheet entry. If Duration is null or 0, a timer will be started automatically. Requires ProjectIDFK and TimesheetCategoryIDFK.

post/api/Timesheet

Request body

UserIDFKinteger

UserID for a Timesheet user in Avaza

ProjectIDFKinteger

The project to associate the timesheet with.

TimesheetCategoryIDFKinteger

The Project timesheet category to link the timesheet to

Durationnumber double

The duration of the timesheet, in decimal hours. If null or 0, a timer will be started.

isInvoicedboolean

Optional. False by default. Allows you to mark the timesheet as invoiced in an external system.

EntryDatestring date-time

The date of the timesheet entry, with an optional start time component.

hasStartEndTimeboolean

If true, the start time will be take from the time component of the Entry Date field, and the end time will be calculated by adding the Duration to the StartDate

Notesstring

Timesheet Notes

TaskIDFKinteger

Optional. Link the timesheet to a specific task

CustomMetadatastring

Optional. free nvarchar field available via Api to store any additional metadata against a timesheet. We suggest you use Json or your preferred serialisation format. 1000 characters max.

SendWebhooksboolean

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

Response

Returns the created timesheet entry. If Duration was 0 or null, a timer is started.

TimesheetEntryIDinteger

Unique identifier for the timesheet entry.

UserIDFKinteger

The ID of the user who owns this timesheet entry.

Firstnamestring

First name of the timesheet user.

Lastnamestring

Last name of the timesheet user.

Emailstring

Email address of the timesheet user.

ProjectIDFKinteger

The project ID this timesheet entry is associated with.

ProjectTitlestring

Title of the associated project.

ProjectCodestring

Project code of the associated project, if project codes are enabled.

CustomerIDFKinteger

The customer/company ID associated with the project.

CustomerNamestring

Name of the customer/company associated with the project.

TimesheetCategoryIDFKinteger

The timesheet category ID applied to this entry.

CategoryNamestring

Name of the timesheet category applied to this entry.

Durationnumber double

Duration of the timesheet entry in decimal hours.

TimesheetEntryApprovalStatusCodestring

Approval status of the entry. Values: Draft, Pending, Approved, Rejected, AutoApproved.

HasTimerboolean

Whether a timer is currently running on this entry.

TimerStartedAtUTCstring date-time

The UTC date and time at which the timer was started, if a timer is running.

isBillableboolean

Whether this timesheet entry is billable to the client.

isInvoicedboolean

Whether this timesheet entry has been included on an invoice.

EntryDatestring date-time

The date of the timesheet entry.

StartTimeLocalstring date-time

The local start time of the entry, if start/end time tracking is enabled.

StartTimeUTCstring date-time

The UTC start time of the entry, if start/end time tracking is enabled.

EndTimeLocalstring date-time

The local end time of the entry, if start/end time tracking is enabled.

EndTimeUTCstring date-time

The UTC end time of the entry, if start/end time tracking is enabled.

TimesheetUserTimeZonestring

The IANA time zone ID of the user who owns the timesheet.

Notesstring

Free-text notes attached to this timesheet entry.

TaskIDFKinteger

The task ID this timesheet entry is linked to, if any.

TaskTitlestring

Title of the task this entry is linked to.

InvoiceIDFKinteger

The invoice Transaction ID this entry was billed on, if invoiced.

InvoiceLineItemIDFKinteger

The invoice line item ID this entry was billed on, if invoiced.

DateCreatedstring date-time

Date and time the record was created (UTC).

DateUpdatedstring date-time

Date and time the record was last updated (UTC).

DateApprovedstring date-time

Date and time the entry was approved, if applicable.

ApprovedBystring

Name or email of the user who approved this entry.

CustomMetadatastring

Optional free-form metadata field for storing additional information. Maximum 1000 characters.

RateAmountnumber double

Only visible to Admin role users

CostAmountnumber double

Only visible to Admin role users

ViewTimesheetURLstring

URL to view this timesheet entry's day in the Avaza web application.