Chilkat Online Tools

C++ / New FreshBooks / Single Client

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Content-Type","application/json");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "response": {
    //     "result": {
    //       "client": {
    //         "accounting_systemid": "wkMd2g",
    //         "allow_late_fees": true,
    //         "allow_late_notifications": true,
    //         "bus_phone": "",
    //         "company_industry": null,
    //         "company_size": null,
    //         "currency_code": "USD",
    //         "direct_link_token": null,
    //         "email": "api.freshbooks@gmail.com",
    //         "fax": "",
    //         "fname": "Nicolas",
    //         "has_retainer": null,
    //         "home_phone": "555-555-1234",
    //         "id": 31006,
    //         "language": "en",
    //         "last_activity": null,
    //         "last_login": null,
    //         "level": 0,
    //         "lname": "one",
    //         "mob_phone": "",
    //         "note": null,
    //         "notified": false,
    //         "num_logins": 0,
    //         "organization": "first company",
    //         "p_city": "",
    //         "p_code": "",
    //         "p_country": "Canada",
    //         "p_province": "",
    //         "p_street": "",
    //         "p_street2": "",
    //         "pref_email": true,
    //         "pref_gmail": false,
    //         "retainer_id": null,
    //         "role": "client",
    //         "s_city": "",
    //         "s_code": "",
    //         "s_country": "",
    //         "s_province": "",
    //         "s_street": "",
    //         "s_street2": "",
    //         "signup_date": "2019-04-18 13:38:23",
    //         "statement_token": null,
    //         "subdomain": null,
    //         "updated": "2019-04-29 16:45:55",
    //         "userid": 31006,
    //         "username": "clientone",
    //         "vat_name": null,
    //         "vat_number": "",
    //         "vis_state": 0
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *Accounting_systemid = jResp.stringOf("response.result.client.accounting_systemid");
    bool Allow_late_fees = jResp.BoolOf("response.result.client.allow_late_fees");
    bool Allow_late_notifications = jResp.BoolOf("response.result.client.allow_late_notifications");
    const char *Bus_phone = jResp.stringOf("response.result.client.bus_phone");
    const char *Company_industry = jResp.stringOf("response.result.client.company_industry");
    const char *Company_size = jResp.stringOf("response.result.client.company_size");
    const char *Currency_code = jResp.stringOf("response.result.client.currency_code");
    const char *Direct_link_token = jResp.stringOf("response.result.client.direct_link_token");
    const char *v_Email = jResp.stringOf("response.result.client.email");
    const char *Fax = jResp.stringOf("response.result.client.fax");
    const char *Fname = jResp.stringOf("response.result.client.fname");
    const char *Has_retainer = jResp.stringOf("response.result.client.has_retainer");
    const char *Home_phone = jResp.stringOf("response.result.client.home_phone");
    int Id = jResp.IntOf("response.result.client.id");
    const char *Language = jResp.stringOf("response.result.client.language");
    const char *Last_activity = jResp.stringOf("response.result.client.last_activity");
    const char *Last_login = jResp.stringOf("response.result.client.last_login");
    int Level = jResp.IntOf("response.result.client.level");
    const char *Lname = jResp.stringOf("response.result.client.lname");
    const char *Mob_phone = jResp.stringOf("response.result.client.mob_phone");
    const char *Note = jResp.stringOf("response.result.client.note");
    bool Notified = jResp.BoolOf("response.result.client.notified");
    int Num_logins = jResp.IntOf("response.result.client.num_logins");
    const char *Organization = jResp.stringOf("response.result.client.organization");
    const char *P_city = jResp.stringOf("response.result.client.p_city");
    const char *P_code = jResp.stringOf("response.result.client.p_code");
    const char *P_country = jResp.stringOf("response.result.client.p_country");
    const char *P_province = jResp.stringOf("response.result.client.p_province");
    const char *P_street = jResp.stringOf("response.result.client.p_street");
    const char *P_street2 = jResp.stringOf("response.result.client.p_street2");
    bool Pref_email = jResp.BoolOf("response.result.client.pref_email");
    bool Pref_gmail = jResp.BoolOf("response.result.client.pref_gmail");
    const char *Retainer_id = jResp.stringOf("response.result.client.retainer_id");
    const char *Role = jResp.stringOf("response.result.client.role");
    const char *S_city = jResp.stringOf("response.result.client.s_city");
    const char *S_code = jResp.stringOf("response.result.client.s_code");
    const char *S_country = jResp.stringOf("response.result.client.s_country");
    const char *S_province = jResp.stringOf("response.result.client.s_province");
    const char *S_street = jResp.stringOf("response.result.client.s_street");
    const char *S_street2 = jResp.stringOf("response.result.client.s_street2");
    const char *Signup_date = jResp.stringOf("response.result.client.signup_date");
    const char *Statement_token = jResp.stringOf("response.result.client.statement_token");
    const char *Subdomain = jResp.stringOf("response.result.client.subdomain");
    const char *Updated = jResp.stringOf("response.result.client.updated");
    int Userid = jResp.IntOf("response.result.client.userid");
    const char *Username = jResp.stringOf("response.result.client.username");
    const char *Vat_name = jResp.stringOf("response.result.client.vat_name");
    const char *Vat_number = jResp.stringOf("response.result.client.vat_number");
    int Vis_state = jResp.IntOf("response.result.client.vis_state");
    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}

Postman Collection Item JSON

{
  "name": "Single Client",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "users",
        "clients",
        "{{customerId}}"
      ]
    },
    "description": "Get a single client with the parameter associated with clientId"
  },
  "response": [
    {
      "name": "Single Client Error - Client Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customer_Id}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "clients",
            "{{customer_Id}}"
          ]
        }
      },
      "status": "NOT FOUND",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sJWQRZBFFcAgVTVVoLBAlcWU4aABtEVVBQVgZVAQZSAQxUWQ1WARFJXwBdElY/"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "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 17:50:37 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        \"errors\": [\n            {\n                \"errno\": 1012,\n                \"field\": \"userid\",\n                \"message\": \"Client not found.\",\n                \"object\": \"client\",\n                \"value\": \"{{customer_Id}}\"\n            }\n        ]\n    }\n}"
    },
    {
      "name": "Single Client",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "clients",
            "{{customerId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sIVAFTClJQDg5QX1UPBAdXVU4aABtEBQQDVlMCUQcFBloDXQsHChFJXwBdElY/"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557344346"
        },
        {
          "key": "Retry-After",
          "value": "20"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 19:38:45 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": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 19:38:45 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17330-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            \"client\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"allow_late_fees\": true,\n                \"allow_late_notifications\": true,\n                \"bus_phone\": \"\",\n                \"company_industry\": null,\n                \"company_size\": null,\n                \"currency_code\": \"USD\",\n                \"direct_link_token\": null,\n                \"email\": \"api.freshbooks@gmail.com\",\n                \"fax\": \"\",\n                \"fname\": \"Nicolas\",\n                \"has_retainer\": null,\n                \"home_phone\": \"555-555-1234\",\n                \"id\": 31006,\n                \"language\": \"en\",\n                \"last_activity\": null,\n                \"last_login\": null,\n                \"level\": 0,\n                \"lname\": \"one\",\n                \"mob_phone\": \"\",\n                \"note\": null,\n                \"notified\": false,\n                \"num_logins\": 0,\n                \"organization\": \"first company\",\n                \"p_city\": \"\",\n                \"p_code\": \"\",\n                \"p_country\": \"Canada\",\n                \"p_province\": \"\",\n                \"p_street\": \"\",\n                \"p_street2\": \"\",\n                \"pref_email\": true,\n                \"pref_gmail\": false,\n                \"retainer_id\": null,\n                \"role\": \"client\",\n                \"s_city\": \"\",\n                \"s_code\": \"\",\n                \"s_country\": \"\",\n                \"s_province\": \"\",\n                \"s_street\": \"\",\n                \"s_street2\": \"\",\n                \"signup_date\": \"2019-04-18 13:38:23\",\n                \"statement_token\": null,\n                \"subdomain\": null,\n                \"updated\": \"2019-04-29 16:45:55\",\n                \"userid\": 31006,\n                \"username\": \"clientone\",\n                \"vat_name\": null,\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}