Retrieves a detailed view of the time record for the provided id.
GET https://my.mattero.com.au/public/api/v1/time-records/{id}
Name | Location | Type | Description |
---|---|---|---|
id | Route | string:required | The unique identifier associated with a Time Record. |
{
"isEditable": true,
"isWrittenOff": false,
"canChangeMatter": false,
"costingMethod": "Time",
"durationMinutes": 6,
"chargeRate": 100.0,
"units": 1,
"costCode": {
"id": "233-A",
"name": "Attendance"
},
"associatedMatter": {
"number": "2",
"title": "Di'Bernardo Class Action",
"id": "1217-A",
"name": "2 - Di'Bernardo Class Action"
},
"staffContact": {
"id": "741-A",
"name": "Hildagarde Di Bernardo"
},
"amountExclTax": 50.0,
"description": "Charges for initial consult"
}
Time Record object
Fields that do not have a value will be be omitted.
Name | Type | Description |
---|---|---|
amountExclTax | number | Total amount (excl. GST) |
date | Date | Date of the cost record |
description | string | The description entered for the cost record |
costingMethod | string |
|
durationMinutes | number | Number of minutes spent on a time record |
units | number | Number of time units spent on a time record |
chargeRate | number | The hourly charge rate used for a time record |
isEditable | boolean | Is the time record still able to be edited |
isWrittenOff | boolean | Is the time record written off |
canChangeMatter | boolean | Can the time record be assigned to another matter |
costCode | CostCodeReference | A reference to the assigned cost code |
associatedMatter | MatterReference | A reference to the associated matter |
staffContact | EntityReference | A reference to the assigned staff member contact record |
CostCodeReference object
Name | Type | Description |
---|---|---|
id | string | The unique identifier of the entity |
name | string | The name associated with the entity |
expenseType | string | The type of expense recorded, values can be [None | ExpenseIncGst | ExpenseExGst] |
EntityReference object
Name | Type | Description |
---|---|---|
id | string | The unique identifier of the entity |
name | string | The name associated with the entity |
MatterReference object
Name | Type | Description |
---|---|---|
id | string | The unique identifier of the matter |
name | string | The number and title of the matter |
number | string | The number associate with the matter |
title | string | The title or name of the matter |
Code | Summary | Description |
---|---|---|
200 | Ok | The request was successful with a body in the response. |
400 | Bad Request | The request failed validation checks. |
401 | Unauthorized | Failed authentication check. |
403 | Forbidden | Failed authorization check. |
404 | Not Found | Either couldn't find the endpoint or the query's entity. |