Guides

Logged Time Entries

This documentation is for LiquidPlanner New: next.liquidplanner.com

Suggest Edits

📘

Best Practice for Pulling Logged Time Entries

If you are pulling time entries into a system of record we recommend establishing a business rule to ensure that time entries have been updated within the app prior to pulling them via the API.

Retrieve logged time entries and track time and with this end point.

https://next.liquidplanner.com/api/workspaces/<workspace id>/logged-time-entries/v1

Supported Methods

Fetch Logged Time Entries

GET

Pull raw data about logged time entries in JSON format. Each time entry row represents time tracked to a Task by Assignment by Cost Code, by day.

The data response received will include the raw time entry data in JSON format as shown in the example below. You can then map that data to the cost code name, item name and user name by calling those respective endpoints and cross-referencing the data returned.

The logged value is pulled in minutes. Convert it to hours, if needed, to match the value as displayed in-app.

Sample Response

{
    "recordLimit": 500,
    "recordCount": 1,
    "data": [
        {
            "id": 364183,
            "date": "2022-07-04",
            "note": “this is a time entry note sample”,
            "loggedEntriesInMinutes": 480,
            "costCodeId": null,
            "itemId": 424982,
            "userId": 10702,
            "createdAt": "2022-08-03T18:12:37.937375Z",
            "updatedAt": "2022-08-03T18:12:37.941Z",
            "createdBy": 10702,
            "updatedBy": 10702
        }
    ]
}

Filter Options

Apply the filter string to the endpoint URL.

Filter attributeField typeDescriptionFilter stringNote
idnumberPull details about a specific logged time entry its ID?id[is]="122"
itemIdnumberPull time entries made on a specific assignment by assignment ID?itemId[is]="425268"
datedatePull time entries in a given date range?date[in]=["2022-07-04","2022-07-05"]Encode operator and value. Date value doesn’t need a timestamp
userIdnumberPull time entries for a specific user?userId[is]="62"
costCodeIdnumberPull a list of time entries made against the specified cost code?costCodeId[in]=["223","571"]Encode operator and value
updatedAtdateTimePull time entries based on when they were updated?updatedAt[gte]=”2022-08-14T00:00:00.0Z”
createdAtdateTimePull time entries that were created in a given date range?createdAt[between]=["2021-12-03T10:15:30.00Z","2021-12-05T10:15:30.00Z"]Encode operator and value.

Create Time Entry

POST

Logging time updates the assignment estimate. Should you choose, you can also mark an assignment complete or add a timesheet note.

Sample Request

curl --location 'https://next.liquidplanner.com/api/workspaces/<workspace id>/logged-time-entries/v1\'
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{TOKEN}}' \
--data '{
   "date": "2024-06-18",
   "loggedEntriesInMinutes": 902,
   "note": "Molestiae atque et recusandae enim quo sunt autem rerum dolorum.",
   "itemId": 8964021,
  
   "costCodeId": 22409
}'

Sample Response

{
    "id": 5747800,
    "date": "2024-06-18",
    "note": "Debitis eaque nesciunt possimus eos.",
    "loggedEntriesInMinutes": 941,
    "costCodeId": 22409,
    "itemId": 8964021,
    "userId": 37979,
    "createdAt": "2024-04-03T21:49:20.625838Z",
    "updatedAt": "2024-04-03T21:49:20.681Z",
    "createdBy": 168,
    "updatedBy": 168
}

Update Time Entry

PUT

Sample Request

curl --location --request PUT 'https://next.liquidplanner.com/api/workspaces/<workspace id>/logged-time-entries/v1/5593751' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{TOKEN}}' \
--data '{
    "id": 5593751,
    "note": "Magni fuga ipsam culpa non laboriosam.",
    "loggedEntriesInMinutes": 668,
    "costCodeId": 22409
}'

Sample Response

{
   "id": 5597505,
   "date": "2013-08-26",
   "note": "Porro cupiditate sed magnam.\nModi totam a id voluptates eius.",
   "loggedEntriesInMinutes": 352,
   "costCodeId": 22393,
   "itemId": 8970044,
   "userId": 37979,
   "createdAt": "2013-08-25T20:52:48.285924Z",
   "updatedAt": "2024-04-03T22:02:47.309Z",
   "createdBy": 37979,
   "updatedBy": 168
}

Delete Time Entry

DELETE

Sample Request

curl --location --request DELETE 'https://next.liquidplanner.com/api/workspaces/<workspace id>/logged-time-entries/v1' \
--header 'Authorization: Bearer  {{TOKEN}}'

No response is provided for delete.

Updated 4 months ago