| Info |
|---|
This resource works with Enhanced Billing Mode (EBM) and is backwards compatible with the legacy time records data structures If you are only working in EBM then you would be better off using the Time Entries resource |
The Time Records resource represents system user entered time sheets. Time records MAY be linked to the Actions resources via the Tasks resources. Time Records have both an actual time value and a billable time value. No end timestamp for a time record exists, but is calculated using the "start" field and the "actualHours" field. Time Records are also specific to a division, which can be access via the Divisions resource.
Resource Properties
| Scope Parameter | timerecords |
|---|
| Location | /timerecords |
|---|
| Methods | GET POST PUT DELETE |
|---|
OPTIONS |
| Default Page Size | 50 |
|---|
| Max Page Size |
|---|
100
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| startTimestamp | Timestamp representing the start date/time of the record | timestamp | true | default | | |
| actualHours | The total duration of the time record |
decimal| number | true | default | | Cannot be less than zero. |
| billableHours | The total number of hours that are to be billed |
decimal| number | false | default | | Cannot be less than zero. |
| notes | A description of the time being recorded | string | false | default | | |
| createdTimestamp | Timestamp of when the database record was created | timestamp | false |
additionalisTimesheetEntry | A flag for if the record was created through the timesheet interface or the time entry interface | booleanfalse | additional | | |
| owner | The system user to whom the time record belongs | string |
true| false | link | | |
| activity | The pre-defined activity associated with the time record | string |
true| false | link | | |
| division | The division to which the time record belongs | string |
true| false | link | | |
| task | The task against which the actual and billable time is logged | string |
true| false | link | | |
| createdBy | The system user who created the time record | string | false | link | read-only | |
| action | The action this time record is associated with | string | false | link | | |
| rate | The rate override for this time record | string |
true
Link Templates
| Identifier | Resource | Location Template |
|---|
| timerecords.activity | timerecordactivities | /timerecordactivities/{timerecords.activity} |
| timerecords.division | divisions | /divisions/{timerecords.division} |
| timerecords.task | tasks | /tasks/{timerecords.task} |
| timerecords.owner | participants | /participants/{timerecords.owner} |
| timerecords.createdBy | participants | /participants/{timerecords.createdBy} |
Example Requests / Responses
- GET timerecords
- POST timerecords
- PUT timerecords
- DELETE timerecords
Errors
| Code | Field | Condition |
|---|
| TR-01 | billableHours | The billableHours value can't be less than zero. |
| TR-02 | actualHours | The actualHours value can't be less than zero. |
| TR-03 | owner | The owner is a system user. |
| TR-03 | owner | The owner belongs to the specified division. |
| TR-04 | task | The task belong to the specified division. |
| TR-05 | activity | The activity is available to the owner and division. |