Chilkat Online Tools

Python / New FreshBooks / Create a Time Entry

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# 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": 7200,
#     "note": "Stuff",
#     "started_at": "2016-08-16T20:00:00.000Z",
#     "client_id": 123,
#     "project_id": 123,
#     "service_id": 123
#   }
# }

json = chilkat2.JsonObject()
json.UpdateBool("time_entry.is_logged",True)
json.UpdateInt("time_entry.duration",7200)
json.UpdateString("time_entry.note","Stuff")
json.UpdateString("time_entry.started_at","2016-08-16T20:00:00.000Z")
json.UpdateInt("time_entry.client_id",123)
json.UpdateInt("time_entry.project_id",123)
json.UpdateInt("time_entry.service_id",123)

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries","",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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-16T20:00:00Z",
#     "created_at": "2019-04-24T18:44:50Z",
#     "duration": 7200,
#     "client_id": 31006,
#     "project_id": 2989082,
#     "pending_client": null,
#     "pending_project": null,
#     "pending_task": null,
#     "task_id": null,
#     "service_id": null,
#     "note": "Stuff",
#     "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

Id = jResp.IntOf("time_entry.id")
Identity_id = jResp.IntOf("time_entry.identity_id")
Timer = jResp.StringOf("time_entry.timer")
Is_logged = jResp.BoolOf("time_entry.is_logged")
Started_at = jResp.StringOf("time_entry.started_at")
Created_at = jResp.StringOf("time_entry.created_at")
Duration = jResp.IntOf("time_entry.duration")
Client_id = jResp.IntOf("time_entry.client_id")
Project_id = jResp.IntOf("time_entry.project_id")
Pending_client = jResp.StringOf("time_entry.pending_client")
Pending_project = jResp.StringOf("time_entry.pending_project")
Pending_task = jResp.StringOf("time_entry.pending_task")
Task_id = jResp.StringOf("time_entry.task_id")
Service_id = jResp.StringOf("time_entry.service_id")
Note = jResp.StringOf("time_entry.note")
Active = jResp.BoolOf("time_entry.active")
Billable = jResp.BoolOf("time_entry.billable")
Billed = jResp.BoolOf("time_entry.billed")
Internal = jResp.BoolOf("time_entry.internal")
Retainer_id = jResp.StringOf("time_entry.retainer_id")

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: "
	-d '{
    "time_entry": {
        "is_logged": true,
        "duration": 7200,
        "note": "Stuff",
        "started_at": "2016-08-16T20:00:00.000Z",
        "client_id": {{clientId}},
        "project_id": {{projectId}}.
        "service_id": {{serviceid}}
    }
}'
https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries

Postman Collection Item JSON

{
  "name": "Create a Time Entry",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"timeEntryId\", jsonData.time_entry.id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "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\": 7200,\n        \"note\": \"Stuff\",\n        \"started_at\": \"2016-08-16T20:00:00.000Z\",\n        \"client_id\": {{clientId}},\n        \"project_id\": {{projectId}}.\n        \"service_id\": {{serviceid}}\n    }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "timetracking",
        "business",
        "{{businessId}}",
        "time_entries"
      ]
    }
  },
  "response": [
    {
      "name": "Create a Time Entry",
      "originalRequest": {
        "method": "POST",
        "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\": 7200,\n        \"note\": \"Stuff\",\n        \"started_at\": \"2016-08-16T20:00:00.000Z\",\n        \"client_id\": {{clientId}},\n        \"project_id\": {{projectId}}\n    }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "timetracking",
            "business",
            "{{businessId}}",
            "time_entries"
          ]
        }
      },
      "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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNFlkPXT1dVkBAWgBKT0MEQA0RRFQEXBdRXlU7BAxDQ14DFxMaA05WTVMEVg1WCA8MBARRClAHVQNUSAQGVEpBWlYHVgQABwEBVQYDUgBUBUFOVgNUEV1l"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:44:50 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Content-Length",
          "value": "444"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:44:50 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-16T20:00:00Z\",\n        \"created_at\": \"2019-04-24T18:44:50Z\",\n        \"duration\": 7200,\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\": \"Stuff\",\n        \"active\": true,\n        \"billable\": false,\n        \"billed\": false,\n        \"internal\": false,\n        \"retainer_id\": null\n    }\n}"
    }
  ]
}