Chilkat Online Tools

Foxpro / New FreshBooks / Create Single Other Income

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAmount
LOCAL lcName
LOCAL lcAmount
LOCAL lcCode
LOCAL lcCategory_name
LOCAL lcCreated_at
LOCAL lcDate
LOCAL lnIncomeid
LOCAL lcNote
LOCAL lcPayment_type
LOCAL lcSource
LOCAL lcUpdated_at
LOCAL lnVis_state
LOCAL i
LOCAL lnCount_i

* 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.

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

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("other_income.amount.amount","113.00")
loJson.UpdateString("other_income.amount.code","USD")
loJson.UpdateString("other_income.category_name","online_sales")
loJson.UpdateString("other_income.date","2019-04-20")
loJson.UpdateString("other_income.note","Han Solo portrait")
loJson.UpdateString("other_income.payment_type","Visa")
loJson.UpdateString("other_income.source","Etsy")
loJson.UpdateString("other_income.taxes[0].amount","3")
loJson.UpdateString("other_income.taxes[0].name","HST")

* 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}}/other_incomes/other_incomes","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": {
*       "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

lcAmount = loJResp.StringOf("response.result.other_income.amount.amount")
lcCode = loJResp.StringOf("response.result.other_income.amount.code")
lcCategory_name = loJResp.StringOf("response.result.other_income.category_name")
lcCreated_at = loJResp.StringOf("response.result.other_income.created_at")
lcDate = loJResp.StringOf("response.result.other_income.date")
lnIncomeid = loJResp.IntOf("response.result.other_income.incomeid")
lcNote = loJResp.StringOf("response.result.other_income.note")
lcPayment_type = loJResp.StringOf("response.result.other_income.payment_type")
lcSource = loJResp.StringOf("response.result.other_income.source")
lcUpdated_at = loJResp.StringOf("response.result.other_income.updated_at")
lnVis_state = loJResp.IntOf("response.result.other_income.vis_state")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.other_income.taxes")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAmount = loJResp.StringOf("response.result.other_income.taxes[i].amount")
    lcName = loJResp.StringOf("response.result.other_income.taxes[i].name")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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