Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $bAccepted
Local $sAccounting_systemid
Local $sAddress
Local $sAmount
Local $sCode
Local $sCity
Local $sCode
Local $sCountry
Local $sCreate_date
Local $sCreated_at
Local $sCurrency_code
Local $sCurrent_organization
Local $iCustomerid
Local $sDescription
Local $sDiscount_totalAmount
Local $sDiscount_totalCode
Local $sDiscount_value
Local $sDisplay_status
Local $sEstimate_number
Local $iEstimateid
Local $iExt_archive
Local $sFname
Local $id
Local $bInvoiced
Local $sLanguage
Local $sLname
Local $sNotes
Local $sOrganization
Local $iOwnerid
Local $sPo_number
Local $sProvince
Local $sReply_status
Local $bRequire_client_signature
Local $bRich_proposal
Local $iSentid
Local $iStatus
Local $street
Local $street2
Local $sTemplate
Local $sTerms
Local $sUi_status
Local $sUpdated
Local $sVat_name
Local $sVat_number
Local $iVis_state
Local $iPage = $oJResp.IntOf("response.result.page")
Local $iPages = $oJResp.IntOf("response.result.pages")
Local $iPer_page = $oJResp.IntOf("response.result.per_page")
Local $iTotal = $oJResp.IntOf("response.result.total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("response.result.estimates")
While $i < $iCount_i
$oJResp.I = $i
$bAccepted = $oJResp.BoolOf("response.result.estimates[i].accepted")
$sAccounting_systemid = $oJResp.StringOf("response.result.estimates[i].accounting_systemid")
$sAddress = $oJResp.StringOf("response.result.estimates[i].address")
$sAmount = $oJResp.StringOf("response.result.estimates[i].amount.amount")
$sCode = $oJResp.StringOf("response.result.estimates[i].amount.code")
$sCity = $oJResp.StringOf("response.result.estimates[i].city")
$sCode = $oJResp.StringOf("response.result.estimates[i].code")
$sCountry = $oJResp.StringOf("response.result.estimates[i].country")
$sCreate_date = $oJResp.StringOf("response.result.estimates[i].create_date")
$sCreated_at = $oJResp.StringOf("response.result.estimates[i].created_at")
$sCurrency_code = $oJResp.StringOf("response.result.estimates[i].currency_code")
$sCurrent_organization = $oJResp.StringOf("response.result.estimates[i].current_organization")
$iCustomerid = $oJResp.IntOf("response.result.estimates[i].customerid")
$sDescription = $oJResp.StringOf("response.result.estimates[i].description")
$sDiscount_totalAmount = $oJResp.StringOf("response.result.estimates[i].discount_total.amount")
$sDiscount_totalCode = $oJResp.StringOf("response.result.estimates[i].discount_total.code")
$sDiscount_value = $oJResp.StringOf("response.result.estimates[i].discount_value")
$sDisplay_status = $oJResp.StringOf("response.result.estimates[i].display_status")
$sEstimate_number = $oJResp.StringOf("response.result.estimates[i].estimate_number")
$iEstimateid = $oJResp.IntOf("response.result.estimates[i].estimateid")
$iExt_archive = $oJResp.IntOf("response.result.estimates[i].ext_archive")
$sFname = $oJResp.StringOf("response.result.estimates[i].fname")
$id = $oJResp.IntOf("response.result.estimates[i].id")
$bInvoiced = $oJResp.BoolOf("response.result.estimates[i].invoiced")
$sLanguage = $oJResp.StringOf("response.result.estimates[i].language")
$sLname = $oJResp.StringOf("response.result.estimates[i].lname")
$sNotes = $oJResp.StringOf("response.result.estimates[i].notes")
$sOrganization = $oJResp.StringOf("response.result.estimates[i].organization")
$iOwnerid = $oJResp.IntOf("response.result.estimates[i].ownerid")
$sPo_number = $oJResp.StringOf("response.result.estimates[i].po_number")
$sProvince = $oJResp.StringOf("response.result.estimates[i].province")
$sReply_status = $oJResp.StringOf("response.result.estimates[i].reply_status")
$bRequire_client_signature = $oJResp.BoolOf("response.result.estimates[i].require_client_signature")
$bRich_proposal = $oJResp.BoolOf("response.result.estimates[i].rich_proposal")
$iSentid = $oJResp.IntOf("response.result.estimates[i].sentid")
$iStatus = $oJResp.IntOf("response.result.estimates[i].status")
$street = $oJResp.StringOf("response.result.estimates[i].street")
$street2 = $oJResp.StringOf("response.result.estimates[i].street2")
$sTemplate = $oJResp.StringOf("response.result.estimates[i].template")
$sTerms = $oJResp.StringOf("response.result.estimates[i].terms")
$sUi_status = $oJResp.StringOf("response.result.estimates[i].ui_status")
$sUpdated = $oJResp.StringOf("response.result.estimates[i].updated")
$sVat_name = $oJResp.StringOf("response.result.estimates[i].vat_name")
$sVat_number = $oJResp.StringOf("response.result.estimates[i].vat_number")
$iVis_state = $oJResp.IntOf("response.result.estimates[i].vis_state")
$i = $i + 1
Wend
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}"
}
]
}
