Chilkat Online Tools

TCL / New FreshBooks / Accept Estimate

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# 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": {
#     "action_accept": true
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateBool $json "estimate.action_accept" 1

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set Accepted [CkJsonObject_BoolOf $jResp "response.result.estimate.accepted"]
set Accounting_systemid [CkJsonObject_stringOf $jResp "response.result.estimate.accounting_systemid"]
set Address [CkJsonObject_stringOf $jResp "response.result.estimate.address"]
set Amount [CkJsonObject_stringOf $jResp "response.result.estimate.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.estimate.amount.code"]
set City [CkJsonObject_stringOf $jResp "response.result.estimate.city"]
set EstimateCode [CkJsonObject_stringOf $jResp "response.result.estimate.code"]
set Country [CkJsonObject_stringOf $jResp "response.result.estimate.country"]
set Create_date [CkJsonObject_stringOf $jResp "response.result.estimate.create_date"]
set Created_at [CkJsonObject_stringOf $jResp "response.result.estimate.created_at"]
set Currency_code [CkJsonObject_stringOf $jResp "response.result.estimate.currency_code"]
set Current_organization [CkJsonObject_stringOf $jResp "response.result.estimate.current_organization"]
set Customerid [CkJsonObject_IntOf $jResp "response.result.estimate.customerid"]
set Description [CkJsonObject_stringOf $jResp "response.result.estimate.description"]
set Discount_totalAmount [CkJsonObject_stringOf $jResp "response.result.estimate.discount_total.amount"]
set Discount_totalCode [CkJsonObject_stringOf $jResp "response.result.estimate.discount_total.code"]
set Discount_value [CkJsonObject_stringOf $jResp "response.result.estimate.discount_value"]
set Display_status [CkJsonObject_stringOf $jResp "response.result.estimate.display_status"]
set Estimate_number [CkJsonObject_stringOf $jResp "response.result.estimate.estimate_number"]
set Estimateid [CkJsonObject_IntOf $jResp "response.result.estimate.estimateid"]
set Ext_archive [CkJsonObject_IntOf $jResp "response.result.estimate.ext_archive"]
set Fname [CkJsonObject_stringOf $jResp "response.result.estimate.fname"]
set Id [CkJsonObject_IntOf $jResp "response.result.estimate.id"]
set Invoiced [CkJsonObject_BoolOf $jResp "response.result.estimate.invoiced"]
set Language [CkJsonObject_stringOf $jResp "response.result.estimate.language"]
set Lname [CkJsonObject_stringOf $jResp "response.result.estimate.lname"]
set Notes [CkJsonObject_stringOf $jResp "response.result.estimate.notes"]
set Organization [CkJsonObject_stringOf $jResp "response.result.estimate.organization"]
set Ownerid [CkJsonObject_IntOf $jResp "response.result.estimate.ownerid"]
set Po_number [CkJsonObject_stringOf $jResp "response.result.estimate.po_number"]
set Province [CkJsonObject_stringOf $jResp "response.result.estimate.province"]
set Reply_status [CkJsonObject_stringOf $jResp "response.result.estimate.reply_status"]
set Require_client_signature [CkJsonObject_BoolOf $jResp "response.result.estimate.require_client_signature"]
set Rich_proposal [CkJsonObject_BoolOf $jResp "response.result.estimate.rich_proposal"]
set Sentid [CkJsonObject_IntOf $jResp "response.result.estimate.sentid"]
set Status [CkJsonObject_IntOf $jResp "response.result.estimate.status"]
set Street [CkJsonObject_stringOf $jResp "response.result.estimate.street"]
set Street2 [CkJsonObject_stringOf $jResp "response.result.estimate.street2"]
set Template [CkJsonObject_stringOf $jResp "response.result.estimate.template"]
set Terms [CkJsonObject_stringOf $jResp "response.result.estimate.terms"]
set Ui_status [CkJsonObject_stringOf $jResp "response.result.estimate.ui_status"]
set Updated [CkJsonObject_stringOf $jResp "response.result.estimate.updated"]
set Vat_name [CkJsonObject_stringOf $jResp "response.result.estimate.vat_name"]
set Vat_number [CkJsonObject_stringOf $jResp "response.result.estimate.vat_number"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.estimate.vis_state"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "estimate": {
     "action_accept": true
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}

Postman Collection Item JSON

{
  "name": "Accept Estimate",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"estimate\": {\n     \"action_accept\": true\n  }\n}"
    },
    "url": {
      "raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "estimates",
        "estimates",
        "{{estimateId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Update Estimate",
      "originalRequest": {
        "method": "PUT",
        "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  }\n}"
        },
        "url": {
          "raw": "api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
          "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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBQ5UUlIJBwlVUlsDAQNVSBwHH0AHVQBTVlxbC1kAAAIGWwMJQx8EBVpEBDs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:00:32 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 18:00:32 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}"
    }
  ]
}