client.timeEntriesOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/time-entriestimeEntries.list
Use this operation to list time entries. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.timeEntries.list(options?: TimeEntryListOptions)- Return form
Promise- Operation ID
listTimeEntries- Required scopes
time-entries:read- SDK parameters
options: TimeEntryListOptions- Query request fields
cursor?: stringlimit?: integerarchived?: booleanbillable?: booleanbilled?: booleancreatedById?: stringfrom?: stringserviceId?: stringto?: stringtaskId?: stringuserId?: string- Success
200 Array<TimeEntry> envelope
/time-entriestimeEntries.create
Use this operation to create a time entry. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.timeEntries.create(data: TimeEntryCreate, options?: MutationOptions)- Return form
Promise- Operation ID
createTimeEntry- Required scopes
time-entries:write- SDK parameters
data: TimeEntryCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
TimeEntryCreateapplication/json- Success
200 TimeEntry envelope201 TimeEntry envelope
/time-entries/{id}timeEntries.get
Use this operation to get a time entry. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.timeEntries.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getTimeEntry- Required scopes
time-entries:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TimeEntry envelope
/time-entries/{id}/billingtimeEntries.getBilling
Returns the dedicated billing and lock subresource with a strong ETag. Access requires the sensitive billing scope and the TeamGrid tasks.times.lock product permission.
client.timeEntries.getBilling(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getTimeEntryBilling- Required scopes
time-entries:billing- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TimeEntryBilling envelope
/time-entries/{id}timeEntries.update
Use this operation to update a time entry. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.timeEntries.update(id: string, data: TimeEntryUpdate, options?: RequestOptions)- Return form
Promise- Operation ID
updateTimeEntry- Required scopes
time-entries:write- SDK parameters
id: stringdata: TimeEntryUpdateoptions: RequestOptions- Path request fields
id: string- Request body
TimeEntryUpdateapplication/json- Success
200 TimeEntry envelope
/time-entries/{id}/billingtimeEntries.updateBilling
Atomically marks a time entry billed or unbilled. The supplied strong ETag must match the current billing subresource; stale concurrent requests fail without overwriting a newer decision.
client.timeEntries.updateBilling(id: string, data: TimeEntryBillingUpdate, options: TimeEntryBillingMutationOptions)- Return form
Promise- Operation ID
updateTimeEntryBilling- Required scopes
time-entries:billing- SDK parameters
id: stringdata: TimeEntryBillingUpdateoptions: TimeEntryBillingMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
TimeEntryBillingUpdateapplication/json- Success
200 TimeEntryBilling envelope
/time-entries/{id}timeEntries.archive
Use this operation to archive a time entry. The operation preserves TeamGrid lifecycle and permission rules instead of bypassing them with a direct data deletion. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.timeEntries.archive(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
archiveTimeEntry- Required scopes
time-entries:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
204
/time-entries/{id}/restoretimeEntries.restore
Use this operation to restore an archived time entry. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.timeEntries.restore(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
restoreTimeEntry- Required scopes
time-entries:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TimeEntry envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
timeEntries.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.timeEntries.pages(options?: TimeEntryListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.