Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Accountid: PWideChar;
Active: Boolean;
Auto_bill: Integer;
Billing_status: PWideChar;
Bus_phone: PWideChar;
Business_type: PWideChar;
Business_uuid: PWideChar;
City: PWideChar;
Code: PWideChar;
Country: PWideChar;
Currency_code: PWideChar;
Date: PWideChar;
Discountid: PWideChar;
Dst: Boolean;
Duration: Integer;
v_Email: PWideChar;
Fax: PWideChar;
Amount: PWideChar;
Gst_amountCode: PWideChar;
Heard_about_us_via: PWideChar;
Id: Integer;
Info_email: PWideChar;
Ip: PWideChar;
Landing_url: PWideChar;
Masterlock_billing: Boolean;
Migrated_to_smux_at: PWideChar;
Mob_phone: PWideChar;
Modern_system: Boolean;
Name: PWideChar;
Num_clients: PWideChar;
Num_staff: PWideChar;
Payment_amountAmount: PWideChar;
Payment_amountCode: PWideChar;
Payment_frequency: Integer;
Province: PWideChar;
Referralid: PWideChar;
Referring_url: PWideChar;
Salutation: PWideChar;
Size_limit: PWideChar;
Split_token: PWideChar;
Street: PWideChar;
Street2: PWideChar;
Systemid: Integer;
Test_system: Boolean;
Timezone: PWideChar;
Timezoneid: Integer;
Vat_name: PWideChar;
Vat_number: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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 := CkJsonObject__stringOf(jResp,'response.result.system.accountid');
Active := CkJsonObject_BoolOf(jResp,'response.result.system.active');
Auto_bill := CkJsonObject_IntOf(jResp,'response.result.system.auto_bill');
Billing_status := CkJsonObject__stringOf(jResp,'response.result.system.billing_status');
Bus_phone := CkJsonObject__stringOf(jResp,'response.result.system.bus_phone');
Business_type := CkJsonObject__stringOf(jResp,'response.result.system.business_type');
Business_uuid := CkJsonObject__stringOf(jResp,'response.result.system.business_uuid');
City := CkJsonObject__stringOf(jResp,'response.result.system.city');
Code := CkJsonObject__stringOf(jResp,'response.result.system.code');
Country := CkJsonObject__stringOf(jResp,'response.result.system.country');
Currency_code := CkJsonObject__stringOf(jResp,'response.result.system.currency_code');
Date := CkJsonObject__stringOf(jResp,'response.result.system.date');
Discountid := CkJsonObject__stringOf(jResp,'response.result.system.discountid');
Dst := CkJsonObject_BoolOf(jResp,'response.result.system.dst');
Duration := CkJsonObject_IntOf(jResp,'response.result.system.duration');
v_Email := CkJsonObject__stringOf(jResp,'response.result.system.email');
Fax := CkJsonObject__stringOf(jResp,'response.result.system.fax');
Amount := CkJsonObject__stringOf(jResp,'response.result.system.gst_amount.amount');
Gst_amountCode := CkJsonObject__stringOf(jResp,'response.result.system.gst_amount.code');
Heard_about_us_via := CkJsonObject__stringOf(jResp,'response.result.system.heard_about_us_via');
Id := CkJsonObject_IntOf(jResp,'response.result.system.id');
Info_email := CkJsonObject__stringOf(jResp,'response.result.system.info_email');
Ip := CkJsonObject__stringOf(jResp,'response.result.system.ip');
Landing_url := CkJsonObject__stringOf(jResp,'response.result.system.landing_url');
Masterlock_billing := CkJsonObject_BoolOf(jResp,'response.result.system.masterlock_billing');
Migrated_to_smux_at := CkJsonObject__stringOf(jResp,'response.result.system.migrated_to_smux_at');
Mob_phone := CkJsonObject__stringOf(jResp,'response.result.system.mob_phone');
Modern_system := CkJsonObject_BoolOf(jResp,'response.result.system.modern_system');
Name := CkJsonObject__stringOf(jResp,'response.result.system.name');
Num_clients := CkJsonObject__stringOf(jResp,'response.result.system.num_clients');
Num_staff := CkJsonObject__stringOf(jResp,'response.result.system.num_staff');
Payment_amountAmount := CkJsonObject__stringOf(jResp,'response.result.system.payment_amount.amount');
Payment_amountCode := CkJsonObject__stringOf(jResp,'response.result.system.payment_amount.code');
Payment_frequency := CkJsonObject_IntOf(jResp,'response.result.system.payment_frequency');
Province := CkJsonObject__stringOf(jResp,'response.result.system.province');
Referralid := CkJsonObject__stringOf(jResp,'response.result.system.referralid');
Referring_url := CkJsonObject__stringOf(jResp,'response.result.system.referring_url');
Salutation := CkJsonObject__stringOf(jResp,'response.result.system.salutation');
Size_limit := CkJsonObject__stringOf(jResp,'response.result.system.size_limit');
Split_token := CkJsonObject__stringOf(jResp,'response.result.system.split_token');
Street := CkJsonObject__stringOf(jResp,'response.result.system.street');
Street2 := CkJsonObject__stringOf(jResp,'response.result.system.street2');
Systemid := CkJsonObject_IntOf(jResp,'response.result.system.systemid');
Test_system := CkJsonObject_BoolOf(jResp,'response.result.system.test_system');
Timezone := CkJsonObject__stringOf(jResp,'response.result.system.timezone');
Timezoneid := CkJsonObject_IntOf(jResp,'response.result.system.timezoneid');
Vat_name := CkJsonObject__stringOf(jResp,'response.result.system.vat_name');
Vat_number := CkJsonObject__stringOf(jResp,'response.result.system.vat_number');
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
