Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
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 = jResp.BoolOf("response.result.estimate.accepted")
Accounting_systemid = jResp.stringOf("response.result.estimate.accounting_systemid")
Address = jResp.stringOf("response.result.estimate.address")
Amount = jResp.stringOf("response.result.estimate.amount.amount")
Code = jResp.stringOf("response.result.estimate.amount.code")
City = jResp.stringOf("response.result.estimate.city")
EstimateCode = jResp.stringOf("response.result.estimate.code")
Country = jResp.stringOf("response.result.estimate.country")
Create_date = jResp.stringOf("response.result.estimate.create_date")
Created_at = jResp.stringOf("response.result.estimate.created_at")
Currency_code = jResp.stringOf("response.result.estimate.currency_code")
Current_organization = jResp.stringOf("response.result.estimate.current_organization")
Customerid = jResp.IntOf("response.result.estimate.customerid")
Description = jResp.stringOf("response.result.estimate.description")
Discount_totalAmount = jResp.stringOf("response.result.estimate.discount_total.amount")
Discount_totalCode = jResp.stringOf("response.result.estimate.discount_total.code")
Discount_value = jResp.stringOf("response.result.estimate.discount_value")
Display_status = jResp.stringOf("response.result.estimate.display_status")
Estimate_number = jResp.stringOf("response.result.estimate.estimate_number")
Estimateid = jResp.IntOf("response.result.estimate.estimateid")
Ext_archive = jResp.IntOf("response.result.estimate.ext_archive")
Fname = jResp.stringOf("response.result.estimate.fname")
Id = jResp.IntOf("response.result.estimate.id")
Invoiced = jResp.BoolOf("response.result.estimate.invoiced")
Language = jResp.stringOf("response.result.estimate.language")
Lname = jResp.stringOf("response.result.estimate.lname")
Notes = jResp.stringOf("response.result.estimate.notes")
Organization = jResp.stringOf("response.result.estimate.organization")
Ownerid = jResp.IntOf("response.result.estimate.ownerid")
Po_number = jResp.stringOf("response.result.estimate.po_number")
Province = jResp.stringOf("response.result.estimate.province")
Reply_status = jResp.stringOf("response.result.estimate.reply_status")
Require_client_signature = jResp.BoolOf("response.result.estimate.require_client_signature")
Rich_proposal = jResp.BoolOf("response.result.estimate.rich_proposal")
Sentid = jResp.IntOf("response.result.estimate.sentid")
Status = jResp.IntOf("response.result.estimate.status")
Street = jResp.stringOf("response.result.estimate.street")
Street2 = jResp.stringOf("response.result.estimate.street2")
Template = jResp.stringOf("response.result.estimate.template")
Terms = jResp.stringOf("response.result.estimate.terms")
Ui_status = jResp.stringOf("response.result.estimate.ui_status")
Updated = jResp.stringOf("response.result.estimate.updated")
Vat_name = jResp.stringOf("response.result.estimate.vat_name")
Vat_number = jResp.stringOf("response.result.estimate.vat_number")
Vis_state = jResp.IntOf("response.result.estimate.vis_state")
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}"
}
]
}
