time-tracking-activities

Manage time tracking activities

Operations

POST/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activitiesGET/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}DELETE/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}PATCH/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}GET/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}/actions

---

Add activity

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities

Add an activity for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"activityTypeUuid": "string",

  

"startDate": "string",

  

"endDate": "string",

  

"startTime": "14:35",

  

"endTime": "15:45",

  

"halfDay": true,

  

"addressUuid": "string",

  

"contractNoteUuid": "string",

  

"productUuid": "string",

  

"description": "string"

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"accountUuid": "string",

  

  

"employeeUuid": "string",

  

  

"activityTypeUuid": "string",

  

  

"addressUuid": "string",

  

  

"addressDescription": "string",

  

  

"productUuid": "string",

  

  

"productKey": "string",

  

  

"productDescription": "string",

  

  

"startDate": "string",

  

  

"endDate": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"halfDay": true,

  

  

"description": "string",

  

  

"contractNoteId": 0,

  

  

"contractNoteUuid": "string",

  

  

"isInvoiced": true,

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"contractNoteName": "string",

  

  

"poNumber": "string"

  

},

  

"message": "string",

  

"status": 201,

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

Body

Samples

---

Get activity

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Get the activity of an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

activityUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"accountUuid": "string",

  

  

"employeeUuid": "string",

  

  

"activityTypeUuid": "string",

  

  

"addressUuid": "string",

  

  

"addressDescription": "string",

  

  

"productUuid": "string",

  

  

"productKey": "string",

  

  

"productDescription": "string",

  

  

"startDate": "string",

  

  

"endDate": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"halfDay": true,

  

  

"description": "string",

  

  

"contractNoteId": 0,

  

  

"contractNoteUuid": "string",

  

  

"isInvoiced": true,

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"contractNoteName": "string",

  

  

"poNumber": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

activityUuid*

Samples

---

Delete activity

DELETE

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Delete an activity for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

activityUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

activityUuid*

Samples

---

Update activity

PATCH

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Update an activity for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

activityUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"activityTypeUuid": "string",

  

"startDate": "string",

  

"endDate": "string",

  

"startTime": "14:35",

  

"endTime": "15:45",

  

"halfDay": true,

  

"addressUuid": "string",

  

"contractNoteUuid": "string",

  

"productUuid": "string",

  

"description": "string"

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"accountUuid": "string",

  

  

"employeeUuid": "string",

  

  

"activityTypeUuid": "string",

  

  

"addressUuid": "string",

  

  

"addressDescription": "string",

  

  

"productUuid": "string",

  

  

"productKey": "string",

  

  

"productDescription": "string",

  

  

"startDate": "string",

  

  

"endDate": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"halfDay": true,

  

  

"description": "string",

  

  

"contractNoteId": 0,

  

  

"contractNoteUuid": "string",

  

  

"isInvoiced": true,

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"contractNoteName": "string",

  

  

"poNumber": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

activityUuid*

Body

Samples

---

Get single actions

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}/actions

Get the single actions of an activity

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

activityUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"key": "string",

  

  

  

"description": "string",

  

  

  

"isApplicable": true

  

  

}

  

],

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/activities/{activityUuid}/actions

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

activityUuid*

Samples

---