Skip to content

Deel: List of timesheets by contract

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

← Timesheets operations · Get started

Operation deel.timesheets_getcontracttimesheets

Provider route: GET /contracts/{contract_id}/timesheets. 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"]["getContractTimesheets"]>[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.getContractTimesheets(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_contract_timesheets(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.contract_typesarrayOptional
query.contract_types[]stringEach itemType of a contract
One of: 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
query.statusesarrayOptional
query.statuses[]stringEach itemCurrent processing status of the timesheet.
One of: approved, declined, new, not_payable, paid, pending, processing
query.reporter_idstringOptionalFormat: uuid
query.date_fromstringOptionalFormat: date
query.date_tostringOptionalFormat: date
query.limitstringOptional
query.offsetstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List of timesheets by contract — 200 response body

Referenced models: List of timesheets by contract — 200 response body

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

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 — 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]+)?$
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.
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 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).
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]+)?$

SDK function policy ID: deel.timesheets_getcontracttimesheets. Catalog operation: timesheets_getcontracttimesheets. 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.