Chilkat Online Tools

delphiDll / New FreshBooks / Single Estimate

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Accepted: Boolean;
Accounting_systemid: PWideChar;
Address: PWideChar;
Amount: PWideChar;
Code: PWideChar;
City: PWideChar;
EstimateCode: PWideChar;
Country: PWideChar;
Create_date: PWideChar;
Created_at: PWideChar;
Currency_code: PWideChar;
Current_organization: PWideChar;
Customerid: Integer;
Description: PWideChar;
Discount_totalAmount: PWideChar;
Discount_totalCode: PWideChar;
Discount_value: PWideChar;
Display_status: PWideChar;
Estimate_number: PWideChar;
Estimateid: Integer;
Ext_archive: Integer;
Fname: PWideChar;
Id: Integer;
Invoiced: Boolean;
Language: PWideChar;
Lname: PWideChar;
Notes: PWideChar;
Organization: PWideChar;
Ownerid: Integer;
Po_number: PWideChar;
Province: PWideChar;
Reply_status: PWideChar;
Require_client_signature: Boolean;
Rich_proposal: Boolean;
Sentid: Integer;
Status: Integer;
Street: PWideChar;
Street2: PWideChar;
Template: PWideChar;
Terms: PWideChar;
Ui_status: PWideChar;
Updated: PWideChar;
Vat_name: PWideChar;
Vat_number: PWideChar;
Vis_state: Integer;

begin
// 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) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

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}"
    }
  ]
}