Passer au contenu principal
PATCH
Partially updates a time entry. Send only the fields you want to change.

Autorisations

X-API-Key
string
header
requis

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Paramètres de chemin

timeEntryId
integer<int64>
requis

Time entry to update.

Corps

Fields to change.

Partial update of a time entry. Every field is optional and only the fields present in the body are applied; a field left out keeps its current value. The ticket an entry is logged against and its attachments cannot be changed here, so neither is a member: a body carrying either is rejected as malformed, the same way every other endpoint treats a field it does not know.

StartedOn
string<date-time> | null

When the work started, as a single UTC instant.

The three time fields are merged with the entry's current values before the same any-two-of-three rule the create applies. Send two of them and the third is derived from those two alone; send all three and they must agree. Send StartedOn or EndedOn alone and the other instant is kept, so the duration changes with it. Send ActualHours alone and StartedOn is kept and EndedOn moves, so the duration is exactly what was sent. Sending null is the same as omitting it - neither instant is clearable, since an entry always has an interval.

Exemple:

"2026-04-28T09:00:00.0000000+00:00"

EndedOn
string<date-time> | null

When the work finished, as a single UTC instant. Must be later than the StartedOn in force after the merge. See StartedOn for how the three time fields combine. Sending null is the same as omitting it.

Exemple:

"2026-04-28T10:30:00.0000000+00:00"

ActualHours
number<double> | null

Duration worked, in decimal hours. Must be greater than 0. The work type's minimum and increment rounding is applied on top of it, as on create. See StartedOn for how the three time fields combine.

Exemple:

1.5

BillableStatusId
integer<int32> | null

Billable status for this entry: 1 = Billable, 2 = No charge, 3 = Non-billable; any other value is rejected.

Exemple:

1

UserId
integer<int64> | null

User whose time this is. Validated against the service provider. Changing it re-stamps the entry's cost rate from the new user's own rate, as the app does.

Exemple:

8842

BillingRoleId
integer<int64> | null

Billing role to charge at. Validated against the service provider's active roles. Get valid ids from GET /v1/billing-roles.

Exemple:

1742

WorkTypeId
integer<int64> | null

Work type to apply. Determines the rate multiplier and the minimum/increment rounding applied to the logged duration. Validated against the service provider's active work types. Get valid ids from GET /v1/work-types.

Exemple:

2432

ServiceLineId
integer<int64> | null

Service line to bill this time against.

Omit it and the entry keeps the service line it has. Send it as null to take the entry off its contract outright, which also suppresses the automatic contract assignment that would otherwise happen when the time is approved. When supplied, the service line must belong to the entry's client, and its contract must be active today and cover labour. Moving an entry between contracts returns the hours it consumed to the old one and draws them from the new.

Exemple:

4720

Comment
string | null

Free-text note describing the work. Send an empty string to clear it.

Exemple:

"Replaced faulty NIC"

Distance
number<double> | null

Distance travelled for this work, when the service provider bills mileage.

Exemple:

12.5

Réponse

OK

StatusCode
enum<integer>
Options disponibles:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

Time logged against a ticket.

DataContext
object | null
Exemple:

null

Notifications
object[]