Query parameters

• notify string

  If set to 0 or false, then all notifications associated with this operation will be disabled. This includes push notifications, emails and asynchronous UI updates. Useful for bulk operations.

Responses

• 200 application/json

  Successful response

  One of:

  TimesheetCompany object TimesheetProject 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 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.

    Values are draft, submitted, approved, or rejected.

  • customId string

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

  • 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

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

  • entries array[object]

    A list of timesheet entries.

    Hide entries attributes Show entries attributes object

    • description string

      Free form description (title) for this timesheet.

    • hours array[object]

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

    Values are draft, submitted, approved, or rejected.

  • customId string

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

  • 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

    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]

    A list of timesheet entries.

    Hide entries attributes Show entries attributes object

    • description string

      Free form description (title) for this timesheet.

    • hours array[object]

      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.

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.

• 409

  Conflict. Timesheet has already been created for the time period.

• 429

  Too Many Requests or outbound size quota exhausted.

• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.