Foxpro / New FreshBooks / Single Estimate With Estimate Lines
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnAccepted
LOCAL lcAccounting_systemid
LOCAL lcAddress
LOCAL lcAmount
LOCAL lcCode
LOCAL lcCity
LOCAL lcEstimateCode
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
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "estimate": {
* "customerid": 123,
* "create_date": "2019-04-20",
* "presentation": {
* "theme_primary_color": "#4f697a",
* "image_logo_src": "/service/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50IjoyMTAxMTkzLCJvcmlnaW5hbF9maWxlbmFtZSI6IkZyZXNoQm9va3MtTG9nbyAoMikucG5nIiwiYnVja2V0IjoidXBsb2FkcyIsImZpbGVuYW1lIjoidXBsb2FkLWEyY2QxMmFmZTc0MWQ1MGMwOGMyNmUyNDRhMmQzOWJkZTE2ZDY5OGMiLCJsZW5ndGgiOjg4MjQsImtleSI6Iidkb2NzLSctMjEwMTE5My91cGxvYWQtYTJjZDEyYWZlNzQxZDUwYzA4YzI2ZTI0NGEyZDM5YmRlMTZkNjk4YyJ9.vskvajegEwrVGx7v9qUZEmxWYvlwRjYqCUCKW0i7nds"
* },
* "lines": [
* {
* "type": 0,
* "description": "",
* "taxName1": "",
* "taxAmount1": 0,
* "name": "Paperwork",
* "qty": 1,
* "taxName2": "",
* "taxAmount2": 0,
* "unit_cost": {
* "amount": "5000.00",
* "code": "USD"
* }
* },
* {
* "type": 0,
* "description": "",
* "expenseid": 123,
* "taxName1": "",
* "taxAmount1": 0,
* "name": "Air Canada",
* "qty": 1,
* "taxName2": "",
* "taxAmount2": 0,
* "unit_cost": {
* "amount": "3000.00",
* "code": "USD"
* }
* }
* ]
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateInt("estimate.customerid",123)
loJson.UpdateString("estimate.create_date","2019-04-20")
loJson.UpdateString("estimate.presentation.theme_primary_color","#4f697a")
loJson.UpdateString("estimate.presentation.image_logo_src","/service/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50IjoyMTAxMTkzLCJvcmlnaW5hbF9maWxlbmFtZSI6IkZyZXNoQm9va3MtTG9nbyAoMikucG5nIiwiYnVja2V0IjoidXBsb2FkcyIsImZpbGVuYW1lIjoidXBsb2FkLWEyY2QxMmFmZTc0MWQ1MGMwOGMyNmUyNDRhMmQzOWJkZTE2ZDY5OGMiLCJsZW5ndGgiOjg4MjQsImtleSI6Iidkb2NzLSctMjEwMTE5My91cGxvYWQtYTJjZDEyYWZlNzQxZDUwYzA4YzI2ZTI0NGEyZDM5YmRlMTZkNjk4YyJ9.vskvajegEwrVGx7v9qUZEmxWYvlwRjYqCUCKW0i7nds")
loJson.UpdateInt("estimate.lines[0].type",0)
loJson.UpdateString("estimate.lines[0].description","")
loJson.UpdateString("estimate.lines[0].taxName1","")
loJson.UpdateInt("estimate.lines[0].taxAmount1",0)
loJson.UpdateString("estimate.lines[0].name","Paperwork")
loJson.UpdateInt("estimate.lines[0].qty",1)
loJson.UpdateString("estimate.lines[0].taxName2","")
loJson.UpdateInt("estimate.lines[0].taxAmount2",0)
loJson.UpdateString("estimate.lines[0].unit_cost.amount","5000.00")
loJson.UpdateString("estimate.lines[0].unit_cost.code","USD")
loJson.UpdateInt("estimate.lines[1].type",0)
loJson.UpdateString("estimate.lines[1].description","")
loJson.UpdateInt("estimate.lines[1].expenseid",123)
loJson.UpdateString("estimate.lines[1].taxName1","")
loJson.UpdateInt("estimate.lines[1].taxAmount1",0)
loJson.UpdateString("estimate.lines[1].name","Air Canada")
loJson.UpdateInt("estimate.lines[1].qty",1)
loJson.UpdateString("estimate.lines[1].taxName2","")
loJson.UpdateInt("estimate.lines[1].taxAmount2",0)
loJson.UpdateString("estimate.lines[1].unit_cost.amount","3000.00")
loJson.UpdateString("estimate.lines[1].unit_cost.code","USD")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "response": {
* "result": {
* "estimate": {
* "accepted": false,
* "accounting_systemid": "wkMd2g",
* "address": "",
* "amount": {
* "amount": "8000.00",
* "code": "USD"
* },
* "city": "",
* "code": "",
* "country": "Canada",
* "create_date": "2019-04-20",
* "created_at": "2019-04-24 13:59:15",
* "currency_code": "USD",
* "current_organization": "first company",
* "customerid": 31006,
* "description": "",
* "discount_total": {
* "amount": "0.00",
* "code": "USD"
* },
* "discount_value": "0",
* "display_status": "draft",
* "estimate_number": "0000003",
* "estimateid": 2652,
* "ext_archive": 0,
* "fname": "Nicolas",
* "id": 2652,
* "invoiced": false,
* "language": "en",
* "lname": "one",
* "notes": "",
* "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": "",
* "ui_status": "draft",
* "updated": "2019-04-24 13:59:15",
* "vat_name": "",
* "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
lnAccepted = loJResp.BoolOf("response.result.estimate.accepted")
lcAccounting_systemid = loJResp.StringOf("response.result.estimate.accounting_systemid")
lcAddress = loJResp.StringOf("response.result.estimate.address")
lcAmount = loJResp.StringOf("response.result.estimate.amount.amount")
lcCode = loJResp.StringOf("response.result.estimate.amount.code")
lcCity = loJResp.StringOf("response.result.estimate.city")
lcEstimateCode = loJResp.StringOf("response.result.estimate.code")
lcCountry = loJResp.StringOf("response.result.estimate.country")
lcCreate_date = loJResp.StringOf("response.result.estimate.create_date")
lcCreated_at = loJResp.StringOf("response.result.estimate.created_at")
lcCurrency_code = loJResp.StringOf("response.result.estimate.currency_code")
lcCurrent_organization = loJResp.StringOf("response.result.estimate.current_organization")
lnCustomerid = loJResp.IntOf("response.result.estimate.customerid")
lcDescription = loJResp.StringOf("response.result.estimate.description")
lcDiscount_totalAmount = loJResp.StringOf("response.result.estimate.discount_total.amount")
lcDiscount_totalCode = loJResp.StringOf("response.result.estimate.discount_total.code")
lcDiscount_value = loJResp.StringOf("response.result.estimate.discount_value")
lcDisplay_status = loJResp.StringOf("response.result.estimate.display_status")
lcEstimate_number = loJResp.StringOf("response.result.estimate.estimate_number")
lnEstimateid = loJResp.IntOf("response.result.estimate.estimateid")
lnExt_archive = loJResp.IntOf("response.result.estimate.ext_archive")
lcFname = loJResp.StringOf("response.result.estimate.fname")
lnId = loJResp.IntOf("response.result.estimate.id")
lnInvoiced = loJResp.BoolOf("response.result.estimate.invoiced")
lcLanguage = loJResp.StringOf("response.result.estimate.language")
lcLname = loJResp.StringOf("response.result.estimate.lname")
lcNotes = loJResp.StringOf("response.result.estimate.notes")
lcOrganization = loJResp.StringOf("response.result.estimate.organization")
lnOwnerid = loJResp.IntOf("response.result.estimate.ownerid")
lcPo_number = loJResp.StringOf("response.result.estimate.po_number")
lcProvince = loJResp.StringOf("response.result.estimate.province")
lcReply_status = loJResp.StringOf("response.result.estimate.reply_status")
lnRequire_client_signature = loJResp.BoolOf("response.result.estimate.require_client_signature")
lnRich_proposal = loJResp.BoolOf("response.result.estimate.rich_proposal")
lnSentid = loJResp.IntOf("response.result.estimate.sentid")
lnStatus = loJResp.IntOf("response.result.estimate.status")
lcStreet = loJResp.StringOf("response.result.estimate.street")
lcStreet2 = loJResp.StringOf("response.result.estimate.street2")
lcTemplate = loJResp.StringOf("response.result.estimate.template")
lcTerms = loJResp.StringOf("response.result.estimate.terms")
lcUi_status = loJResp.StringOf("response.result.estimate.ui_status")
lcUpdated = loJResp.StringOf("response.result.estimate.updated")
lcVat_name = loJResp.StringOf("response.result.estimate.vat_name")
lcVat_number = loJResp.StringOf("response.result.estimate.vat_number")
lnVis_state = loJResp.IntOf("response.result.estimate.vis_state")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"estimate": {
"customerid": {{customerId}},
"create_date": "2019-04-20",
"presentation": {
"theme_primary_color": "#4f697a",
"image_logo_src": "/service/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50IjoyMTAxMTkzLCJvcmlnaW5hbF9maWxlbmFtZSI6IkZyZXNoQm9va3MtTG9nbyAoMikucG5nIiwiYnVja2V0IjoidXBsb2FkcyIsImZpbGVuYW1lIjoidXBsb2FkLWEyY2QxMmFmZTc0MWQ1MGMwOGMyNmUyNDRhMmQzOWJkZTE2ZDY5OGMiLCJsZW5ndGgiOjg4MjQsImtleSI6Iidkb2NzLSctMjEwMTE5My91cGxvYWQtYTJjZDEyYWZlNzQxZDUwYzA4YzI2ZTI0NGEyZDM5YmRlMTZkNjk4YyJ9.vskvajegEwrVGx7v9qUZEmxWYvlwRjYqCUCKW0i7nds"
},
"lines": [
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Paperwork",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "5000.00",
"code": "USD"
}
},
{
"type": 0,
"description": "",
"expenseid": {{estimateId}},
"taxName1": "",
"taxAmount1": 0,
"name": "Air Canada",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "3000.00",
"code": "USD"
}
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates
Postman Collection Item JSON
{
"name": "Single Estimate With Estimate Lines",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\",\n \"presentation\": {\n \t\"theme_primary_color\": \"#4f697a\",\n \t\"image_logo_src\": \"/service/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50IjoyMTAxMTkzLCJvcmlnaW5hbF9maWxlbmFtZSI6IkZyZXNoQm9va3MtTG9nbyAoMikucG5nIiwiYnVja2V0IjoidXBsb2FkcyIsImZpbGVuYW1lIjoidXBsb2FkLWEyY2QxMmFmZTc0MWQ1MGMwOGMyNmUyNDRhMmQzOWJkZTE2ZDY5OGMiLCJsZW5ndGgiOjg4MjQsImtleSI6Iidkb2NzLSctMjEwMTE5My91cGxvYWQtYTJjZDEyYWZlNzQxZDUwYzA4YzI2ZTI0NGEyZDM5YmRlMTZkNjk4YyJ9.vskvajegEwrVGx7v9qUZEmxWYvlwRjYqCUCKW0i7nds\"\n },\n \"lines\": [\n {\n \"type\": 0,\n \"description\": \"\",\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Paperwork\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"5000.00\",\n \"code\": \"USD\"\n }\n },\n {\n \"type\": 0,\n \"description\": \"\",\n \"expenseid\": {{estimateId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Air Canada\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"3000.00\",\n \"code\": \"USD\"\n }\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates"
]
},
"description": "Creates a single estimate with multiple estimate lines and a logo and colourway."
},
"response": [
{
"name": "Single Estimate With Estimate Lines",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"customerid\": {{customerId}},\n \"create_date\": \"2019-04-20\",\n \"presentation\": {\n \t\"theme_primary_color\": \"#4f697a\",\n \t\"image_logo_src\": \"/service/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50IjoyMTAxMTkzLCJvcmlnaW5hbF9maWxlbmFtZSI6IkZyZXNoQm9va3MtTG9nbyAoMikucG5nIiwiYnVja2V0IjoidXBsb2FkcyIsImZpbGVuYW1lIjoidXBsb2FkLWEyY2QxMmFmZTc0MWQ1MGMwOGMyNmUyNDRhMmQzOWJkZTE2ZDY5OGMiLCJsZW5ndGgiOjg4MjQsImtleSI6Iidkb2NzLSctMjEwMTE5My91cGxvYWQtYTJjZDEyYWZlNzQxZDUwYzA4YzI2ZTI0NGEyZDM5YmRlMTZkNjk4YyJ9.vskvajegEwrVGx7v9qUZEmxWYvlwRjYqCUCKW0i7nds\"\n },\n \"lines\": [\n {\n \"type\": 0,\n \"description\": \"\",\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Paperwork\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"5000.00\",\n \"code\": \"USD\"\n }\n },\n {\n \"type\": 0,\n \"description\": \"\",\n \"expenseid\": {{estimateId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Air Canada\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"3000.00\",\n \"code\": \"USD\"\n }\n }\n ]\n }\n}"
},
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwBKQx1RH1JKBQZSUlMAAgNSUlQABg5RXAQaAlBRW04SAQ9XCQgEBQpVXQcGWAMDBRQbBwcPS1Zt"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:59: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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 17:59: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\": \"8000.00\",\n \"code\": \"USD\"\n },\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-04-24 13:59:15\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"description\": \"\",\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"estimate_number\": \"0000003\",\n \"estimateid\": 2652,\n \"ext_archive\": 0,\n \"fname\": \"Nicolas\",\n \"id\": 2652,\n \"invoiced\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\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\": \"\",\n \"ui_status\": \"draft\",\n \"updated\": \"2019-04-24 13:59:15\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
