Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnAccepted
LOCAL lcAccounting_systemid
LOCAL lcAddress
LOCAL lcAmount
LOCAL lcCode
LOCAL lcCity
LOCAL lcCode
LOCAL lcCountry
LOCAL lcCreate_date
LOCAL lcCreated_at
LOCAL lcCurrency_code
LOCAL lcCurrent_organization
LOCAL lnCustomerid
LOCAL lcDescription
LOCAL lcDiscount_totalAmount
LOCAL lcDiscount_totalCode
LOCAL lcDiscount_value
LOCAL lcDisplay_status
LOCAL lcEstimate_number
LOCAL lnEstimateid
LOCAL lnExt_archive
LOCAL lcFname
LOCAL lnId
LOCAL lnInvoiced
LOCAL lcLanguage
LOCAL lcLname
LOCAL lcNotes
LOCAL lcOrganization
LOCAL lnOwnerid
LOCAL lcPo_number
LOCAL lcProvince
LOCAL lcReply_status
LOCAL lnRequire_client_signature
LOCAL lnRich_proposal
LOCAL lnSentid
LOCAL lnStatus
LOCAL lcStreet
LOCAL lcStreet2
LOCAL lcTemplate
LOCAL lcTerms
LOCAL lcUi_status
LOCAL lcUpdated
LOCAL lcVat_name
LOCAL lcVat_number
LOCAL lnVis_state
LOCAL lnPage
LOCAL lnPages
LOCAL lnPer_page
LOCAL lnTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lnPage = loJResp.IntOf("response.result.page")
lnPages = loJResp.IntOf("response.result.pages")
lnPer_page = loJResp.IntOf("response.result.per_page")
lnTotal = loJResp.IntOf("response.result.total")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.estimates")
DO WHILE i < lnCount_i
loJResp.I = i
lnAccepted = loJResp.BoolOf("response.result.estimates[i].accepted")
lcAccounting_systemid = loJResp.StringOf("response.result.estimates[i].accounting_systemid")
lcAddress = loJResp.StringOf("response.result.estimates[i].address")
lcAmount = loJResp.StringOf("response.result.estimates[i].amount.amount")
lcCode = loJResp.StringOf("response.result.estimates[i].amount.code")
lcCity = loJResp.StringOf("response.result.estimates[i].city")
lcCode = loJResp.StringOf("response.result.estimates[i].code")
lcCountry = loJResp.StringOf("response.result.estimates[i].country")
lcCreate_date = loJResp.StringOf("response.result.estimates[i].create_date")
lcCreated_at = loJResp.StringOf("response.result.estimates[i].created_at")
lcCurrency_code = loJResp.StringOf("response.result.estimates[i].currency_code")
lcCurrent_organization = loJResp.StringOf("response.result.estimates[i].current_organization")
lnCustomerid = loJResp.IntOf("response.result.estimates[i].customerid")
lcDescription = loJResp.StringOf("response.result.estimates[i].description")
lcDiscount_totalAmount = loJResp.StringOf("response.result.estimates[i].discount_total.amount")
lcDiscount_totalCode = loJResp.StringOf("response.result.estimates[i].discount_total.code")
lcDiscount_value = loJResp.StringOf("response.result.estimates[i].discount_value")
lcDisplay_status = loJResp.StringOf("response.result.estimates[i].display_status")
lcEstimate_number = loJResp.StringOf("response.result.estimates[i].estimate_number")
lnEstimateid = loJResp.IntOf("response.result.estimates[i].estimateid")
lnExt_archive = loJResp.IntOf("response.result.estimates[i].ext_archive")
lcFname = loJResp.StringOf("response.result.estimates[i].fname")
lnId = loJResp.IntOf("response.result.estimates[i].id")
lnInvoiced = loJResp.BoolOf("response.result.estimates[i].invoiced")
lcLanguage = loJResp.StringOf("response.result.estimates[i].language")
lcLname = loJResp.StringOf("response.result.estimates[i].lname")
lcNotes = loJResp.StringOf("response.result.estimates[i].notes")
lcOrganization = loJResp.StringOf("response.result.estimates[i].organization")
lnOwnerid = loJResp.IntOf("response.result.estimates[i].ownerid")
lcPo_number = loJResp.StringOf("response.result.estimates[i].po_number")
lcProvince = loJResp.StringOf("response.result.estimates[i].province")
lcReply_status = loJResp.StringOf("response.result.estimates[i].reply_status")
lnRequire_client_signature = loJResp.BoolOf("response.result.estimates[i].require_client_signature")
lnRich_proposal = loJResp.BoolOf("response.result.estimates[i].rich_proposal")
lnSentid = loJResp.IntOf("response.result.estimates[i].sentid")
lnStatus = loJResp.IntOf("response.result.estimates[i].status")
lcStreet = loJResp.StringOf("response.result.estimates[i].street")
lcStreet2 = loJResp.StringOf("response.result.estimates[i].street2")
lcTemplate = loJResp.StringOf("response.result.estimates[i].template")
lcTerms = loJResp.StringOf("response.result.estimates[i].terms")
lcUi_status = loJResp.StringOf("response.result.estimates[i].ui_status")
lcUpdated = loJResp.StringOf("response.result.estimates[i].updated")
lcVat_name = loJResp.StringOf("response.result.estimates[i].vat_name")
lcVat_number = loJResp.StringOf("response.result.estimates[i].vat_number")
lnVis_state = loJResp.IntOf("response.result.estimates[i].vis_state")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
