Reject time entries

Operation ID: rejectTimeEntries

Group: PSA › Time Entries

Open in the interactive reference

POST /psa/time-entries/reject

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

Rejects submitted time entries. Each time entry's status changes from 'pending' to 'rejected'. If any time entry isn't 'pending', the request fails with ENTRY_STATUS_INVALID and none are rejected.

Only the first time entry's rejectionReason is used, and that reason replaces the notes of every rejected time entry. The request fails if timeEntries is empty.

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: rejectTimeEntriesInput.

Field Type Required Description
timeEntries array<object> yes The time entries to reject. Example: [{"id":"9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18","rejectionReason":"Hours exceed activity budget."}].
timeEntries[].id string yes The unique identifier of the time entry to reject.
timeEntries[].rejectionReason string yes The reason for rejection. Only the value on the first entry is used, and it overwrites the notes field of every rejected entry. 
{
  "timeEntries": [
    {
      "id": "9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18",
      "rejectionReason": "Hours exceed activity budget."
    }
  ]
}

Response

200 Success

Under data (rejectTimeEntriesOutput):

Field Type Required Description
rejected array<object> yes The entries whose status was set to rejected. Example: [{"id":"9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18"}].
rejected[].id string yes The unique identifier for the entry. 
{
  "data": {
    "rejected": [
      {
        "id": "9b1c7f42-3d8a-4e05-b6c1-27fa5e903d18"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
ENTRY_STATUS_INVALID 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses