lianja / New FreshBooks / Update a Time Entry
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "time_entry": {
// "is_logged": true,
// "duration": 600,
// "note": "Updated Note",
// "started_at": "2016-08-16T18:03:28.000Z",
// "timer": {
// "id": "2936"
// },
// "client_id": 123,
// "project_id": 123
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateBool("time_entry.is_logged",.T.)
loJson.UpdateInt("time_entry.duration",600)
loJson.UpdateString("time_entry.note","Updated Note")
loJson.UpdateString("time_entry.started_at","2016-08-16T18:03:28.000Z")
loJson.UpdateString("time_entry.timer.id","2936")
loJson.UpdateInt("time_entry.client_id",123)
loJson.UpdateInt("time_entry.project_id",123)
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",loSbRequestBody,"utf-8","",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "time_entry": {
// "id": 47902064,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2016-08-16T18:03:28Z",
// "created_at": "2019-04-24T18:44:50Z",
// "duration": 600,
// "client_id": 31006,
// "project_id": 2989082,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": null,
// "note": "Updated Note",
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnId = loJResp.IntOf("time_entry.id")
lnIdentity_id = loJResp.IntOf("time_entry.identity_id")
lcTimer = loJResp.StringOf("time_entry.timer")
llIs_logged = loJResp.BoolOf("time_entry.is_logged")
lcStarted_at = loJResp.StringOf("time_entry.started_at")
lcCreated_at = loJResp.StringOf("time_entry.created_at")
lnDuration = loJResp.IntOf("time_entry.duration")
lnClient_id = loJResp.IntOf("time_entry.client_id")
lnProject_id = loJResp.IntOf("time_entry.project_id")
lcPending_client = loJResp.StringOf("time_entry.pending_client")
lcPending_project = loJResp.StringOf("time_entry.pending_project")
lcPending_task = loJResp.StringOf("time_entry.pending_task")
lcTask_id = loJResp.StringOf("time_entry.task_id")
lcService_id = loJResp.StringOf("time_entry.service_id")
lcNote = loJResp.StringOf("time_entry.note")
llActive = loJResp.BoolOf("time_entry.active")
llBillable = loJResp.BoolOf("time_entry.billable")
llBilled = loJResp.BoolOf("time_entry.billed")
llInternal = loJResp.BoolOf("time_entry.internal")
lcRetainer_id = loJResp.StringOf("time_entry.retainer_id")
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: "
-d '{
"time_entry": {
"is_logged": true,
"duration": 600,
"note": "Updated Note",
"started_at": "2016-08-16T18:03:28.000Z",
"timer": {
"id": "2936"
},
"client_id": {{clientId}},
"project_id": {{projectId}}
}
}'
https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}
Postman Collection Item JSON
{
"name": "Update a Time Entry",
"request": {
"method": "PUT",
"header": [
{
"key": "",
"name": "Content-Type",
"value": "",
"type": "text",
"disabled": true
},
{
"key": "Content-Type",
"value": "",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"time_entry\": {\n \"is_logged\": true,\n \"duration\": 600,\n \"note\": \"Updated Note\",\n \"started_at\": \"2016-08-16T18:03:28.000Z\",\n \"timer\": {\n \"id\": \"2936\"\n },\n \"client_id\": {{clientId}},\n \"project_id\": {{projectId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries",
"{{timeEntryId}}"
]
}
},
"response": [
{
"name": "Update a Time Entry",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"time_entry\": {\n \"is_logged\": true,\n \"duration\": 600,\n \"note\": \"Updated Note\",\n \"started_at\": \"2016-08-16T18:03:28.000Z\",\n \"timer\": {\n \"id\": \"2936\"\n },\n \"client_id\": {{clientId}},\n \"project_id\": {{projectId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries",
"{{timeEntryId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1904.25.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNFlkPXT1dVkBASktLBEIORhAHUw0VDw5dbFUKFRBOExtWSAEYAlRVVlcIUghUCgACBAFUCE0DVAdORgQBUVFaCQoEVQVVDwVWBFYTGlUDChAHbQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:45:14 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "450"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:45:14 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"time_entry\": {\n \"id\": 47902064,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T18:03:28Z\",\n \"created_at\": \"2019-04-24T18:44:50Z\",\n \"duration\": 600,\n \"client_id\": 31006,\n \"project_id\": 2989082,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Updated Note\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n }\n}"
}
]
}
