Task

Table of contents

• List tasks
  • Usage
    • Parameters
    • Response
• Retrieve task
  • Usage
    • Parameters
    • Response
• Create task
  • Usage
    • Parameters
    • Response
• Update task
  • Usage
    • Parameters
    • Response
• Delete task
  • Usage
    • Parameters

See how to create a $factory

List tasks

Returns a list of tasks

Usage

$response = $factory->tasks()->listTasks($isActive, $updatedSince, $meta);
$meta = $response->getMeta();
$meta instanceof \Lsv\TimeharvestSdk\Response\MetaResponse
foreach ($response->getData() as $client) {
    $client instanceof \Lsv\TimeharvestSdk\Response\Task\TaskData
}

Parameters

Parameter	Required	Type	Description
$isActive	false	bool	Select only active or inactive clients
$updatedSince	false	DateTimeInterface	Only select clients updated after this date
$meta	false	\Lsv\TimeharvestSdk\Response\MetaResponse	Pagination

Response

$response->getMeta() instanceof \Lsv\TimeharvestSdk\Response\MetaResponse;
$response->getData() array of \Lsv\TimeharvestSdk\Response\Task\TaskData

Retrieve task

Usage

$response = $factory->tasks()->retriveTask($task);

Parameters

Parameter	Required	Type	Description
$task	true	int | \Lsv\TimeharvestSdk\Response\Task\TaskData	The ID or a TaskData of the task needed to be retrieved

Response

$response->getData() instanceof \Lsv\TimeharvestSdk\Response\Task\TaskData

Create task

Usage

$dto = new \Lsv\TimeharvestSdk\Dto\Tasks\CreateTaskDto($name, $billableByDefault, $defaultHourlyRate, $isDefault, $isActive);
$response = $factory->tasks()->createTask($dto);

Parameters

Parameter	Required	Type	Description
$name	true	string	Name of the task
$billableByDefault	false	bool	Used in determining whether default tasks should be marked billable when creating a new project.
$defaultHourlyRate	false	float	The default hourly rate to use for this task when it is added to a project
$isDefault	false	bool	Whether this task should be automatically added to future projects
$isActive	false	bool	Whether this task is active or archived

Response

$response->getData() instanceof \Lsv\TimeharvestSdk\Response\Task\TaskData

Update task

Usage

$dto = new \Lsv\TimeharvestSdk\Dto\Tasks\UpdateTaskDto($name, $billableByDefault, $defaultHourlyRate, $isDefault, $isActive);
$response = $factory->tasks()->updateTask($task, $dto);

Parameters

Parameter	Required	Type	Description
$task	true	int | \Lsv\TimeharvestSdk\Response\Task\TaskData	The ID or a TaskData of the task needed to be updated
$name	false	string	Name of the task
$billableByDefault	false	bool	Used in determining whether default tasks should be marked billable when creating a new project.
$defaultHourlyRate	false	float	The default hourly rate to use for this task when it is added to a project
$isDefault	false	bool	Whether this task should be automatically added to future projects
$isActive	false	bool	Whether this task is active or archived

Response

$response->getData() instanceof \Lsv\TimeharvestSdk\Response\Task\TaskData

Delete task

Usage

$factory->tasks()->deleteTask($task);

Parameters

Parameter	Required	Type	Description
$task	true	int | \Lsv\TimeharvestSdk\Response\Task\TaskData	The ID or a TaskData of the task needed to be deleted