Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim Accepted As Boolean = jResp.BoolOf("response.result.estimate.accepted")
Dim Accounting_systemid As String = jResp.StringOf("response.result.estimate.accounting_systemid")
Dim Address As String = jResp.StringOf("response.result.estimate.address")
Dim Amount As String = jResp.StringOf("response.result.estimate.amount.amount")
Dim Code As String = jResp.StringOf("response.result.estimate.amount.code")
Dim City As String = jResp.StringOf("response.result.estimate.city")
Dim EstimateCode As String = jResp.StringOf("response.result.estimate.code")
Dim Country As String = jResp.StringOf("response.result.estimate.country")
Dim Create_date As String = jResp.StringOf("response.result.estimate.create_date")
Dim Created_at As String = jResp.StringOf("response.result.estimate.created_at")
Dim Currency_code As String = jResp.StringOf("response.result.estimate.currency_code")
Dim Current_organization As String = jResp.StringOf("response.result.estimate.current_organization")
Dim Customerid As Integer = jResp.IntOf("response.result.estimate.customerid")
Dim Description As String = jResp.StringOf("response.result.estimate.description")
Dim Discount_totalAmount As String = jResp.StringOf("response.result.estimate.discount_total.amount")
Dim Discount_totalCode As String = jResp.StringOf("response.result.estimate.discount_total.code")
Dim Discount_value As String = jResp.StringOf("response.result.estimate.discount_value")
Dim Display_status As String = jResp.StringOf("response.result.estimate.display_status")
Dim Estimate_number As String = jResp.StringOf("response.result.estimate.estimate_number")
Dim Estimateid As Integer = jResp.IntOf("response.result.estimate.estimateid")
Dim Ext_archive As Integer = jResp.IntOf("response.result.estimate.ext_archive")
Dim Fname As String = jResp.StringOf("response.result.estimate.fname")
Dim Id As Integer = jResp.IntOf("response.result.estimate.id")
Dim Invoiced As Boolean = jResp.BoolOf("response.result.estimate.invoiced")
Dim Language As String = jResp.StringOf("response.result.estimate.language")
Dim Lname As String = jResp.StringOf("response.result.estimate.lname")
Dim Notes As String = jResp.StringOf("response.result.estimate.notes")
Dim Organization As String = jResp.StringOf("response.result.estimate.organization")
Dim Ownerid As Integer = jResp.IntOf("response.result.estimate.ownerid")
Dim Po_number As String = jResp.StringOf("response.result.estimate.po_number")
Dim Province As String = jResp.StringOf("response.result.estimate.province")
Dim Reply_status As String = jResp.StringOf("response.result.estimate.reply_status")
Dim Require_client_signature As Boolean = jResp.BoolOf("response.result.estimate.require_client_signature")
Dim Rich_proposal As Boolean = jResp.BoolOf("response.result.estimate.rich_proposal")
Dim Sentid As Integer = jResp.IntOf("response.result.estimate.sentid")
Dim Status As Integer = jResp.IntOf("response.result.estimate.status")
Dim Street As String = jResp.StringOf("response.result.estimate.street")
Dim Street2 As String = jResp.StringOf("response.result.estimate.street2")
Dim Template As String = jResp.StringOf("response.result.estimate.template")
Dim Terms As String = jResp.StringOf("response.result.estimate.terms")
Dim Ui_status As String = jResp.StringOf("response.result.estimate.ui_status")
Dim Updated As String = jResp.StringOf("response.result.estimate.updated")
Dim Vat_name As String = jResp.StringOf("response.result.estimate.vat_name")
Dim Vat_number As String = jResp.StringOf("response.result.estimate.vat_number")
Dim Vis_state As Integer = 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}"
}
]
}
