Update time entries

Operation ID: updateTimeEntries

Group: PSA › Time Entries

Open in the interactive reference

PATCH /psa/time-entries

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates the hours or notes of time entries. A field you leave out keeps its current value. To clear notes, send an empty string.

hours and notes are the only fields you can change. To move time to another date, position assignment, or activity, delete the time entry and create a new one. The status changes only through POST psa/time-entries/submit, POST psa/time-entries/approve, and POST psa/time-entries/reject.

Correcting an approved time entry resets its approval and returns it to 'draft', so it must be submitted and approved again. If any time entry can't be updated, none are.

You can't change an invoiced time entry. A time entry counts as invoiced when its status is 'submittedForInvoicing' or 'invoiced', or when invoicedHours has a value, so a time entry that is part-way through invoicing is refused too. The request fails with ENTRY_INVOICED.

The request also fails with a generic error when the team is not active, or when the correction breaks the project's time-tracking settings: required notes, no time on weekends or holidays, and limits on hours per day, week, and month for each team member.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: updateTimeEntriesInput.

Field Type Required Description
timeEntries array<object> yes The time entries to update. Example: [{"id":"9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18","hours":"7.5"}].
timeEntries[].id string yes The unique identifier of the time entry to update.
timeEntries[].hours decimal no New total hours for the entry. Omit to leave it unchanged.
timeEntries[].notes string no New free-form notes. Omit to leave them unchanged, or pass an empty string to clear them. 
{
  "timeEntries": [
    {
      "id": "9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18",
      "hours": "7.5"
    }
  ]
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
ENTRY_INVOICED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses