Chilkat Online Tools

C++ / New FreshBooks / Update Estimate

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.

    // {
    //   "estimate": {
    //     "customerid": 123,
    //     "create_date": "2019-04-20"
    //   }
    // }

    CkJsonObject json;
    json.UpdateInt("estimate.customerid",123);
    json.UpdateString("estimate.create_date","2019-04-20");

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

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",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": {
    //       "estimate": {
    //         "accepted": false,
    //         "accounting_systemid": "wkMd2g",
    //         "address": "",
    //         "amount": {
    //           "amount": "17628.00",
    //           "code": "USD"
    //         },
    //         "city": "",
    //         "code": "",
    //         "country": "Canada",
    //         "create_date": "2019-04-18",
    //         "created_at": "2019-04-18 09:42:52",
    //         "currency_code": "USD",
    //         "current_organization": "first company",
    //         "customerid": 31006,
    //         "description": "it's a computer hardware version 1",
    //         "discount_total": {
    //           "amount": "0.00",
    //           "code": "USD"
    //         },
    //         "discount_value": "0",
    //         "display_status": "draft",
    //         "estimate_number": "0000001",
    //         "estimateid": 1706,
    //         "ext_archive": 0,
    //         "fname": "Client",
    //         "id": 1706,
    //         "invoiced": false,
    //         "language": "en",
    //         "lname": "one",
    //         "notes": "This is an estimate for the computer",
    //         "organization": "first company",
    //         "ownerid": 1,
    //         "po_number": null,
    //         "province": "",
    //         "reply_status": null,
    //         "require_client_signature": false,
    //         "rich_proposal": false,
    //         "sentid": 1,
    //         "status": 1,
    //         "street": "",
    //         "street2": "",
    //         "template": "clean-grouped",
    //         "terms": "50% deposit upon acceptance, 50% on delivery of the computers.",
    //         "ui_status": "draft",
    //         "updated": "2019-04-18 09:42:52",
    //         "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.

    bool Accepted = jResp.BoolOf("response.result.estimate.accepted");
    const char *Accounting_systemid = jResp.stringOf("response.result.estimate.accounting_systemid");
    const char *Address = jResp.stringOf("response.result.estimate.address");
    const char *Amount = jResp.stringOf("response.result.estimate.amount.amount");
    const char *Code = jResp.stringOf("response.result.estimate.amount.code");
    const char *City = jResp.stringOf("response.result.estimate.city");
    const char *EstimateCode = jResp.stringOf("response.result.estimate.code");
    const char *Country = jResp.stringOf("response.result.estimate.country");
    const char *Create_date = jResp.stringOf("response.result.estimate.create_date");
    const char *Created_at = jResp.stringOf("response.result.estimate.created_at");
    const char *Currency_code = jResp.stringOf("response.result.estimate.currency_code");
    const char *Current_organization = jResp.stringOf("response.result.estimate.current_organization");
    int Customerid = jResp.IntOf("response.result.estimate.customerid");
    const char *Description = jResp.stringOf("response.result.estimate.description");
    const char *Discount_totalAmount = jResp.stringOf("response.result.estimate.discount_total.amount");
    const char *Discount_totalCode = jResp.stringOf("response.result.estimate.discount_total.code");
    const char *Discount_value = jResp.stringOf("response.result.estimate.discount_value");
    const char *Display_status = jResp.stringOf("response.result.estimate.display_status");
    const char *Estimate_number = jResp.stringOf("response.result.estimate.estimate_number");
    int Estimateid = jResp.IntOf("response.result.estimate.estimateid");
    int Ext_archive = jResp.IntOf("response.result.estimate.ext_archive");
    const char *Fname = jResp.stringOf("response.result.estimate.fname");
    int Id = jResp.IntOf("response.result.estimate.id");
    bool Invoiced = jResp.BoolOf("response.result.estimate.invoiced");
    const char *Language = jResp.stringOf("response.result.estimate.language");
    const char *Lname = jResp.stringOf("response.result.estimate.lname");
    const char *Notes = jResp.stringOf("response.result.estimate.notes");
    const char *Organization = jResp.stringOf("response.result.estimate.organization");
    int Ownerid = jResp.IntOf("response.result.estimate.ownerid");
    const char *Po_number = jResp.stringOf("response.result.estimate.po_number");
    const char *Province = jResp.stringOf("response.result.estimate.province");
    const char *Reply_status = jResp.stringOf("response.result.estimate.reply_status");
    bool Require_client_signature = jResp.BoolOf("response.result.estimate.require_client_signature");
    bool Rich_proposal = jResp.BoolOf("response.result.estimate.rich_proposal");
    int Sentid = jResp.IntOf("response.result.estimate.sentid");
    int Status = jResp.IntOf("response.result.estimate.status");
    const char *Street = jResp.stringOf("response.result.estimate.street");
    const char *Street2 = jResp.stringOf("response.result.estimate.street2");
    const char *Template = jResp.stringOf("response.result.estimate.template");
    const char *Terms = jResp.stringOf("response.result.estimate.terms");
    const char *Ui_status = jResp.stringOf("response.result.estimate.ui_status");
    const char *Updated = jResp.stringOf("response.result.estimate.updated");
    const char *Vat_name = jResp.stringOf("response.result.estimate.vat_name");
    const char *Vat_number = jResp.stringOf("response.result.estimate.vat_number");
    int Vis_state = jResp.IntOf("response.result.estimate.vis_state");
    }

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "estimate": {
     "customerid": {{customerId}},
     "create_date": "2019-04-20"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}

Postman Collection Item JSON

{
  "name": "Update Estimate",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"estimate\": {\n     \"customerid\": {{customerId}},\n     \"create_date\": \"2019-04-20\"\n  }\n}"
    },
    "url": {
      "raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "estimates",
        "estimates",
        "{{estimateId}}"
      ]
    },
    "description": "Updating an estimate with a 30% discount. "
  },
  "response": [
    {
      "name": "Update Estimate",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"estimate\": {\n     \"customerid\": {{customerId}},\n     \"create_date\": \"2019-04-20\"\n  }\n}"
        },
        "url": {
          "raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "estimates",
            "estimates",
            "{{estimateId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBQ5UUlIJBwlVUlsDAQNVSBwHH0AHVQBTVlxbC1kAAAIGWwMJQx8EBVpEBDs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:00: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:00: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            \"estimate\": {\n                \"accepted\": false,\n                \"accounting_systemid\": \"wkMd2g\",\n                \"address\": \"\",\n                \"amount\": {\n                    \"amount\": \"17628.00\",\n                    \"code\": \"USD\"\n                },\n                \"city\": \"\",\n                \"code\": \"\",\n                \"country\": \"Canada\",\n                \"create_date\": \"2019-04-18\",\n                \"created_at\": \"2019-04-18 09:42:52\",\n                \"currency_code\": \"USD\",\n                \"current_organization\": \"first company\",\n                \"customerid\": 31006,\n                \"description\": \"it's a computer hardware version 1\",\n                \"discount_total\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"USD\"\n                },\n                \"discount_value\": \"0\",\n                \"display_status\": \"draft\",\n                \"estimate_number\": \"0000001\",\n                \"estimateid\": 1706,\n                \"ext_archive\": 0,\n                \"fname\": \"Client\",\n                \"id\": 1706,\n                \"invoiced\": false,\n                \"language\": \"en\",\n                \"lname\": \"one\",\n                \"notes\": \"This is an estimate for the computer\",\n                \"organization\": \"first company\",\n                \"ownerid\": 1,\n                \"po_number\": null,\n                \"province\": \"\",\n                \"reply_status\": null,\n                \"require_client_signature\": false,\n                \"rich_proposal\": false,\n                \"sentid\": 1,\n                \"status\": 1,\n                \"street\": \"\",\n                \"street2\": \"\",\n                \"template\": \"clean-grouped\",\n                \"terms\": \"50% deposit upon acceptance, 50% on delivery of the computers.\",\n                \"ui_status\": \"draft\",\n                \"updated\": \"2019-04-18 09:42:52\",\n                \"vat_name\": null,\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}