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.
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"]["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 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_contract_timesheets(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.contract_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.contract_types | array | Optional | |
query.contract_types[] | string | Each item | Type 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.statuses | array | Optional | |
query.statuses[] | string | Each item | Current processing status of the timesheet. One of: approved, declined, new, not_payable, paid, pending, processing |
query.reporter_id | string | Optional | Format: uuid |
query.date_from | string | Optional | Format: date |
query.date_to | string | Optional | Format: date |
query.limit | string | Optional | |
query.offset | string | Optional |
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 List of timesheets by contract — 200 response body |
Referenced models: List of timesheets by contract — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
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 — 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]+)?$ |
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. |
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 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). |
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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}