Chilkat Online Tools

Foxpro / New FreshBooks / Delete Single Other Income

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
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": {
*     "vis_state": 1
*   }
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateInt("other_income.vis_state",1)

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

loSbRequestBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    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 loSbRequestBody
    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": "125.00",
*           "code": "USD"
*         },
*         "category_name": "online_sales",
*         "created_at": "2019-04-19 08:51:14",
*         "date": "2019-04-19",
*         "incomeid": 2122,
*         "note": "Nepalese Hand-sewn Pouch",
*         "payment_type": "VISA",
*         "source": "Squarespace Site",
*         "taxes": [
*         ],
*         "updated_at": "2019-04-19 08:58:09",
*         "vis_state": 1
*       }
*     }
*   }
* }

* 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
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "other_income": {
    "vis_state": 1
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}

Postman Collection Item JSON

{
  "name": "Delete Single Other Income",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"other_income\": {\n    \"vis_state\": 1\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "other_incomes",
        "other_incomes",
        "{{incomeId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Single Other Income",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"other_income\": {\n    \"vis_state\": 1\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "other_incomes",
            "other_incomes",
            "{{incomeId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BFBtRSlMWAgdRVFQPBA9WUgMBB1ZXV04EVBRAAQFXAQJQClkAUldWAAEOAkRPXlJcFwQ/"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:21:15 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:21:15 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\": \"125.00\",\n                    \"code\": \"USD\"\n                },\n                \"category_name\": \"online_sales\",\n                \"created_at\": \"2019-04-19 08:51:14\",\n                \"date\": \"2019-04-19\",\n                \"incomeid\": 2122,\n                \"note\": \"Nepalese Hand-sewn Pouch\",\n                \"payment_type\": \"VISA\",\n                \"source\": \"Squarespace Site\",\n                \"taxes\": [],\n                \"updated_at\": \"2019-04-19 08:58:09\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}