Query parameters

• type string

  The timesheet type to filter timesheets by.

  Values are company or project.

• status array[string]

  One or more statuses to filter the timesheets by.

  Values are draft, submitted, approved, or rejected.

• person array[string]

  Filter by one or more people. This is the org's people[].person._id value

• project array[string]

  Filter project timesheets by one or more projects. This is the project._id value.

• planItem array[string]

  Filter project timesheets by one or more plan items. This is the planItem._id value.

• weekStart string

  A date query to filter the results by the weekStart value. Format is weekStart=<operator> <date>, e.g. weekStart=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal, eq = equal. The date is in ISOString.

• weekEnd string

  A date query to filter the results by the weekEnd value. Format is weekEnd=<operator> <date>, e.g. weekEnd=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal, eq = equal. The date is in ISOString.

• department array[string]

  Filter project timesheets by one or more project departments. This is the org.departments[]._id value that is assigned to the timesheet's plan item project departments[] array.

• office array[string]

  Filter project timesheets by one or more project offices. This is the org.offices[]._id value that is assigned to the timesheet's plan item project offices[] array.

• role array[string]

  Filter project timesheets by one or more plan item roles. This is the org.roles[]._id value that is assigned to the timesheet's plan item role field.

• id array[string]

  One or more IDs to filter the response by. Compares against the document's _id value.

• archived boolean | number

  If true, only archived documents will be returned. Defaults to false. If you need both archived and non-archived, use withArchived instead.

  Values are false, true, 0, or 1.

• withArchived boolean | number

  If true, both archived and non-archived documents will be returned. Defaults to false.

  Values are false, true, 0, or 1.

• updatedAt string

  A date query to filter the results by the last updatedAt value. Format is updatedAt=<operator> <date>, e.g. updatedAt=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal, eq = equal. The date is in ISOString.

• select array[string]

  One or more properties to be included in the response, instead of the full payload. E.g. select=endDate,projectStatus. You can also exclude fields by prefixing with a minus sign, e.g. select=-endDate,-projectStatus, but you cannot mix both.

• sortBy string

  Optionally, the field to sort the results by. By default, results are sorted by created date. Only updatedAt is supported at this moment (Note: updatedAt equals to createdAt for documents that have never been updated).

  Value is updatedAt.

• sortDirection string

  Optionally, the direction to sort the documents by. For ascending (oldest first) use either 1 or asc. By default sorting is descending (latest first), -1 or desc.

  Values are 1, asc, -1, or desc.

• limit integer

  Optionally, change the default document response limit of 40.

  Minimum value is 1, maximum value is 100. Default value is 40.

• count boolean | number

  Includes a count property in the response, which holds the total number of results matching the query. The value does not change between pages and represents the accurate, total number of results to be expected.

  Note: The use of this parameter will have a performance impact on the first paginated request.

  Values are false, true, 0, or 1.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • value array[object]
    One of:

    company object project object

    Hide attributes Show attributes

    • _id string(ObjectId)

      The unique document ID.

    • createdBy string(ObjectId)

      The creator's unique document ID.

    • createdAt string(date-time)

      The date the document was created in ISOString format. See .toISOString().

    • updatedAt string(date-time)

      The date the document was last updated in ISOString format. See .toISOString().

    • type string Required Discriminator

      The type of timesheet. Examples of a company timesheet are short time absence, training and non billable time. Examples of a project timesheet are regular hours and meetings.

      Value is company.

    • status string

      The current status of the timesheet. Defaults to draft.

      Values are draft, submitted, approved, or rejected.

    • customId string

      A custom identifier for internal reference by your system (not used by missionX).

    • weekOfDate string Required

      Any date within the week the timesheet is being submitted for, from Monday to Sunday. Internally this is converted to weekStart and weekEnd dates. E.g. a value of 2025-03-17T19:50:11.241Z will be converted to { weekStart: 2025-03-17T00:00:00.000Z, weekEnd: 2025-03-22T23:59:59.999Z }. The value must be in ISOString format. See .toISOString().

    • weekStart string

      The start date (Monday start of day) of the timesheets week in ISOString format.

    • weekEnd string

      The end date (Sunday end of day) of the timesheets week in ISOString format.

    • person string Required

      The _id of the person that the hours are submitted for. This is the people[].person._id value.

    • entries array[object] Required

      A list of timesheet entries.

      Hide entries attributes Show entries attributes object

      • description string Required

        Free form description (title) for this timesheet.

      • hours array[object] Required

        The hours to be submitted for this entry.

        Hide hours attributes Show hours attributes object

        • day string

          The 3-letter formatted day of the week that the hours are submitted for.

          Values are MON, TUE, WED, THU, FRI, SAT, or SUN.

        • value number(float)

          The amount of hours to be submitted. Float values are supported. E.g. 2 hours => 2, 2 and a half hours => 2.5

      • codeId string

        The timesheet code id as specified in the organization settings. This is the org.timesheetCodes[].id value.

    Hide attributes Show attributes

    • _id string(ObjectId)

      The unique document ID.

    • createdBy string(ObjectId)

      The creator's unique document ID.

    • createdAt string(date-time)

      The date the document was created in ISOString format. See .toISOString().

    • updatedAt string(date-time)

      The date the document was last updated in ISOString format. See .toISOString().

    • type string Required Discriminator

      The type of timesheet. Examples of a company timesheet are short time absence, training and non billable time. Examples of a project timesheet are regular hours and meetings.

      Value is project.

    • status string

      The current status of the timesheet. Defaults to draft.

      Values are draft, submitted, approved, or rejected.

    • customId string

      A custom identifier for internal reference by your system (not used by missionX).

    • weekOfDate string Required

      Any date within the week the timesheet is being submitted for, from Monday to Sunday. Internally this is converted to weekStart and weekEnd dates. E.g. a value of 2025-03-17T19:50:11.241Z will be converted to { weekStart: 2025-03-17T00:00:00.000Z, weekEnd: 2025-03-22T23:59:59.999Z }. The value must be in ISOString format. See .toISOString().

    • weekStart string

      The start date (Monday start of day) of the timesheet's week in ISOString format.

    • weekEnd string

      The end date (Sunday end of day) of the timesheet's week in ISOString format.

    • planItem string Required

      Available and required only for type project. The _id of the planItem (role) that the hours are submitted for. This is the project.planItems[]._id value.

    • project string

      Available only for type project. The _id of the project that the planItem (role) specified belongs to. This is the project._id value.

    • entries array[object] Required

      A list of timesheet entries.

      Hide entries attributes Show entries attributes object

      • description string Required

        Free form description (title) for this timesheet.

      • hours array[object] Required

        The hours to be submitted for this entry.

        Hide hours attributes Show hours attributes object

        • day string

          The 3-letter formatted day of the week that the hours are submitted for.

          Values are MON, TUE, WED, THU, FRI, SAT, or SUN.

        • value number(float)

          The amount of hours to be submitted. Float values are supported. E.g. 2 hours => 2, 2 and a half hours => 2.5

      • codeId string

        Optional. The timesheet code id as specified in the organization settings. This is the org.timesheetCodes[].id value.

      • taskId string

        Optional. The _id of the task. To be provided if the hours are submitted against a task. If provided, the task needs to belong to the planItem specified for this timesheet.

  • nextLink string

    The full URL to be used in order to fetch the next page of results. If not defined, it means there are no more pages.

    Note: The documents are not being counted to know when all documents have been exhausted, we simply check if the length of the paginated list is less than the paginated limit. This means that if by coincidence the last paginated document list has the same length as the paginated limit, nextLink will be defined and will result in an empty list of documents.

  • count number

    The total count of results for the specific request. It's included in the response only when the count boolean query parameter is provided and truthy, e.g. ?count=1. The value is being calculated only during the first request and then repeated on the subsequent paginated responses.