delphiDll / New FreshBooks / List Estimates
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;
code: 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;
Page: Integer;
Pages: Integer;
Per_page: Integer;
Total: Integer;
i: Integer;
count_i: 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>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates',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": {
// "estimates": [
// {
// "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
// }
// ],
// "page": 1,
// "pages": 1,
// "per_page": 15,
// "total": 1
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Page := CkJsonObject_IntOf(jResp,'response.result.page');
Pages := CkJsonObject_IntOf(jResp,'response.result.pages');
Per_page := CkJsonObject_IntOf(jResp,'response.result.per_page');
Total := CkJsonObject_IntOf(jResp,'response.result.total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'response.result.estimates');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
accepted := CkJsonObject_BoolOf(jResp,'response.result.estimates[i].accepted');
accounting_systemid := CkJsonObject__stringOf(jResp,'response.result.estimates[i].accounting_systemid');
address := CkJsonObject__stringOf(jResp,'response.result.estimates[i].address');
Amount := CkJsonObject__stringOf(jResp,'response.result.estimates[i].amount.amount');
Code := CkJsonObject__stringOf(jResp,'response.result.estimates[i].amount.code');
city := CkJsonObject__stringOf(jResp,'response.result.estimates[i].city');
code := CkJsonObject__stringOf(jResp,'response.result.estimates[i].code');
country := CkJsonObject__stringOf(jResp,'response.result.estimates[i].country');
create_date := CkJsonObject__stringOf(jResp,'response.result.estimates[i].create_date');
created_at := CkJsonObject__stringOf(jResp,'response.result.estimates[i].created_at');
currency_code := CkJsonObject__stringOf(jResp,'response.result.estimates[i].currency_code');
current_organization := CkJsonObject__stringOf(jResp,'response.result.estimates[i].current_organization');
customerid := CkJsonObject_IntOf(jResp,'response.result.estimates[i].customerid');
description := CkJsonObject__stringOf(jResp,'response.result.estimates[i].description');
discount_totalAmount := CkJsonObject__stringOf(jResp,'response.result.estimates[i].discount_total.amount');
discount_totalCode := CkJsonObject__stringOf(jResp,'response.result.estimates[i].discount_total.code');
discount_value := CkJsonObject__stringOf(jResp,'response.result.estimates[i].discount_value');
display_status := CkJsonObject__stringOf(jResp,'response.result.estimates[i].display_status');
estimate_number := CkJsonObject__stringOf(jResp,'response.result.estimates[i].estimate_number');
estimateid := CkJsonObject_IntOf(jResp,'response.result.estimates[i].estimateid');
ext_archive := CkJsonObject_IntOf(jResp,'response.result.estimates[i].ext_archive');
fname := CkJsonObject__stringOf(jResp,'response.result.estimates[i].fname');
id := CkJsonObject_IntOf(jResp,'response.result.estimates[i].id');
invoiced := CkJsonObject_BoolOf(jResp,'response.result.estimates[i].invoiced');
language := CkJsonObject__stringOf(jResp,'response.result.estimates[i].language');
lname := CkJsonObject__stringOf(jResp,'response.result.estimates[i].lname');
notes := CkJsonObject__stringOf(jResp,'response.result.estimates[i].notes');
organization := CkJsonObject__stringOf(jResp,'response.result.estimates[i].organization');
ownerid := CkJsonObject_IntOf(jResp,'response.result.estimates[i].ownerid');
po_number := CkJsonObject__stringOf(jResp,'response.result.estimates[i].po_number');
province := CkJsonObject__stringOf(jResp,'response.result.estimates[i].province');
reply_status := CkJsonObject__stringOf(jResp,'response.result.estimates[i].reply_status');
require_client_signature := CkJsonObject_BoolOf(jResp,'response.result.estimates[i].require_client_signature');
rich_proposal := CkJsonObject_BoolOf(jResp,'response.result.estimates[i].rich_proposal');
sentid := CkJsonObject_IntOf(jResp,'response.result.estimates[i].sentid');
status := CkJsonObject_IntOf(jResp,'response.result.estimates[i].status');
street := CkJsonObject__stringOf(jResp,'response.result.estimates[i].street');
street2 := CkJsonObject__stringOf(jResp,'response.result.estimates[i].street2');
template := CkJsonObject__stringOf(jResp,'response.result.estimates[i].template');
terms := CkJsonObject__stringOf(jResp,'response.result.estimates[i].terms');
ui_status := CkJsonObject__stringOf(jResp,'response.result.estimates[i].ui_status');
updated := CkJsonObject__stringOf(jResp,'response.result.estimates[i].updated');
vat_name := CkJsonObject__stringOf(jResp,'response.result.estimates[i].vat_name');
vat_number := CkJsonObject__stringOf(jResp,'response.result.estimates[i].vat_number');
vis_state := CkJsonObject_IntOf(jResp,'response.result.estimates[i].vis_state');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates
Postman Collection Item JSON
{
"name": "List Estimates",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"estimateId\", jsonData.response.result.estimates[0].id)"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates"
],
"query": [
{
"key": "include[]",
"value": "audit_logs\t",
"description": "Show estimate view/send history\n",
"disabled": true
},
{
"key": "include[]",
"value": "comments",
"description": "Comments made on estimate\n",
"disabled": true
},
{
"key": "include[]",
"value": "contacts",
"description": "List of client contacts\n",
"disabled": true
},
{
"key": "include[]",
"value": "lines",
"description": "Estimate lines\n",
"disabled": true
},
{
"key": "include[]",
"value": "owner",
"description": "Owner info\n",
"disabled": true
},
{
"key": "include[]",
"value": "presentation",
"description": "Presentation type\n",
"disabled": true
},
{
"key": "include[]",
"value": "project",
"description": "Projects",
"disabled": true
},
{
"key": "include[]",
"value": "invoices",
"description": "Invoices",
"disabled": true
},
{
"key": "include[]",
"value": "system",
"description": "Estimate owner's system\n",
"disabled": true
}
]
},
"description": "Get an entire list of estimates that exist within your account."
},
"response": [
{
"name": "List Estimates",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwBKQx1RH1JKBwRQU1sMAgZTVVoHBQFeUwQaHlNKQVoDB11RWl0HB1ADXABVVgFASFBWDRUGZQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:56:51 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, 24 Apr 2019 17:56:51 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 \"estimates\": [\n {\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 \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 1\n }\n }\n}"
}
]
}
