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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.timesheet_id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve a single timesheet entry — 200 response body |
Referenced models: Retrieve a single timesheet entry — 200 response body
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
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
Attach a file to contract — 201 response body — data filename, key
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used for linking file attachments to your records. |
filename | string | Required within parent | Original filename you used to upload using attachments end-point. |
key | string | Required within parent | You 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
| 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]+)?$ |
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 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 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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}