Chilkat Online Tools

C++ / New FreshBooks / Edit Vendor Details

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.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;

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

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

    // {
    //   "bill_vendor": {
    //     "vendor_name": "IKEA",
    //     "primary_contact_first_name": "Jimmy",
    //     "primary_contact_last_name": "McNamara",
    //     "primary_contact_email": "jimmym@ikea.com",
    //     "primary_contact": null,
    //     "street": "332 Carlton Ave.",
    //     "street2": null,
    //     "city": "San Francisco",
    //     "province": "California",
    //     "postal_code": null,
    //     "country": "United States",
    //     "account_number": "45454545",
    //     "phone": "4158859378",
    //     "website": "ikea.com",
    //     "currency_code": "USD",
    //     "language": "en",
    //     "is_1099": false,
    //     "tax_defaults": [
    //     ]
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("bill_vendor.vendor_name","IKEA");
    json.UpdateString("bill_vendor.primary_contact_first_name","Jimmy");
    json.UpdateString("bill_vendor.primary_contact_last_name","McNamara");
    json.UpdateString("bill_vendor.primary_contact_email","jimmym@ikea.com");
    json.UpdateNull("bill_vendor.primary_contact");
    json.UpdateString("bill_vendor.street","332 Carlton Ave.");
    json.UpdateNull("bill_vendor.street2");
    json.UpdateString("bill_vendor.city","San Francisco");
    json.UpdateString("bill_vendor.province","California");
    json.UpdateNull("bill_vendor.postal_code");
    json.UpdateString("bill_vendor.country","United States");
    json.UpdateString("bill_vendor.account_number","45454545");
    json.UpdateString("bill_vendor.phone","4158859378");
    json.UpdateString("bill_vendor.website","ikea.com");
    json.UpdateString("bill_vendor.currency_code","USD");
    json.UpdateString("bill_vendor.language","en");
    json.UpdateBool("bill_vendor.is_1099",false);
    json.UpdateNewArray("bill_vendor.tax_defaults");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

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

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "response": {
    //     "result": {
    //       "bill_vendor": {
    //         "account_number": "45454545",
    //         "city": "San Francisco",
    //         "country": "United States",
    //         "created_at": "2020-10-09 15:25:05",
    //         "currency_code": "USD",
    //         "is_1099": false,
    //         "language": "en",
    //         "outstanding_balance": [
    //           {
    //             "amount": {
    //               "amount": "450.00",
    //               "code": "USD"
    //             }
    //           }
    //         ],
    //         "overdue_balance": [
    //         ],
    //         "phone": "4158859378",
    //         "postal_code": null,
    //         "primary_contact_email": "jimmym@ikea.com",
    //         "primary_contact_first_name": "Jimmy",
    //         "primary_contact_last_name": "McNamara",
    //         "province": "California",
    //         "street": "332 Carlton Ave.",
    //         "street2": null,
    //         "tax_defaults": [
    //         ],
    //         "updated_at": "2020-10-09 15:39:10",
    //         "vendor_name": "IKEA",
    //         "vendorid": 5,
    //         "vis_state": 0,
    //         "website": "ikea.com"
    //       }
    //     }
    //   }
    // }

    // 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 *Amount = 0;
    const char *Code = 0;

    const char *Account_number = jResp.stringOf("response.result.bill_vendor.account_number");
    const char *City = jResp.stringOf("response.result.bill_vendor.city");
    const char *Country = jResp.stringOf("response.result.bill_vendor.country");
    const char *Created_at = jResp.stringOf("response.result.bill_vendor.created_at");
    const char *Currency_code = jResp.stringOf("response.result.bill_vendor.currency_code");
    bool Is_1099 = jResp.BoolOf("response.result.bill_vendor.is_1099");
    const char *Language = jResp.stringOf("response.result.bill_vendor.language");
    const char *Phone = jResp.stringOf("response.result.bill_vendor.phone");
    const char *Postal_code = jResp.stringOf("response.result.bill_vendor.postal_code");
    const char *Primary_contact_email = jResp.stringOf("response.result.bill_vendor.primary_contact_email");
    const char *Primary_contact_first_name = jResp.stringOf("response.result.bill_vendor.primary_contact_first_name");
    const char *Primary_contact_last_name = jResp.stringOf("response.result.bill_vendor.primary_contact_last_name");
    const char *Province = jResp.stringOf("response.result.bill_vendor.province");
    const char *Street = jResp.stringOf("response.result.bill_vendor.street");
    const char *Street2 = jResp.stringOf("response.result.bill_vendor.street2");
    const char *Updated_at = jResp.stringOf("response.result.bill_vendor.updated_at");
    const char *Vendor_name = jResp.stringOf("response.result.bill_vendor.vendor_name");
    int Vendorid = jResp.IntOf("response.result.bill_vendor.vendorid");
    int Vis_state = jResp.IntOf("response.result.bill_vendor.vis_state");
    const char *Website = jResp.stringOf("response.result.bill_vendor.website");
    int i = 0;
    int count_i = jResp.SizeOfArray("response.result.bill_vendor.outstanding_balance");
    while (i < count_i) {
        jResp.put_I(i);
        Amount = jResp.stringOf("response.result.bill_vendor.outstanding_balance[i].amount.amount");
        Code = jResp.stringOf("response.result.bill_vendor.outstanding_balance[i].amount.code");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("response.result.bill_vendor.overdue_balance");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("response.result.bill_vendor.tax_defaults");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
    }
    }

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "bill_vendor": {
        "vendor_name": "IKEA",
        "primary_contact_first_name": "Jimmy",
        "primary_contact_last_name": "McNamara",
        "primary_contact_email": "jimmym@ikea.com",
        "primary_contact": null,
        "street": "332 Carlton Ave.",
        "street2": null,
        "city": "San Francisco",
        "province": "California",
        "postal_code": null,
        "country": "United States",
        "account_number": "45454545",
        "phone": "4158859378",
        "website": "ikea.com",
        "currency_code": "USD",
        "language": "en",
        "is_1099": false,
        "tax_defaults": []
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}

Postman Collection Item JSON

{
  "name": "Edit Vendor Details",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"bill_vendor\": {\n        \"vendor_name\": \"IKEA\",\n        \"primary_contact_first_name\": \"Jimmy\",\n        \"primary_contact_last_name\": \"McNamara\",\n        \"primary_contact_email\": \"jimmym@ikea.com\",\n        \"primary_contact\": null,\n        \"street\": \"332 Carlton Ave.\",\n        \"street2\": null,\n        \"city\": \"San Francisco\",\n        \"province\": \"California\",\n        \"postal_code\": null,\n        \"country\": \"United States\",\n        \"account_number\": \"45454545\",\n        \"phone\": \"4158859378\",\n        \"website\": \"ikea.com\",\n        \"currency_code\": \"USD\",\n        \"language\": \"en\",\n        \"is_1099\": false,\n        \"tax_defaults\": []\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "bill_vendors",
        "bill_vendors",
        "{{vendorId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Edit Vendor Details",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"bill_vendor\": {\n        \"vendor_name\": \"IKEA\",\n        \"primary_contact_first_name\": \"Jimmy\",\n        \"primary_contact_last_name\": \"McNamara\",\n        \"primary_contact_email\": \"jimmym@ikea.com\",\n        \"primary_contact\": null,\n        \"street\": \"332 Carlton Ave.\",\n        \"street2\": null,\n        \"city\": \"San Francisco\",\n        \"province\": \"California\",\n        \"postal_code\": null,\n        \"country\": \"United States\",\n        \"account_number\": \"45454545\",\n        \"phone\": \"4158859378\",\n        \"website\": \"ikea.com\",\n        \"currency_code\": \"USD\",\n        \"language\": \"en\",\n        \"is_1099\": false,\n        \"tax_defaults\": []\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "bill_vendors",
            "bill_vendors",
            "{{vendorId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Date",
          "value": "Fri, 09 Oct 2020 15:39:09 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRAGDFQNShECWl1eXxNcD1UOQUBIBhtRSFUICgJcUFcECA5XUggPAVBKVVYIThpWD11XUAJXXAcHAFdQAFNRQ0oFWV9DATw="
        },
        {
          "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": "X-RateLimit-Limit",
          "value": "600"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "599"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1602258010"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Alt-Svc",
          "value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"bill_vendor\": {\n                \"account_number\": \"45454545\",\n                \"city\": \"San Francisco\",\n                \"country\": \"United States\",\n                \"created_at\": \"2020-10-09 15:25:05\",\n                \"currency_code\": \"USD\",\n                \"is_1099\": false,\n                \"language\": \"en\",\n                \"outstanding_balance\": [\n                    {\n                        \"amount\": {\n                            \"amount\": \"450.00\",\n                            \"code\": \"USD\"\n                        }\n                    }\n                ],\n                \"overdue_balance\": [],\n                \"phone\": \"4158859378\",\n                \"postal_code\": null,\n                \"primary_contact_email\": \"jimmym@ikea.com\",\n                \"primary_contact_first_name\": \"Jimmy\",\n                \"primary_contact_last_name\": \"McNamara\",\n                \"province\": \"California\",\n                \"street\": \"332 Carlton Ave.\",\n                \"street2\": null,\n                \"tax_defaults\": [],\n                \"updated_at\": \"2020-10-09 15:39:10\",\n                \"vendor_name\": \"IKEA\",\n                \"vendorid\": 5,\n                \"vis_state\": 0,\n                \"website\": \"ikea.com\"\n            }\n        }\n    }\n}"
    }
  ]
}