Chilkat Online Tools

Xojo / New FreshBooks / Update Single Tax

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "tax": {
//     "name": "TST"
//   }
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("tax.name","TST")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes/{{taxId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "response": {
//     "result": {
//       "tax": {
//         "accounting_systemid": "wkMd2g",
//         "amount": "0",
//         "compound": false,
//         "id": 4518,
//         "name": "TST",
//         "number": null,
//         "taxid": 4518,
//         "updated": "2019-04-24 14:42:04"
//       }
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim Accounting_systemid As String
Accounting_systemid = jResp.StringOf("response.result.tax.accounting_systemid")
Dim Amount As String
Amount = jResp.StringOf("response.result.tax.amount")
Dim Compound As Boolean
Compound = jResp.BoolOf("response.result.tax.compound")
Dim Id As Int32
Id = jResp.IntOf("response.result.tax.id")
Dim Name As String
Name = jResp.StringOf("response.result.tax.name")
Dim v_Number As String
v_Number = jResp.StringOf("response.result.tax.number")
Dim Taxid As Int32
Taxid = jResp.IntOf("response.result.tax.taxid")
Dim Updated As String
Updated = jResp.StringOf("response.result.tax.updated")

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "tax": {
    "name": "TST"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes/{{taxId}}

Postman Collection Item JSON

{
  "name": "Update Single Tax",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"tax\": {\n    \"name\": \"TST\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes/{{taxId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "taxes",
        "taxes",
        "{{taxId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Update Single Tax",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"tax\": {\n    \"name\": \"TST\"\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes/{{taxId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "taxes",
            "taxes",
            "{{taxId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gQUE5WEVwXA0hAFFIUCBoCC1IJVwVYC1NQAAdUUVIKChxXV04VV1RVBgkOUABVU1cCUwBSWhoYVFIJSgRs"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:42:04 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 18:42:04 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            \"tax\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"amount\": \"0\",\n                \"compound\": false,\n                \"id\": 4518,\n                \"name\": \"TST\",\n                \"number\": null,\n                \"taxid\": 4518,\n                \"updated\": \"2019-04-24 14:42:04\"\n            }\n        }\n    }\n}"
    }
  ]
}