Chilkat Online Tools

delphiAx / New FreshBooks / New Client

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Accounting_systemid: WideString;
Allow_late_fees: Integer;
Allow_late_notifications: Integer;
Bus_phone: WideString;
Company_industry: WideString;
Company_size: WideString;
Currency_code: WideString;
Direct_link_token: WideString;
v_Email: WideString;
Fax: WideString;
Fname: WideString;
Has_retainer: WideString;
Home_phone: WideString;
Id: Integer;
Language: WideString;
Last_activity: WideString;
Last_login: WideString;
Level: Integer;
Lname: WideString;
Mob_phone: WideString;
Note: WideString;
Notified: Integer;
Num_logins: Integer;
Organization: WideString;
P_city: WideString;
P_code: WideString;
P_country: WideString;
P_province: WideString;
P_street: WideString;
P_street2: WideString;
Pref_email: Integer;
Pref_gmail: Integer;
Retainer_id: WideString;
Role: WideString;
S_city: WideString;
S_code: WideString;
S_country: WideString;
S_province: WideString;
S_street: WideString;
S_street2: WideString;
Signup_date: WideString;
Statement_token: WideString;
Subdomain: WideString;
Updated: WideString;
Userid: Integer;
Username: WideString;
Vat_name: WideString;
Vat_number: WideString;
Vis_state: Integer;

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

http := TChilkatHttp.Create(Self);

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "client": {
//     "fname": "first1",
//     "lname": "last1",
//     "email": "email1@freshbooks.com",
//     "organization": "company1",
//     "vat_name": null,
//     "vat_number": "",
//     "status": null,
//     "note": null,
//     "home_phone": null,
//     "userid": null,
//     "source": null,
//     "highlight_string": null,
//     "p_street": "1655 Dupont St. W.",
//     "p_street2": null,
//     "p_city": "Toronto",
//     "p_country": "Canada",
//     "p_province": "Ontario",
//     "p_code": "M6P 3T1",
//     "currency_code": "USD",
//     "language": "en",
//     "last_activity": null,
//     "face": null,
//     "late_fee": null,
//     "late_reminders": [
//     ],
//     "contacts": [
//       {
//         "email": "email+2@freshbooks.com",
//         "fname": "first2",
//         "lname": "last2",
//         "phone1": null,
//         "userid": null,
//         "face": null
//       },
//       {
//         "email": "email+3@freshbooks.com",
//         "fname": "first3",
//         "lname": "last3",
//         "phone1": null,
//         "userid": null,
//         "face": null
//       }
//     ]
//   }
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('client.fname','first1');
json.UpdateString('client.lname','last1');
json.UpdateString('client.email','email1@freshbooks.com');
json.UpdateString('client.organization','company1');
json.UpdateNull('client.vat_name');
json.UpdateString('client.vat_number','');
json.UpdateNull('client.status');
json.UpdateNull('client.note');
json.UpdateNull('client.home_phone');
json.UpdateNull('client.userid');
json.UpdateNull('client.source');
json.UpdateNull('client.highlight_string');
json.UpdateString('client.p_street','1655 Dupont St. W.');
json.UpdateNull('client.p_street2');
json.UpdateString('client.p_city','Toronto');
json.UpdateString('client.p_country','Canada');
json.UpdateString('client.p_province','Ontario');
json.UpdateString('client.p_code','M6P 3T1');
json.UpdateString('client.currency_code','USD');
json.UpdateString('client.language','en');
json.UpdateNull('client.last_activity');
json.UpdateNull('client.face');
json.UpdateNull('client.late_fee');
json.UpdateNewArray('client.late_reminders');
json.UpdateString('client.contacts[0].email','email+2@freshbooks.com');
json.UpdateString('client.contacts[0].fname','first2');
json.UpdateString('client.contacts[0].lname','last2');
json.UpdateNull('client.contacts[0].phone1');
json.UpdateNull('client.contacts[0].userid');
json.UpdateNull('client.contacts[0].face');
json.UpdateString('client.contacts[1].email','email+3@freshbooks.com');
json.UpdateString('client.contacts[1].fname','first3');
json.UpdateString('client.contacts[1].lname','last3');
json.UpdateNull('client.contacts[1].phone1');
json.UpdateNull('client.contacts[1].userid');
json.UpdateNull('client.contacts[1].face');

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

resp := http.PostJson3('https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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": "Nicholas",
//         "has_retainer": null,
//         "home_phone": null,
//         "id": 92402,
//         "language": "en",
//         "last_activity": null,
//         "last_login": null,
//         "level": 0,
//         "lname": "Jaar",
//         "mob_phone": "",
//         "note": null,
//         "notified": false,
//         "num_logins": 0,
//         "organization": "Space Is Only Noise",
//         "p_city": "Toronto",
//         "p_code": "M6P 3T1",
//         "p_country": "",
//         "p_province": "Ontario",
//         "p_street": "1655 Dupont St. W.",
//         "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-05-08 19:25:29",
//         "statement_token": null,
//         "subdomain": null,
//         "updated": "2019-05-08 15:25:29",
//         "userid": 92402,
//         "username": "nicholasjaar2",
//         "vat_name": null,
//         "vat_number": null,
//         "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

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

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "client": {
        "fname": "first1",
        "lname": "last1",
        "email": "email1@freshbooks.com",
        "organization": "company1",
        "vat_name": null,
        "vat_number": "",
        "status": null,
        "note": null,
        "home_phone": null,
        "userid": null,
        "source": null,
        "highlight_string": null,
        "p_street": "1655 Dupont St. W.",
        "p_street2": null,
        "p_city": "Toronto",
        "p_country": "Canada",
        "p_province": "Ontario",
        "p_code": "M6P 3T1",
        "currency_code": "USD",
        "language": "en",
        "last_activity": null,
        "face": null,
        "late_fee": null,
        "late_reminders": [],
        "contacts": [
            {
                "email": "email+2@freshbooks.com",
                "fname": "first2",
                "lname": "last2",
                "phone1": null,
                "userid": null,
                "face": null
            },
            {
                "email": "email+3@freshbooks.com",
                "fname": "first3",
                "lname": "last3",
                "phone1": null,
                "userid": null,
                "face": null
            }
        ]
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients

Postman Collection Item JSON

{
  "name": "New Client",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"client\": {\n        \"fname\": \"first1\",\n        \"lname\": \"last1\",\n        \"email\": \"email1@freshbooks.com\",\n        \"organization\": \"company1\",\n        \"vat_name\": null,\n        \"vat_number\": \"\",\n        \"status\": null,\n        \"note\": null,\n        \"home_phone\": null,\n        \"userid\": null,\n        \"source\": null,\n        \"highlight_string\": null,\n        \"p_street\": \"1655 Dupont St. W.\",\n        \"p_street2\": null,\n        \"p_city\": \"Toronto\",\n        \"p_country\": \"Canada\",\n        \"p_province\": \"Ontario\",\n        \"p_code\": \"M6P 3T1\",\n        \"currency_code\": \"USD\",\n        \"language\": \"en\",\n        \"last_activity\": null,\n        \"face\": null,\n        \"late_fee\": null,\n        \"late_reminders\": [],\n        \"contacts\": [\n            {\n                \"email\": \"email+2@freshbooks.com\",\n                \"fname\": \"first2\",\n                \"lname\": \"last2\",\n                \"phone1\": null,\n                \"userid\": null,\n                \"face\": null\n            },\n            {\n                \"email\": \"email+3@freshbooks.com\",\n                \"fname\": \"first3\",\n                \"lname\": \"last3\",\n                \"phone1\": null,\n                \"userid\": null,\n                \"face\": null\n            }\n        ]\n    }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "users",
        "clients"
      ]
    },
    "description": "Note: If you do not add an `organization` to your Client object, `organization` will automatically be added as the client's first and last name. "
  },
  "response": [
    {
      "name": "New Client",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"client\": {\n        \"email\": \"api.freshbooks@gmail.com\",\n        \"fname\": \"Nicholas\",\n\t\t\"lname\": \"Jaar\",\n\t\t\"organization\": \"Space Is Only Noise\",\n\t\t\"p_street\": \"1655 Dupont St. W.\", \n\t\t\"p_city\": \"Toronto\",\n\t\t\"p_province\":\"Ontario\",\n\t\t\"p_code\": \"M6P 3T1\"\n    }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "clients"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhZLGhgCH1UXUwhRBVNdBwRVX1MKCgVQUE4FBwBKRggPUQdUAQAGVgBaWQFRUQBHFQdQDUAHOQ=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557343565"
        },
        {
          "key": "Retry-After",
          "value": "36"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 19:25:28 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:25:28 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\": \"Nicholas\",\n                \"has_retainer\": null,\n                \"home_phone\": null,\n                \"id\": 92402,\n                \"language\": \"en\",\n                \"last_activity\": null,\n                \"last_login\": null,\n                \"level\": 0,\n                \"lname\": \"Jaar\",\n                \"mob_phone\": \"\",\n                \"note\": null,\n                \"notified\": false,\n                \"num_logins\": 0,\n                \"organization\": \"Space Is Only Noise\",\n                \"p_city\": \"Toronto\",\n                \"p_code\": \"M6P 3T1\",\n                \"p_country\": \"\",\n                \"p_province\": \"Ontario\",\n                \"p_street\": \"1655 Dupont St. W.\",\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-05-08 19:25:29\",\n                \"statement_token\": null,\n                \"subdomain\": null,\n                \"updated\": \"2019-05-08 15:25:29\",\n                \"userid\": 92402,\n                \"username\": \"nicholasjaar2\",\n                \"vat_name\": null,\n                \"vat_number\": null,\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    },
    {
      "name": "Exceeding Client Limit",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"client\": {\n        \"fname\": \"first1\",\n        \"lname\": \"last1\",\n        \"email\": \"email1@freshbooks.com\",\n        \"organization\": \"company1\",\n        \"vat_name\": null,\n        \"vat_number\": \"\",\n        \"status\": null,\n        \"note\": null,\n        \"home_phone\": null,\n        \"userid\": null,\n        \"source\": null,\n        \"highlight_string\": null,\n        \"p_street\": \"1655 Dupont St. W.\",\n        \"p_street2\": null,\n        \"p_city\": \"Toronto\",\n        \"p_country\": \"Canada\",\n        \"p_province\": \"Ontario\",\n        \"p_code\": \"M6P 3T1\",\n        \"currency_code\": \"USD\",\n        \"language\": \"en\",\n        \"last_activity\": null,\n        \"face\": null,\n        \"late_fee\": null,\n        \"late_reminders\": [],\n        \"contacts\": [\n            {\n                \"email\": \"email+2@freshbooks.com\",\n                \"fname\": \"first2\",\n                \"lname\": \"last2\",\n                \"phone1\": null,\n                \"userid\": null,\n                \"face\": null\n            },\n            {\n                \"email\": \"email+3@freshbooks.com\",\n                \"fname\": \"first3\",\n                \"lname\": \"last3\",\n                \"phone1\": null,\n                \"userid\": null,\n                \"face\": null\n            }\n        ]\n    }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "clients"
          ]
        }
      },
      "status": "Payment Required",
      "code": 402,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "gunicorn/19.9.0"
        },
        {
          "key": "Date",
          "value": "Thu, 26 Sep 2019 17:17:14 GMT"
        },
        {
          "key": "content-type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxY0QwgcAwdVWBQIFxdISwUCAVhEWRItVUtOTRMQB0IRFwFUUVFcRxYbTQFNA0xUBgdVUVQPCgBcUlACAA5TVwAEBk5XUVEHThpQCVxWUwFTDlcIAwRSVwEEQ0oFWV9DATw="
        },
        {
          "key": "Content-Length",
          "value": "74"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "2"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1569518295"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "X-Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31556926; includeSubDomains; preload"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin-when-cross-origin"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Alt-Svc",
          "value": "clear"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"errors\": [\n            {\n                \"errno\": 7005,\n                \"field\": null,\n                \"message\": \"Client limit of 50 reached\",\n                \"object\": null,\n                \"value\": null\n            }\n        ]\n    }\n}"
    }
  ]
}