Skip to content

Deel: Get Hourly Report Presets

Deel projects.getContractTimesheetsPresets: arguments, response, policy and SDK examples.

← Projects operations · Get started

Operation deel.projects_getcontracttimesheetspresets

Provider route: GET /contracts/{contract_id}/timesheets/presets. 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["projects"]["getContractTimesheetsPresets"]>[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.projects.getContractTimesheetsPresets(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.projects.get_contract_timesheets_presets(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 parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.work_statement_idstringOptionalFormat: uuid
query.order_bystringOptionalDefault: title
query.order_directionstringOptionalDefault: ASC
query.cursorstringOptional
query.limitintegerOptionalDefault: 100
Maximum: 100
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Hourly Report Presets — 200 response body

Referenced models: Get Hourly Report Presets — 200 response body

Get Hourly Report Presets — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of hourly report presets matching the requested filters.
data[]ModelEach itemExpand Get Hourly Report Presets — 200 response body — data item
pageModelRequired within parentExpand Get Hourly Report Presets — 200 response body — page
Pagination metadata for the response.

Referenced models: Get Hourly Report Presets — 200 response body — data item, Get Hourly Report Presets — 200 response body — page

Get Hourly Report Presets — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDetailed description of the hourly report preset
fileJSONOptionalFile attached to this hourly report preset, if any.
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any
file (anyOf 2)nullAlternative
hourly_report_root_presetModelRequired within parentExpand Get Hourly Report Presets — 200 response body — data item hourly report root preset
Root preset this hourly report preset is based on.
idstringRequired within parentThe unique identifier of the hourly report preset
Format: uuid
rateJSONRequired within parent
rate (anyOf 1)numberAlternativeThe hourly rate for this preset
Format: double
rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
titlestringRequired within parentTitle of the hourly report preset.

Referenced models: Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any, Get Hourly Report Presets — 200 response body — data item hourly report root preset

Get Hourly Report Presets — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
cursorstringRequired within parentPagination cursor for fetching the next set of results
total_rowsJSONRequired within parent
total_rows (anyOf 1)integerAlternativeTotal number of rows available in the result set
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any
FieldTypePresenceDescription and constraints
$objectRootFile attached to this hourly report preset, if any.
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file
Get Hourly Report Presets — 200 response body — data item hourly report root preset
FieldTypePresenceDescription and constraints
$objectRootRoot preset this hourly report preset is based on.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDetailed description of the root preset template
description (anyOf 2)nullAlternativeDetailed description of the root preset template
fileJSONOptionalFile attached to this root preset, if any.
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any
file (anyOf 2)nullAlternative
idstringRequired within parentThe unique identifier of the root preset
Format: uuid
titlestringRequired within parentThe title of the root preset template
typestringOptionalThe type of preset based on type of root preset
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any

Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any
FieldTypePresenceDescription and constraints
$objectRootFile attached to this root preset, if any.
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file

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