Skip to content

Deel: Create a timesheet entry

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

← Timesheets operations · Get started

Operation deel.timesheets_createtimesheet

Provider route: POST /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"]["createTimesheet"]>[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.createTimesheet(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.create_timesheet(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create a timesheet entry — request body — body data
Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata.

Referenced models: Create a timesheet entry — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a timesheet entry — 201 response body

Referenced models: Create a timesheet entry — 201 response body

Create a timesheet entry — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a timesheet entry — 201 response body — data
Container object with identifiers, status, and creation metadata for the newly created timesheet entry.

Referenced models: Create a timesheet entry — 201 response body — data

Create a timesheet entry — request body — body data
FieldTypePresenceDescription and constraints
$objectRootPayload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata.
contract_idstringRequired within parentUnique Deel contract identifier (public id) that receives this timesheet entry line item.
date_submittedstringRequired within parentDate the work was performed in ISO-8601 short-date format (YYYY-MM-DD) used for filtering and approvals.
Format: date
descriptionstringRequired within parentDetailed human-readable explanation of the work performed that appears on the invoice and audit records.
Default:
group_keystring or nullOptionalWhen provided, timesheets sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. Requires is_auto_approved to be true.
Maximum length: 300
hourly_report_preset_idstring or nullOptionalIdentifier of an existing timesheet preset used to link a standardized hourly rate and label to this entry.
is_auto_approvedbooleanOptionalWhen true, the created timesheet entry skips manual approval and is approved immediately on creation.
quantitynumberRequired within parentNumber of work units (typically hours) to record based on the scale defined in the associated contract work statement.
Format: double
Minimum: 0.01
Create a timesheet entry — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootContainer object with identifiers, status, and creation metadata for the newly created timesheet entry.
createdbooleanRequired within parentFlag indicating whether the timesheet entry record was successfully persisted by this request.
created_atJSONOptional
created_at (anyOf 1)stringAlternativeISO-8601 timestamp recording the exact moment the timesheet entry was created in the system.
Format: date-time
created_at (anyOf 2)nullAlternativeISO-8601 timestamp recording the exact moment the timesheet entry was created in the system.
Format: date-time
idstringOptionalUnique identifier returned for the created timesheet entry resource after persistence succeeds.
Format: uuid
statusJSONOptionalCurrent processing status assigned to the timesheet entry after the create workflow finishes executing.
status (anyOf 1)stringAlternativeCurrent processing status assigned to the timesheet entry after the create workflow finishes executing.
Known values: approved, declined, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

SDK function policy ID: deel.timesheets_createtimesheet. Catalog operation: timesheets/create. 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:write"]

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.