Deel: Timesheets schemas
38 Deel schemas with complete fields and constraints.
← Timesheets operations · All schemas
Create a timesheet entry — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a timesheet entry — 201 response body — data Container object with identifiers, status, and creation metadata for the newly created timesheet entry. |
Referenced models: Create a timesheet entry — 201 response body — data
Create a timesheet entry — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object with identifiers, status, and creation metadata for the newly created timesheet entry. |
created | boolean | Required within parent | Flag indicating whether the timesheet entry record was successfully persisted by this request. |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | ISO-8601 timestamp recording the exact moment the timesheet entry was created in the system. Format: date-time |
created_at (anyOf 2) | null | Alternative | ISO-8601 timestamp recording the exact moment the timesheet entry was created in the system. Format: date-time |
id | string | Optional | Unique identifier returned for the created timesheet entry resource after persistence succeeds. Format: uuid |
status | JSON | Optional | Current processing status assigned to the timesheet entry after the create workflow finishes executing. |
status (anyOf 1) | string | Alternative | Current processing status assigned to the timesheet entry after the create workflow finishes executing. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative |
Create a timesheet entry — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata. |
contract_id | string | Required within parent | Unique Deel contract identifier (public id) that receives this timesheet entry line item. |
date_submitted | string | Required within parent | Date the work was performed in ISO-8601 short-date format (YYYY-MM-DD) used for filtering and approvals. Format: date |
description | string | Required within parent | Detailed human-readable explanation of the work performed that appears on the invoice and audit records. Default: |
group_key | string or null | Optional | When provided, timesheets sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true. Maximum length: 300 |
hourly_report_preset_id | string or null | Optional | Identifier of an existing timesheet preset used to link a standardized hourly rate and label to this entry. |
is_auto_approved | boolean | Optional | When true, the created timesheet entry skips manual approval and is approved immediately on creation. |
quantity | number | Required within parent | Number of work units (typically hours) to record based on the scale defined in the associated contract work statement. Format: double Minimum: 0.01 |
Delete a timesheet entry — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Delete a timesheet entry — 200 response body — data Container object confirming the outcome of the delete operation. |
Referenced models: Delete a timesheet entry — 200 response body — data
Delete a timesheet entry — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object confirming the outcome of the delete operation. |
deleted | boolean | Required within parent | Confirms the deletion. |
List of timesheets by contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of timesheet entries associated with the specified contract. |
data[] | Model | Each item | Expand List of timesheets by contract — 200 response body — data item |
page | Model | Required within parent | Expand List of timesheets — 200 response body — page Pagination metadata for the response. |
Referenced models: List of timesheets by contract — 200 response body — data item, List of timesheets — 200 response body — page
List of timesheets by contract — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Optional | This object is used for linking file attachments to your records. |
attachment (anyOf 1) | Model | Alternative | Expand Attach a file to contract — 201 response body — data filename, key |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data contract Contract associated with this timesheet. |
created_at | string | Required within parent | Timestamp when the timesheet was created (ISO-8601). |
currency_code | JSON | Required within parent | |
currency_code (anyOf 1) | string | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client for non-standard billing rates. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client for non-standard billing rates. |
date_submitted | JSON | Required within parent | |
date_submitted (anyOf 1) | string | Alternative | Timestamp when the timesheet was submitted for review (ISO-8601). Format: date-time |
date_submitted (anyOf 2) | null | Alternative | Timestamp when the timesheet was submitted for review (ISO-8601). Format: date-time |
description | string | Required within parent | Human-readable description of the work performed. |
hourly_report_preset | JSON | Optional | Timesheet preset linked to this entry, if any. |
hourly_report_preset (anyOf 1) | Model | Alternative | Expand List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any |
hourly_report_preset (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of this resource. Format: uuid |
payment_cycle | Model | Optional | Expand List of timesheets by contract — 200 response body — data item payment cycle Payment cycle associated with this timesheet. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand List of timesheets — 200 response body — data item reported by User who submitted the timesheet. |
reviewed_by | JSON | Optional | Reviewer information if the timesheet has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand List of timesheets by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
status | JSON | Required within parent | Current processing status of the timesheet. |
status (anyOf 1) | string | Alternative | Current processing status of the timesheet. Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value equal to quantity times rate of active work statement plus any bonus. |
type | string | Required within parent | Deprecated - it is always "work" |
worksheet | JSON | Required within parent | Breakdown of time worked across different units. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units |
worksheet (anyOf 2) | null | Alternative |
Referenced models: Attach a file to contract — 201 response body — data filename, key, List of timesheets — 200 response body — data item reported by, List of timesheets by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at, Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units, Retrieve a single timesheet entry — 200 response body — data contract, List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any, List of timesheets by contract — 200 response body — data item payment cycle
List of timesheets by contract — 200 response body — data item payment cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment cycle associated with this timesheet. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the payment cycle (ISO-8601). Format: date-time |
end_date (anyOf 2) | null | Alternative | End date of the payment cycle (ISO-8601). Format: date-time |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Start date of the payment cycle (ISO-8601). Format: date-time |
start_date (anyOf 2) | null | Alternative | Start date of the payment cycle (ISO-8601). Format: date-time |
List of timesheets by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer information if the timesheet has been reviewed. |
full_name | string | Optional | Full name of the reviewer. |
id | string | Required within parent | Unique identifier of the reviewer. Format: uuid |
remarks | string | Required within parent | Reviewer remarks or decision notes. |
reviewed_at | string | Required within parent | Timestamp when the review occurred (ISO-8601). |
List of timesheets — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List of timesheets — 200 response body — data item |
page | Model | Required within parent | Expand List of timesheets — 200 response body — page Pagination metadata for the response. |
Referenced models: List of timesheets — 200 response body — page, List of timesheets — 200 response body — data item
List of timesheets — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment | JSON | Optional | This object is used for linking file attachments to your records. |
attachment (anyOf 1) | Model | Alternative | Expand Attach a file to contract — 201 response body — data filename, key |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand List of timesheets — 200 response body — data item contract |
created_at | string | Required within parent | Timestamp when the timesheet was created (ISO-8601). Format: date-time |
currency_code | string | Required within parent | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client for non-standard billing rates. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client for non-standard billing rates. |
date_submitted | string | Required within parent | Timestamp when the timesheet was submitted for review (ISO-8601). Format: date-time |
description | string | Required within parent | Human-readable description of the work performed. |
hourly_report_preset | JSON | Optional | Timesheet preset linked to this entry, if any. |
hourly_report_preset (anyOf 1) | Model | Alternative | Expand List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any |
hourly_report_preset (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of this resource. Format: uuid |
payment_cycle | Model | Optional | Expand List of timesheets — 200 response body — data item payment cycle Payment cycle associated with this timesheet. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand List of timesheets — 200 response body — data item reported by User who submitted the timesheet. |
reviewed_by | JSON | Optional | Reviewer information if the timesheet has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand List of timesheets — 200 response body — data item reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
status | JSON | Required within parent | Current processing status of the timesheet. |
status (anyOf 1) | string | Alternative | Current processing status of the timesheet. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | Total monetary value equal to quantity times rate of active work statement plus any bonus. |
type | string | Required within parent | Deprecated - it is always "work" |
worksheet | JSON | Required within parent | Breakdown of time worked across different units. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units |
worksheet (anyOf 2) | null | Alternative |
Referenced models: Attach a file to contract — 201 response body — data filename, key, List of timesheets — 200 response body — data item reported by, Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units, List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any, List of timesheets — 200 response body — data item contract, List of timesheets — 200 response body — data item payment cycle, List of timesheets — 200 response body — data item reviewed by full name, id, remarks, reviewed at
List of timesheets — 200 response body — data item contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the contract. |
title | string | Required within parent | Human-readable title of the contract. |
type | string | Required within parent | Type of a contract Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo |
List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timesheet preset linked to this entry, if any. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the related timesheet preset. |
description (anyOf 2) | null | Alternative | Description of the related timesheet preset. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the related timesheet preset. |
id (anyOf 2) | null | Alternative | Unique identifier of the related timesheet preset. |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Hourly rate of the related timesheet preset. Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Hourly rate of the related timesheet preset. Format: double |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | Title of the related timesheet preset. |
title (anyOf 2) | null | Alternative | Title of the related timesheet preset. |
List of timesheets — 200 response body — data item payment cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment cycle associated with this timesheet. |
end_date | string | Optional | End date of the payment cycle (ISO-8601). Format: date-time |
start_date | string | Optional | Start date of the payment cycle (ISO-8601). Format: date-time |
List of timesheets — 200 response body — data item reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who submitted the timesheet. |
full_name | string | Optional | Full name of the user who submitted the timesheet. |
id | string | Required within parent | Unique identifier of the reporting user. Format: uuid |
List of timesheets — 200 response body — data item reviewed by full name, id, remarks, reviewed at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer information if the timesheet has been reviewed. |
full_name | string | Optional | Full name of the reviewer. |
id | string | Required within parent | Unique identifier of the reviewer. Format: uuid |
remarks | string | Required within parent | Reviewer remarks or decision notes. |
reviewed_at | string | Required within parent | Timestamp when the review occurred (ISO-8601). Format: date-time |
List of timesheets — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the response. |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of records available. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single timesheet entry — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data Timesheet entry combining its core fields with any approver decisions recorded against it. |
Referenced models: Retrieve a single timesheet entry — 200 response body — data
Retrieve a single timesheet entry — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timesheet entry combining its core fields with any approver decisions recorded against it. |
approvers | array | Required within parent | List of approvers and their decisions recorded against this timesheet. |
approvers[] | Model | Each item | Expand Retrieve a single timesheet entry — 200 response body — data approvers item |
attachment | JSON | Required within parent | This object is used for linking file attachments to your records. |
attachment (anyOf 1) | Model | Alternative | Expand Attach a file to contract — 201 response body — data filename, key |
attachment (anyOf 2) | null | Alternative | |
contract | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data contract Contract associated with this timesheet. |
created_at | string | Required within parent | Timestamp when the timesheet was created (ISO-8601). |
currency_code | string | Required within parent | ISO 4217 currency code used for the amount. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
custom_scale | JSON | Optional | |
custom_scale (anyOf 1) | string | Alternative | Custom scale label defined by the client for non-standard billing rates. |
custom_scale (anyOf 2) | null | Alternative | Custom scale label defined by the client for non-standard billing rates. |
date_submitted | string | Required within parent | Long date-time format following ISO-8601 Format: date-time |
description | string | Required within parent | Human-readable description of the work performed. |
hourly_report_preset | JSON | Optional | Timesheet preset linked to this entry, if any. |
hourly_report_preset (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data hourly report preset Timesheet preset linked to this entry, if any |
hourly_report_preset (anyOf 2) | null | Alternative | |
id | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data id Unique identifier of this resource. |
payment_cycle | Model | Optional | Expand Retrieve a single timesheet entry — 200 response body — data payment cycle Payment cycle associated with this timesheet. |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | Quantity of work units (hours, days, etc.) used to calculate the total amount. Format: double |
reported_by | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data reported by User who submitted the timesheet. |
reviewed_by | JSON | Required within parent | Reviewer information if the timesheet has been reviewed. |
reviewed_by (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at |
reviewed_by (anyOf 2) | null | Alternative | |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
scale (anyOf 2) | null | Alternative | Predefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom). |
status | JSON | Required within parent | Status of this entry. |
status (anyOf 1) | string | Alternative | Status of this entry. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative | |
total_amount | string | Required within parent | is equal to quantity times rate of active work statement + bonus in this record |
type | string | Required within parent | Deprecated - it is always "work" |
worksheet | JSON | Required within parent | Breakdown of time worked across different units. |
worksheet (anyOf 1) | Model | Alternative | Expand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units |
worksheet (anyOf 2) | null | Alternative |
Referenced models: Attach a file to contract — 201 response body — data filename, key, Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units, Retrieve a single timesheet entry — 200 response body — data contract, Retrieve a single timesheet entry — 200 response body — data approvers item, Retrieve a single timesheet entry — 200 response body — data hourly report preset Timesheet preset linked to this entry, if any, Retrieve a single timesheet entry — 200 response body — data id, Retrieve a single timesheet entry — 200 response body — data payment cycle, Retrieve a single timesheet entry — 200 response body — data reported by, Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at
Retrieve a single timesheet entry — 200 response body — data approvers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved | boolean | Required within parent | Whether the approver has approved the timesheet. |
email | string | Optional | Email address of the approver. |
full_name | string | Optional | Full name of the approver. |
Retrieve a single timesheet entry — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract associated with this timesheet. |
id | string | Required within parent | Unique identifier of the contract. |
title | string | Required within parent | Human-readable title of the contract. |
type | string | Required within parent | Type of a contract Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo |
Retrieve a single timesheet entry — 200 response body — data hourly report preset Timesheet preset linked to this entry, if any
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timesheet preset linked to this entry, if any. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | the description of the related timesheet preset |
description (anyOf 2) | null | Alternative | the description of the related timesheet preset |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | unique identifier of the related timesheet preset |
id (anyOf 2) | null | Alternative | unique identifier of the related timesheet preset |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | the hourly rate of the related timesheet preset Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | the hourly rate of the related timesheet preset Format: double |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | the title of the related timesheet preset |
title (anyOf 2) | null | Alternative | the title of the related timesheet preset |
Retrieve a single timesheet entry — 200 response body — data id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of this resource. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single timesheet entry — 200 response body — data payment cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment cycle associated with this timesheet. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
end_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
start_date (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
Retrieve a single timesheet entry — 200 response body — data reported by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who submitted the timesheet. |
full_name | string | Optional | Full name of the user who submitted the timesheet. |
id | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data reported by id Unique identifier of the reporting user. |
Referenced models: Retrieve a single timesheet entry — 200 response body — data reported by id
Retrieve a single timesheet entry — 200 response body — data reported by id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of the reporting user. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reviewer information if the timesheet has been reviewed. |
full_name | string | Optional | Full name of the reviewer. |
id | Model | Required within parent | Expand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id Unique identifier of the reviewer. |
remarks | string | Required within parent | Reviewer remarks or decision notes. |
reviewed_at | string | Required within parent | Timestamp when the review occurred (ISO-8601). |
Referenced models: Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id
Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Unique identifier of the reviewer. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | Format: int64 |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Breakdown of time worked across different units. |
days | JSON | Required within parent | |
days (anyOf 1) | number | Alternative | Number of days reported. Format: double Minimum: 0 |
days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours | JSON | Required within parent | |
hours (anyOf 1) | number | Alternative | Number of hours reported. Format: double Minimum: 0 |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minutes | JSON | Required within parent | |
minutes (anyOf 1) | number | Alternative | Number of minutes reported. Format: double Minimum: 0 |
minutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
weeks | JSON | Required within parent | |
weeks (anyOf 1) | number | Alternative | Number of weeks reported. Format: double Minimum: 0 |
weeks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Review a single timesheet — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Review a single timesheet — 201 response body — data Container object confirming the outcome of the review operation. |
Referenced models: Review a single timesheet — 201 response body — data
Review a single timesheet — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object confirming the outcome of the review operation. |
created | boolean | Required within parent | Confirms the review was recorded. |
Review a single timesheet — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Review decision payload to apply to the timesheet entry. |
reason | string or null | Optional | Optional reason accompanying the review decision, typically used when declining a timesheet. |
status | string | Required within parent | Review decision to apply to the timesheet. One of: approved, declined |
Review multiple timesheets — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Review multiple timesheets — 201 response body — data |
Referenced models: Review multiple timesheets — 201 response body — data
Review multiple timesheets — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Indicates if the timesheet review was created successfully |
Review multiple timesheets — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ids | array | Required within parent | |
ids[] | string | Each item | |
reason | string or null | Optional | The reason for review status |
status | string | Required within parent | The status to set for the timesheets One of: approved, declined |
Update a timesheet entry — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update a timesheet entry — 200 response body — data Container object confirming the outcome of the update operation. |
Referenced models: Update a timesheet entry — 200 response body — data
Update a timesheet entry — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object confirming the outcome of the update operation. |
updated | boolean | Required within parent | Confirms the update. |
Update a timesheet entry — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Fields to update on the existing timesheet entry. |
description | string | Required within parent | Detailed human-readable explanation of the work performed. Maximum length: 255 |
hourly_report_preset_id | string or null | Optional | Id of an existing timesheets preset. Created through /rest/v2/timesheets/presets |
quantity | number | Required within parent | Number of work units (typically hours) to record based on the scale defined in the associated contract work statement. Format: double |