Skip to content

Deel: Retrieve a single timesheet entry

Deel timesheets.getTimesheetByIdVariantTimesheetsGettimesheetbyidV20260101: arguments, response, policy and SDK examples.

← Timesheets operations · Get started

Operation deel.timesheets_gettimesheetbyid_v2026_01_01

Provider route: GET /timesheets/{timesheet_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["timesheets"]["getTimesheetByIdVariantTimesheetsGettimesheetbyidV20260101"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.timesheets.getTimesheetByIdVariantTimesheetsGettimesheetbyidV20260101(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.timesheets.get_timesheet_by_id_variant_timesheets_gettimesheetbyid_v2026_01_01(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.timesheet_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a single timesheet entry — 200 response body

Referenced models: Retrieve a single timesheet entry — 200 response body

6 more schemas are linked from the tables above, on the schema pages.

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

Attach a file to contract — 201 response body — data filename, key
FieldTypePresenceDescription and constraints
$objectRootThis object is used for linking file attachments to your records.
filenamestringRequired within parentOriginal filename you used to upload using attachments end-point.
keystringRequired within parentYou can call attachments end-point, get key and URL to upload your file.
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]+)?$
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 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 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]+)?$

SDK function policy ID: deel.timesheets_gettimesheetbyid_v2026_01_01. Catalog operation: timesheets_gettimesheetbyid. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["timesheets:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.