Cmdlets for Zoho Books

Build 24.0.9060

TimeEntries

List, add, update and delete time entries.

Table Specific Information

Select

The cmdlet uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:

  • TimeEntryId supports the '=' comparison.
  • ProjectId supports the '=' comparison.
  • UserId supports the '=' comparison.
  • FromDate supports the '=' comparison.
  • ToDate supports the '=' comparison.
  • TimeEntryFilter supports the '=' comparison.

By default, the response shows the time entries of the current month only.

The rest of the filter is executed client-side in the cmdlet.

For example:

    SELECT * FROM TimeEntries WHERE TimeEntryId = '1894553000000085710' AND UserId = '1894553000000068001'

    SELECT * FROM TimeEntries WHERE TimeEntryFilter = 'Date.All'

Insert

INSERT can be executed by specifying TaskId, UserId, ProjectId and LogDate columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table.

INSERT INTO TimeEntries(TaskId, UserId, ProjectId, LogDate) VALUES ('1484772000000033128', '1484772000000017001', '1484772000000033118', '2023-10-25')

Update

UPDATE can be executed by specifying the TimeEntryId in the WHERE Clause. The columns that are not read-only can be updated. For example:

UPDATE TimeEntries SET LogDate = '2023-10-25', TaskId = '1484772000000033128', UserId = '1484772000000017001', ProjectId = '1484772000000033118' WHERE TimeEntryId = '1484772000000033130'

Delete

DELETE can be executed by specifying the TimeEntryId in the WHERE Clause For example:

DELETE FROM TimeEntries WHERE TimeEntryId = '1484772000000033130'

Columns

Name Type ReadOnly References SupportedOperators Description
TimeEntryId [KEY] String True

Id of time entry.

TimerDurationInMinutes Integer True

Timer duration in minutes.

TimerDurationInSeconds Integer True

Timer duration in seconds.

TimerStartedAt String True

Time when the timer started.

BeginTime String False

Time the user started working on this task.

BilledStatus String True

Status which are billed.

CostRate Decimal False

Hourly cost rate.

CanBeInvoiced Boolean True

Check if the entry can be invoiced.

CanContinueTimer Boolean True

Check if the entry can continue the timer.

CanCreateClientApproval Boolean True

Check if the entry can create client approval.

CanCreateUserApproval Boolean True

Check if the entry can create user approval.

CreatedTime Datetime True

Time at which the time entry was created.

CustomerId String True

Contacts.ContactId

Id of the customer or vendor.

CustomerName String True

Name of the customer or vendor.

EndTime String False

Time the user stopped working on this task.

InvoiceId String True

Invoices.InvoiceId

Id of an invoice.

InvoiceNumber String True

Number of an invoice.

IsBillable Boolean False

Check if time entries is billable.

IsClientApprovalNeeded Boolean True

Check if the client approval is needed in time entries.

IsCurrentUser Boolean True

Check if it is a current user of time entries.

IsPaused Boolean True

Check if time entries is paused.

LogDate Date False

Log of date.

LogTime String False

Log of time.

Notes String False

Notes for this time entry.

ProjectHeadId String True

Id of project head.

ProjectHeadName String True

Name of project head.

ProjectId String False

Projects.ProjectId

Id of a project.

ProjectName String True

Name of the project.

TaskId String False

Tasks.TaskId

Id of task.

TaskName String True

Name of the task.

UserId String False

Users.UserId

Id of a user.

UserName String True

Name of user for time entries.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromDate Date

Date from which the time entries logged to be fetched.

ToDate Date

Date up to which the time entries logged to be fetched.

TimeEntryFilter String

Filter time entries by date and status.

The allowed values are Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear, Date.PreviousDay, Date.PreviousWeek, Date.PreviousMonth, Date.PreviousQuarter, Date.PreviousYear, Date.CustomDate, Status.Unbilled, Status.Invoiced.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060