Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
BOOL Accepted;
const char *Accounting_systemid;
const char *Address;
const char *Amount;
const char *Code;
const char *City;
const char *EstimateCode;
const char *Country;
const char *Create_date;
const char *Created_at;
const char *Currency_code;
const char *Current_organization;
int Customerid;
const char *Description;
const char *Discount_totalAmount;
const char *Discount_totalCode;
const char *Discount_value;
const char *Display_status;
const char *Estimate_number;
int Estimateid;
int Ext_archive;
const char *Fname;
int Id;
BOOL Invoiced;
const char *Language;
const char *Lname;
const char *Notes;
const char *Organization;
int Ownerid;
const char *Po_number;
const char *Province;
const char *Reply_status;
BOOL Require_client_signature;
BOOL Rich_proposal;
int Sentid;
int Status;
const char *Street;
const char *Street2;
const char *Template;
const char *Terms;
const char *Ui_status;
const char *Updated;
const char *Vat_name;
const char *Vat_number;
int Vis_state;
// 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>");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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.
Accepted = CkJsonObject_BoolOf(jResp,"response.result.estimate.accepted");
Accounting_systemid = CkJsonObject_stringOf(jResp,"response.result.estimate.accounting_systemid");
Address = CkJsonObject_stringOf(jResp,"response.result.estimate.address");
Amount = CkJsonObject_stringOf(jResp,"response.result.estimate.amount.amount");
Code = CkJsonObject_stringOf(jResp,"response.result.estimate.amount.code");
City = CkJsonObject_stringOf(jResp,"response.result.estimate.city");
EstimateCode = CkJsonObject_stringOf(jResp,"response.result.estimate.code");
Country = CkJsonObject_stringOf(jResp,"response.result.estimate.country");
Create_date = CkJsonObject_stringOf(jResp,"response.result.estimate.create_date");
Created_at = CkJsonObject_stringOf(jResp,"response.result.estimate.created_at");
Currency_code = CkJsonObject_stringOf(jResp,"response.result.estimate.currency_code");
Current_organization = CkJsonObject_stringOf(jResp,"response.result.estimate.current_organization");
Customerid = CkJsonObject_IntOf(jResp,"response.result.estimate.customerid");
Description = CkJsonObject_stringOf(jResp,"response.result.estimate.description");
Discount_totalAmount = CkJsonObject_stringOf(jResp,"response.result.estimate.discount_total.amount");
Discount_totalCode = CkJsonObject_stringOf(jResp,"response.result.estimate.discount_total.code");
Discount_value = CkJsonObject_stringOf(jResp,"response.result.estimate.discount_value");
Display_status = CkJsonObject_stringOf(jResp,"response.result.estimate.display_status");
Estimate_number = CkJsonObject_stringOf(jResp,"response.result.estimate.estimate_number");
Estimateid = CkJsonObject_IntOf(jResp,"response.result.estimate.estimateid");
Ext_archive = CkJsonObject_IntOf(jResp,"response.result.estimate.ext_archive");
Fname = CkJsonObject_stringOf(jResp,"response.result.estimate.fname");
Id = CkJsonObject_IntOf(jResp,"response.result.estimate.id");
Invoiced = CkJsonObject_BoolOf(jResp,"response.result.estimate.invoiced");
Language = CkJsonObject_stringOf(jResp,"response.result.estimate.language");
Lname = CkJsonObject_stringOf(jResp,"response.result.estimate.lname");
Notes = CkJsonObject_stringOf(jResp,"response.result.estimate.notes");
Organization = CkJsonObject_stringOf(jResp,"response.result.estimate.organization");
Ownerid = CkJsonObject_IntOf(jResp,"response.result.estimate.ownerid");
Po_number = CkJsonObject_stringOf(jResp,"response.result.estimate.po_number");
Province = CkJsonObject_stringOf(jResp,"response.result.estimate.province");
Reply_status = CkJsonObject_stringOf(jResp,"response.result.estimate.reply_status");
Require_client_signature = CkJsonObject_BoolOf(jResp,"response.result.estimate.require_client_signature");
Rich_proposal = CkJsonObject_BoolOf(jResp,"response.result.estimate.rich_proposal");
Sentid = CkJsonObject_IntOf(jResp,"response.result.estimate.sentid");
Status = CkJsonObject_IntOf(jResp,"response.result.estimate.status");
Street = CkJsonObject_stringOf(jResp,"response.result.estimate.street");
Street2 = CkJsonObject_stringOf(jResp,"response.result.estimate.street2");
Template = CkJsonObject_stringOf(jResp,"response.result.estimate.template");
Terms = CkJsonObject_stringOf(jResp,"response.result.estimate.terms");
Ui_status = CkJsonObject_stringOf(jResp,"response.result.estimate.ui_status");
Updated = CkJsonObject_stringOf(jResp,"response.result.estimate.updated");
Vat_name = CkJsonObject_stringOf(jResp,"response.result.estimate.vat_name");
Vat_number = CkJsonObject_stringOf(jResp,"response.result.estimate.vat_number");
Vis_state = CkJsonObject_IntOf(jResp,"response.result.estimate.vis_state");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}
Postman Collection Item JSON
{
"name": "Single Estimate",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"response": [
{
"name": "Single Estimate",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBwZTVVQKCwdRU1MEBwVVSBwHH0AEBwcIUAxVCltRAwUGDFlVQx8EBVpEBDs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:57:15 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 17:57:15 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}"
}
]
}
