Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$http.SetRequestHeader("Content-Type","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "system": {
# "accountid": "wkMd2g",
# "active": true,
# "auto_bill": 5,
# "billing_status": "uptodate",
# "bus_phone": "",
# "business_type": null,
# "business_uuid": null,
# "city": "",
# "code": "",
# "country": "Canada",
# "currency_code": "USD",
# "date": "2019-04-18 09:14:53",
# "discountid": null,
# "dst": true,
# "duration": 12,
# "email": "api.freshbooks@gmail.com",
# "fax": "",
# "gst_amount": {
# "amount": "0.00",
# "code": "USD"
# },
# "heard_about_us_via": null,
# "id": 4236410,
# "info_email": "api.freshbooks@gmail.com",
# "ip": "62.205.194.4",
# "landing_url": null,
# "masterlock_billing": true,
# "migrated_to_smux_at": null,
# "mob_phone": "",
# "modern_system": true,
# "name": "Postman Sandbox",
# "num_clients": null,
# "num_staff": null,
# "payment_amount": {
# "amount": "0.00",
# "code": "USD"
# },
# "payment_frequency": 1,
# "province": "",
# "referralid": "multibiz",
# "referring_url": null,
# "salutation": null,
# "size_limit": null,
# "split_token": null,
# "street": "",
# "street2": null,
# "systemid": 4236410,
# "test_system": false,
# "timezone": "UTC",
# "timezoneid": 14,
# "vat_name": null,
# "vat_number": null
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Accountid = $jResp.StringOf("response.result.system.accountid")
$Active = $jResp.BoolOf("response.result.system.active")
$Auto_bill = $jResp.IntOf("response.result.system.auto_bill")
$Billing_status = $jResp.StringOf("response.result.system.billing_status")
$Bus_phone = $jResp.StringOf("response.result.system.bus_phone")
$Business_type = $jResp.StringOf("response.result.system.business_type")
$Business_uuid = $jResp.StringOf("response.result.system.business_uuid")
$City = $jResp.StringOf("response.result.system.city")
$Code = $jResp.StringOf("response.result.system.code")
$Country = $jResp.StringOf("response.result.system.country")
$Currency_code = $jResp.StringOf("response.result.system.currency_code")
$Date = $jResp.StringOf("response.result.system.date")
$Discountid = $jResp.StringOf("response.result.system.discountid")
$Dst = $jResp.BoolOf("response.result.system.dst")
$Duration = $jResp.IntOf("response.result.system.duration")
$v_Email = $jResp.StringOf("response.result.system.email")
$Fax = $jResp.StringOf("response.result.system.fax")
$Amount = $jResp.StringOf("response.result.system.gst_amount.amount")
$Gst_amountCode = $jResp.StringOf("response.result.system.gst_amount.code")
$Heard_about_us_via = $jResp.StringOf("response.result.system.heard_about_us_via")
$Id = $jResp.IntOf("response.result.system.id")
$Info_email = $jResp.StringOf("response.result.system.info_email")
$Ip = $jResp.StringOf("response.result.system.ip")
$Landing_url = $jResp.StringOf("response.result.system.landing_url")
$Masterlock_billing = $jResp.BoolOf("response.result.system.masterlock_billing")
$Migrated_to_smux_at = $jResp.StringOf("response.result.system.migrated_to_smux_at")
$Mob_phone = $jResp.StringOf("response.result.system.mob_phone")
$Modern_system = $jResp.BoolOf("response.result.system.modern_system")
$Name = $jResp.StringOf("response.result.system.name")
$Num_clients = $jResp.StringOf("response.result.system.num_clients")
$Num_staff = $jResp.StringOf("response.result.system.num_staff")
$Payment_amountAmount = $jResp.StringOf("response.result.system.payment_amount.amount")
$Payment_amountCode = $jResp.StringOf("response.result.system.payment_amount.code")
$Payment_frequency = $jResp.IntOf("response.result.system.payment_frequency")
$Province = $jResp.StringOf("response.result.system.province")
$Referralid = $jResp.StringOf("response.result.system.referralid")
$Referring_url = $jResp.StringOf("response.result.system.referring_url")
$Salutation = $jResp.StringOf("response.result.system.salutation")
$Size_limit = $jResp.StringOf("response.result.system.size_limit")
$Split_token = $jResp.StringOf("response.result.system.split_token")
$Street = $jResp.StringOf("response.result.system.street")
$Street2 = $jResp.StringOf("response.result.system.street2")
$Systemid = $jResp.IntOf("response.result.system.systemid")
$Test_system = $jResp.BoolOf("response.result.system.test_system")
$Timezone = $jResp.StringOf("response.result.system.timezone")
$Timezoneid = $jResp.IntOf("response.result.system.timezoneid")
$Vat_name = $jResp.StringOf("response.result.system.vat_name")
$Vat_number = $jResp.StringOf("response.result.system.vat_number")
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}
Postman Collection Item JSON
{
"name": "Get System ",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"systems",
"systems",
"{{businessId}}"
]
},
"description": "The value of `<id>` here is only meaningful if a user has access to multiple systems. See the Identity Model for more information."
},
"response": [
{
"name": "Get System ",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"systems",
"systems",
"{{businessId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gXSEVHBwsQWEMbSxZdVRYeA0kJTwFZC1VXAgRZXlANAgRQUVYEHRpXSBNUVlBfBwAFAQlUDw8GVwFUG01XAF8RAWs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:38:32 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:38:32 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"system\": {\n \"accountid\": \"wkMd2g\",\n \"active\": true,\n \"auto_bill\": 5,\n \"billing_status\": \"uptodate\",\n \"bus_phone\": \"\",\n \"business_type\": null,\n \"business_uuid\": null,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"currency_code\": \"USD\",\n \"date\": \"2019-04-18 09:14:53\",\n \"discountid\": null,\n \"dst\": true,\n \"duration\": 12,\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"gst_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"heard_about_us_via\": null,\n \"id\": 4236410,\n \"info_email\": \"api.freshbooks@gmail.com\",\n \"ip\": \"62.205.194.4\",\n \"landing_url\": null,\n \"masterlock_billing\": true,\n \"migrated_to_smux_at\": null,\n \"mob_phone\": \"\",\n \"modern_system\": true,\n \"name\": \"Postman Sandbox\",\n \"num_clients\": null,\n \"num_staff\": null,\n \"payment_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"payment_frequency\": 1,\n \"province\": \"\",\n \"referralid\": \"multibiz\",\n \"referring_url\": null,\n \"salutation\": null,\n \"size_limit\": null,\n \"split_token\": null,\n \"street\": \"\",\n \"street2\": null,\n \"systemid\": 4236410,\n \"test_system\": false,\n \"timezone\": \"UTC\",\n \"timezoneid\": 14,\n \"vat_name\": null,\n \"vat_number\": null\n }\n }\n }\n}"
}
]
}
