Chilkat Online Tools

PureBasic / New FreshBooks / Accept Estimate

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateBool(json,"estimate.action_accept",1)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

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


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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}"
    }
  ]
}