Skip to content

Create a time entry correction

Crew module

POST/time-entry-correctionstimeEntryCorrections.create

A requested correction to a time entry. Creates a time entry correction. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability crew.time_entry.write.
  • OAuth scopes: crew.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TimeEntryCorrectionCreate

timeEntryCorrections.create: TimeEntryCorrectionCreate
FieldTypeRequiredDescription
time_entry_idstring (uuid)YesIdentifier of the time entry.
reasonstringYesWhy the correction is needed.Constraints: length 1 to 20000
proposed_clock_instring (date-time)YesProposed clock in.
proposed_clock_outstring (date-time) | nullNoProposed clock out.
proposed_break_minutesintegerNoProposed unpaid break minutes.Constraints: range 0 to any
{
  "time_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "reason": "Forgot to clock out at wrap.",
  "proposed_clock_in": "2026-10-08T14:30:00Z",
  "proposed_clock_out": "2026-10-08T14:30:00Z",
  "proposed_break_minutes": 30
}

Response 201: TimeEntryCorrection

timeEntryCorrections.create: TimeEntryCorrection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time entry correction.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
time_entry_idstring (uuid)YesIdentifier of the time entry.
reasonstringYesWhy the correction is needed.Constraints: length 1 to 20000
correction_state"Proposed" | "Approved" | "Rejected"YesCorrection state.
proposed_clock_instring (date-time)YesProposed clock in.
proposed_clock_outstring (date-time) | nullYesProposed clock out.
proposed_break_minutesintegerYesProposed unpaid break minutes.Constraints: range 0 to any
requested_bystring (uuid) | nullYesIdentifier of the person who asked for the correction.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "time_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "reason": "Forgot to clock out at wrap.",
  "correction_state": "Proposed",
  "proposed_clock_in": "2026-10-08T14:30:00Z",
  "proposed_clock_out": "2026-10-08T14:30:00Z",
  "proposed_break_minutes": 30,
  "requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/time-entry-corrections" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"time_entry_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","reason":"Forgot to clock out at wrap.","proposed_clock_in":"2026-10-08T14:30:00Z","proposed_clock_out":"2026-10-08T14:30:00Z","proposed_break_minutes":30}'
const { data } = await xos.timeEntryCorrections.create({
    "time_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "reason": "Forgot to clock out at wrap.",
    "proposed_clock_in": "2026-10-08T14:30:00Z",
    "proposed_clock_out": "2026-10-08T14:30:00Z",
    "proposed_break_minutes": 30
  });
response = xos.time_entry_corrections.create({"time_entry_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "reason": "Forgot to clock out at wrap.", "proposed_clock_in": "2026-10-08T14:30:00Z", "proposed_clock_out": "2026-10-08T14:30:00Z", "proposed_break_minutes": 30})
xos time-entry-corrections create --data '{"time_entry_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","reason":"Forgot to clock out at wrap.","proposed_clock_in":"2026-10-08T14:30:00Z","proposed_clock_out":"2026-10-08T14:30:00Z","proposed_break_minutes":30}'