Skip to content

Create a timesheet

Crew module

POST/timesheetstimesheets.create

A timesheet for one person and pay period. An approval is voided when its hours change. Creates a timesheet. 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.timesheet.submit.
  • 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: TimesheetCreate

timesheets.create: TimesheetCreate
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project worked.
membership_idstring (uuid) | nullNoIdentifier of the membership of the person who worked; null for external crew, who carry an engagement.
engagement_idstring (uuid) | nullNoIdentifier of the engagement of the person who worked when external crew; null for members.
period_startstring (date)YesFirst day of the period.
period_endstring (date)YesLast day of the period.
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "period_start": "2026-10-08",
  "period_end": "2026-10-08"
}

Response 201: Timesheet

timesheets.create: Timesheet
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the timesheet.
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.
timesheet_state"Proposed" | "Submitted" | "Approved" | "Rejected"YesTimesheet state.
project_idstring (uuid)YesIdentifier of the project worked.
membership_idstring (uuid) | nullYesIdentifier of the membership of the person who worked; null for external crew, who carry an engagement.
engagement_idstring (uuid) | nullYesIdentifier of the engagement of the person who worked when external crew; null for members.
period_startstring (date)YesFirst day of the period.
period_endstring (date)YesLast day of the period.
submitted_bystring (uuid) | nullYesIdentifier of the person who submitted the timesheet.
{
  "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",
  "timesheet_state": "Proposed",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "period_start": "2026-10-08",
  "period_end": "2026-10-08",
  "submitted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/timesheets" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","period_start":"2026-10-08","period_end":"2026-10-08"}'
const { data } = await xos.timesheets.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "period_start": "2026-10-08",
    "period_end": "2026-10-08"
  });
response = xos.timesheets.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "period_start": "2026-10-08", "period_end": "2026-10-08"})
xos timesheets create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","period_start":"2026-10-08","period_end":"2026-10-08"}'