Skip to content

Deel: Timesheets schemas

38 Deel schemas with complete fields and constraints.

← Timesheets operations · All schemas

Create a timesheet entry — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootContainer object with identifiers, status, and creation metadata for the newly created timesheet entry.
createdbooleanRequired within parentFlag indicating whether the timesheet entry record was successfully persisted by this request.
created_atJSONOptional
created_at (anyOf 1)stringAlternativeISO-8601 timestamp recording the exact moment the timesheet entry was created in the system.
Format: date-time
created_at (anyOf 2)nullAlternativeISO-8601 timestamp recording the exact moment the timesheet entry was created in the system.
Format: date-time
idstringOptionalUnique identifier returned for the created timesheet entry resource after persistence succeeds.
Format: uuid
statusJSONOptionalCurrent processing status assigned to the timesheet entry after the create workflow finishes executing.
status (anyOf 1)stringAlternativeCurrent 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)nullAlternative

Create a timesheet entry — request body — body data

FieldTypePresenceDescription and constraints
$objectRootPayload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata.
contract_idstringRequired within parentUnique Deel contract identifier (public id) that receives this timesheet entry line item.
date_submittedstringRequired within parentDate the work was performed in ISO-8601 short-date format (YYYY-MM-DD) used for filtering and approvals.
Format: date
descriptionstringRequired within parentDetailed human-readable explanation of the work performed that appears on the invoice and audit records.
Default:
group_keystring or nullOptionalWhen 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_idstring or nullOptionalIdentifier of an existing timesheet preset used to link a standardized hourly rate and label to this entry.
is_auto_approvedbooleanOptionalWhen true, the created timesheet entry skips manual approval and is approved immediately on creation.
quantitynumberRequired within parentNumber 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootContainer object confirming the outcome of the delete operation.
deletedbooleanRequired within parentConfirms the deletion.

List of timesheets by contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of timesheet entries associated with the specified contract.
data[]ModelEach itemExpand List of timesheets by contract — 200 response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
attachmentJSONOptionalThis object is used for linking file attachments to your records.
attachment (anyOf 1)ModelAlternativeExpand Attach a file to contract — 201 response body — data filename, key
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data contract
Contract associated with this timesheet.
created_atstringRequired within parentTimestamp when the timesheet was created (ISO-8601).
currency_codeJSONRequired within parent
currency_code (anyOf 1)stringAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client for non-standard billing rates.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client for non-standard billing rates.
date_submittedJSONRequired within parent
date_submitted (anyOf 1)stringAlternativeTimestamp when the timesheet was submitted for review (ISO-8601).
Format: date-time
date_submitted (anyOf 2)nullAlternativeTimestamp when the timesheet was submitted for review (ISO-8601).
Format: date-time
descriptionstringRequired within parentHuman-readable description of the work performed.
hourly_report_presetJSONOptionalTimesheet preset linked to this entry, if any.
hourly_report_preset (anyOf 1)ModelAlternativeExpand List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any
hourly_report_preset (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of this resource.
Format: uuid
payment_cycleModelOptionalExpand List of timesheets by contract — 200 response body — data item payment cycle
Payment cycle associated with this timesheet.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand List of timesheets — 200 response body — data item reported by
User who submitted the timesheet.
reviewed_byJSONOptionalReviewer information if the timesheet has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand List of timesheets by contract — 200 response body — data item reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
scale (anyOf 2)nullAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
statusJSONRequired within parentCurrent processing status of the timesheet.
status (anyOf 1)stringAlternativeCurrent processing status of the timesheet.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentTotal monetary value equal to quantity times rate of active work statement plus any bonus.
typestringRequired within parentDeprecated - it is always "work"
worksheetJSONRequired within parentBreakdown of time worked across different units.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units
worksheet (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootPayment cycle associated with this timesheet.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the payment cycle (ISO-8601).
Format: date-time
end_date (anyOf 2)nullAlternativeEnd date of the payment cycle (ISO-8601).
Format: date-time
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeStart date of the payment cycle (ISO-8601).
Format: date-time
start_date (anyOf 2)nullAlternativeStart 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

FieldTypePresenceDescription and constraints
$objectRootReviewer information if the timesheet has been reviewed.
full_namestringOptionalFull name of the reviewer.
idstringRequired within parentUnique identifier of the reviewer.
Format: uuid
remarksstringRequired within parentReviewer remarks or decision notes.
reviewed_atstringRequired within parentTimestamp when the review occurred (ISO-8601).

List of timesheets — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List of timesheets — 200 response body — data item
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
attachmentJSONOptionalThis object is used for linking file attachments to your records.
attachment (anyOf 1)ModelAlternativeExpand Attach a file to contract — 201 response body — data filename, key
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand List of timesheets — 200 response body — data item contract
created_atstringRequired within parentTimestamp when the timesheet was created (ISO-8601).
Format: date-time
currency_codestringRequired within parentISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client for non-standard billing rates.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client for non-standard billing rates.
date_submittedstringRequired within parentTimestamp when the timesheet was submitted for review (ISO-8601).
Format: date-time
descriptionstringRequired within parentHuman-readable description of the work performed.
hourly_report_presetJSONOptionalTimesheet preset linked to this entry, if any.
hourly_report_preset (anyOf 1)ModelAlternativeExpand List of timesheets — 200 response body — data item hourly report preset Timesheet preset linked to this entry, if any
hourly_report_preset (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of this resource.
Format: uuid
payment_cycleModelOptionalExpand List of timesheets — 200 response body — data item payment cycle
Payment cycle associated with this timesheet.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand List of timesheets — 200 response body — data item reported by
User who submitted the timesheet.
reviewed_byJSONOptionalReviewer information if the timesheet has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand List of timesheets — 200 response body — data item reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
scale (anyOf 2)nullAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
statusJSONRequired within parentCurrent processing status of the timesheet.
status (anyOf 1)stringAlternativeCurrent processing status of the timesheet.
Known values: approved, declined, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentTotal monetary value equal to quantity times rate of active work statement plus any bonus.
typestringRequired within parentDeprecated - it is always "work"
worksheetJSONRequired within parentBreakdown of time worked across different units.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units
worksheet (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the contract.
titlestringRequired within parentHuman-readable title of the contract.
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootTimesheet preset linked to this entry, if any.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the related timesheet preset.
description (anyOf 2)nullAlternativeDescription of the related timesheet preset.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the related timesheet preset.
id (anyOf 2)nullAlternativeUnique identifier of the related timesheet preset.
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeHourly rate of the related timesheet preset.
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeHourly rate of the related timesheet preset.
Format: double
titleJSONOptional
title (anyOf 1)stringAlternativeTitle of the related timesheet preset.
title (anyOf 2)nullAlternativeTitle of the related timesheet preset.

List of timesheets — 200 response body — data item payment cycle

FieldTypePresenceDescription and constraints
$objectRootPayment cycle associated with this timesheet.
end_datestringOptionalEnd date of the payment cycle (ISO-8601).
Format: date-time
start_datestringOptionalStart date of the payment cycle (ISO-8601).
Format: date-time

List of timesheets — 200 response body — data item reported by

FieldTypePresenceDescription and constraints
$objectRootUser who submitted the timesheet.
full_namestringOptionalFull name of the user who submitted the timesheet.
idstringRequired within parentUnique identifier of the reporting user.
Format: uuid

List of timesheets — 200 response body — data item reviewed by full name, id, remarks, reviewed at

FieldTypePresenceDescription and constraints
$objectRootReviewer information if the timesheet has been reviewed.
full_namestringOptionalFull name of the reviewer.
idstringRequired within parentUnique identifier of the reviewer.
Format: uuid
remarksstringRequired within parentReviewer remarks or decision notes.
reviewed_atstringRequired within parentTimestamp when the review occurred (ISO-8601).
Format: date-time

List of timesheets — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of records available.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single timesheet entry — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootTimesheet entry combining its core fields with any approver decisions recorded against it.
approversarrayRequired within parentList of approvers and their decisions recorded against this timesheet.
approvers[]ModelEach itemExpand Retrieve a single timesheet entry — 200 response body — data approvers item
attachmentJSONRequired within parentThis object is used for linking file attachments to your records.
attachment (anyOf 1)ModelAlternativeExpand Attach a file to contract — 201 response body — data filename, key
attachment (anyOf 2)nullAlternative
contractModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data contract
Contract associated with this timesheet.
created_atstringRequired within parentTimestamp when the timesheet was created (ISO-8601).
currency_codestringRequired within parentISO 4217 currency code used for the amount.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
custom_scaleJSONOptional
custom_scale (anyOf 1)stringAlternativeCustom scale label defined by the client for non-standard billing rates.
custom_scale (anyOf 2)nullAlternativeCustom scale label defined by the client for non-standard billing rates.
date_submittedstringRequired within parentLong date-time format following ISO-8601
Format: date-time
descriptionstringRequired within parentHuman-readable description of the work performed.
hourly_report_presetJSONOptionalTimesheet preset linked to this entry, if any.
hourly_report_preset (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data id
Unique identifier of this resource.
payment_cycleModelOptionalExpand Retrieve a single timesheet entry — 200 response body — data payment cycle
Payment cycle associated with this timesheet.
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternativeQuantity of work units (hours, days, etc.) used to calculate the total amount.
Format: double
reported_byModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data reported by
User who submitted the timesheet.
reviewed_byJSONRequired within parentReviewer information if the timesheet has been reviewed.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at
reviewed_by (anyOf 2)nullAlternative
scaleJSONOptional
scale (anyOf 1)stringAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
scale (anyOf 2)nullAlternativePredefined scale used to calculate the timesheet amount (e.g. hourly, daily, custom).
statusJSONRequired within parentStatus of this entry.
status (anyOf 1)stringAlternativeStatus of this entry.
Known values: approved, declined, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative
total_amountstringRequired within parentis equal to quantity times rate of active work statement + bonus in this record
typestringRequired within parentDeprecated - it is always "work"
worksheetJSONRequired within parentBreakdown of time worked across different units.
worksheet (anyOf 1)ModelAlternativeExpand Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units
worksheet (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
approvedbooleanRequired within parentWhether the approver has approved the timesheet.
emailstringOptionalEmail address of the approver.
full_namestringOptionalFull name of the approver.

Retrieve a single timesheet entry — 200 response body — data contract

FieldTypePresenceDescription and constraints
$objectRootContract associated with this timesheet.
idstringRequired within parentUnique identifier of the contract.
titlestringRequired within parentHuman-readable title of the contract.
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootTimesheet preset linked to this entry, if any.
descriptionJSONOptional
description (anyOf 1)stringAlternativethe description of the related timesheet preset
description (anyOf 2)nullAlternativethe description of the related timesheet preset
idJSONOptional
id (anyOf 1)stringAlternativeunique identifier of the related timesheet preset
id (anyOf 2)nullAlternativeunique identifier of the related timesheet preset
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativethe hourly rate of the related timesheet preset
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativethe hourly rate of the related timesheet preset
Format: double
titleJSONOptional
title (anyOf 1)stringAlternativethe title of the related timesheet preset
title (anyOf 2)nullAlternativethe title of the related timesheet preset

Retrieve a single timesheet entry — 200 response body — data id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of this resource.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single timesheet entry — 200 response body — data payment cycle

FieldTypePresenceDescription and constraints
$objectRootPayment cycle associated with this timesheet.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
end_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time

Retrieve a single timesheet entry — 200 response body — data reported by

FieldTypePresenceDescription and constraints
$objectRootUser who submitted the timesheet.
full_namestringOptionalFull name of the user who submitted the timesheet.
idModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of the reporting user.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at

FieldTypePresenceDescription and constraints
$objectRootReviewer information if the timesheet has been reviewed.
full_namestringOptionalFull name of the reviewer.
idModelRequired within parentExpand Retrieve a single timesheet entry — 200 response body — data reviewed by full name, id, remarks, reviewed at id
Unique identifier of the reviewer.
remarksstringRequired within parentReviewer remarks or decision notes.
reviewed_atstringRequired within parentTimestamp 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

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of the reviewer.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a single timesheet entry — 200 response body — data worksheet Breakdown of time worked across different units

FieldTypePresenceDescription and constraints
$objectRootBreakdown of time worked across different units.
daysJSONRequired within parent
days (anyOf 1)numberAlternativeNumber of days reported.
Format: double
Minimum: 0
days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursJSONRequired within parent
hours (anyOf 1)numberAlternativeNumber of hours reported.
Format: double
Minimum: 0
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minutesJSONRequired within parent
minutes (anyOf 1)numberAlternativeNumber of minutes reported.
Format: double
Minimum: 0
minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weeksJSONRequired within parent
weeks (anyOf 1)numberAlternativeNumber of weeks reported.
Format: double
Minimum: 0
weeks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Review a single timesheet — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootContainer object confirming the outcome of the review operation.
createdbooleanRequired within parentConfirms the review was recorded.

Review a single timesheet — request body — body data

FieldTypePresenceDescription and constraints
$objectRootReview decision payload to apply to the timesheet entry.
reasonstring or nullOptionalOptional reason accompanying the review decision, typically used when declining a timesheet.
statusstringRequired within parentReview decision to apply to the timesheet.
One of: approved, declined

Review multiple timesheets — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Review multiple timesheets — 201 response body — data

Referenced models: Review multiple timesheets — 201 response body — data

Review multiple timesheets — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentIndicates if the timesheet review was created successfully

Review multiple timesheets — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
idsarrayRequired within parent
ids[]stringEach item
reasonstring or nullOptionalThe reason for review status
statusstringRequired within parentThe status to set for the timesheets
One of: approved, declined

Update a timesheet entry — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootContainer object confirming the outcome of the update operation.
updatedbooleanRequired within parentConfirms the update.

Update a timesheet entry — request body — body data

FieldTypePresenceDescription and constraints
$objectRootFields to update on the existing timesheet entry.
descriptionstringRequired within parentDetailed human-readable explanation of the work performed.
Maximum length: 255
hourly_report_preset_idstring or nullOptionalId of an existing timesheets preset. Created through /rest/v2/timesheets/presets
quantitynumberRequired within parentNumber of work units (typically hours) to record based on the scale defined in the associated contract work statement.
Format: double

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.