Chilkat Online Tools

VB6 / New FreshBooks / Create Single Other Income

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 ChilkatHttp
Dim success As Long

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

' The following JSON is sent in the request body.

' {
'   "other_income": {
'     "amount": {
'       "amount": "113.00",
'       "code": "USD"
'     },
'     "category_name": "online_sales",
'     "date": "2019-04-20",
'     "note": "Han Solo portrait",
'     "payment_type": "Visa",
'     "source": "Etsy",
'     "taxes": [
'       {
'         "amount": "3",
'         "name": "HST"
'       }
'     ]
'   }
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("other_income.amount.amount","113.00")
success = json.UpdateString("other_income.amount.code","USD")
success = json.UpdateString("other_income.category_name","online_sales")
success = json.UpdateString("other_income.date","2019-04-20")
success = json.UpdateString("other_income.note","Han Solo portrait")
success = json.UpdateString("other_income.payment_type","Visa")
success = json.UpdateString("other_income.source","Etsy")
success = json.UpdateString("other_income.taxes[0].amount","3")
success = json.UpdateString("other_income.taxes[0].name","HST")

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

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "response": {
'     "result": {
'       "other_income": {
'         "amount": {
'           "amount": "113.00",
'           "code": "USD"
'         },
'         "category_name": "online_sales",
'         "created_at": "2019-04-24 14:20:41",
'         "date": "2019-04-20",
'         "incomeid": 2852,
'         "note": "Han Solo portrait",
'         "payment_type": "VISA",
'         "source": "Etsy",
'         "taxes": [
'           {
'             "amount": "3",
'             "name": "HST"
'           }
'         ],
'         "updated_at": "2019-04-24 14:20:41",
'         "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

Dim amount As String
Dim name As String

Dim Amount As String
Amount = jResp.StringOf("response.result.other_income.amount.amount")
Dim Code As String
Code = jResp.StringOf("response.result.other_income.amount.code")
Dim Category_name As String
Category_name = jResp.StringOf("response.result.other_income.category_name")
Dim Created_at As String
Created_at = jResp.StringOf("response.result.other_income.created_at")
Dim Date As String
Date = jResp.StringOf("response.result.other_income.date")
Dim Incomeid As Long
Incomeid = jResp.IntOf("response.result.other_income.incomeid")
Dim Note As String
Note = jResp.StringOf("response.result.other_income.note")
Dim Payment_type As String
Payment_type = jResp.StringOf("response.result.other_income.payment_type")
Dim Source As String
Source = jResp.StringOf("response.result.other_income.source")
Dim Updated_at As String
Updated_at = jResp.StringOf("response.result.other_income.updated_at")
Dim Vis_state As Long
Vis_state = jResp.IntOf("response.result.other_income.vis_state")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("response.result.other_income.taxes")
Do While i < count_i
    jResp.I = i
    amount = jResp.StringOf("response.result.other_income.taxes[i].amount")
    name = jResp.StringOf("response.result.other_income.taxes[i].name")
    i = i + 1
Loop

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "other_income": {
    "amount": {
      "amount": "113.00",
      "code": "USD"
    },
    "category_name": "online_sales",
    "date": "2019-04-20",
    "note": "Han Solo portrait",
    "payment_type": "Visa",
    "source": "Etsy",
    "taxes": [
      {
        "amount": "3",
        "name": "HST"
      }
    ]
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes

Postman Collection Item JSON

{
  "name": "Create Single Other Income",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"other_income\": {\n    \"amount\": {\n      \"amount\": \"113.00\",\n      \"code\": \"USD\"\n    },\n    \"category_name\": \"online_sales\",\n    \"date\": \"2019-04-20\",\n    \"note\": \"Han Solo portrait\",\n    \"payment_type\": \"Visa\",\n    \"source\": \"Etsy\",\n    \"taxes\": [\n      {\n        \"amount\": \"3\",\n        \"name\": \"HST\"\n      }\n    ]\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "other_incomes",
        "other_incomes"
      ]
    },
    "description": "This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks."
  },
  "response": [
    {
      "name": "Create Single Other Income",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"other_income\": {\n    \"amount\": {\n      \"amount\": \"113.00\",\n      \"code\": \"USD\"\n    },\n    \"category_name\": \"online_sales\",\n    \"date\": \"2019-04-20\",\n    \"note\": \"Han Solo portrait\",\n    \"payment_type\": \"Visa\",\n    \"source\": \"Etsy\",\n    \"taxes\": [\n      {\n        \"amount\": \"3\",\n        \"name\": \"HST\"\n      }\n    ]\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "other_incomes",
            "other_incomes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BRRVNVk8IHQFRUVoHBgZSVgMDBFRfU1YDTgtQDBQWAANXCVMHVwdUBVQFAl5bXBEcAgAORFRq"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:20:41 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:20:41 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            \"other_income\": {\n                \"amount\": {\n                    \"amount\": \"113.00\",\n                    \"code\": \"USD\"\n                },\n                \"category_name\": \"online_sales\",\n                \"created_at\": \"2019-04-24 14:20:41\",\n                \"date\": \"2019-04-20\",\n                \"incomeid\": 2852,\n                \"note\": \"Han Solo portrait\",\n                \"payment_type\": \"VISA\",\n                \"source\": \"Etsy\",\n                \"taxes\": [\n                    {\n                        \"amount\": \"3\",\n                        \"name\": \"HST\"\n                    }\n                ],\n                \"updated_at\": \"2019-04-24 14:20:41\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}