Chilkat Online Tools

Perl / New FreshBooks / Update Single Other Income

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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": "125.00",
#       "code": "USD"
#     },
#     "date": "2019-04-19",
#     "source": "Squarespace Site"
#   }
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("other_income.amount.amount","125.00");
$json->UpdateString("other_income.amount.code","USD");
$json->UpdateString("other_income.date","2019-04-19");
$json->UpdateString("other_income.source","Squarespace Site");

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("Content-Type","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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": 0
#       }
#     }
#   }
# }

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

$Amount = $jResp->stringOf("response.result.other_income.amount.amount");
$Code = $jResp->stringOf("response.result.other_income.amount.code");
$Category_name = $jResp->stringOf("response.result.other_income.category_name");
$Created_at = $jResp->stringOf("response.result.other_income.created_at");
$Date = $jResp->stringOf("response.result.other_income.date");
$Incomeid = $jResp->IntOf("response.result.other_income.incomeid");
$Note = $jResp->stringOf("response.result.other_income.note");
$Payment_type = $jResp->stringOf("response.result.other_income.payment_type");
$Source = $jResp->stringOf("response.result.other_income.source");
$Updated_at = $jResp->stringOf("response.result.other_income.updated_at");
$Vis_state = $jResp->IntOf("response.result.other_income.vis_state");
$i = 0;
$count_i = $jResp->SizeOfArray("response.result.other_income.taxes");
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "other_income": {
    "amount": {
      "amount": "125.00",
      "code": "USD"
    },
    "date": "2019-04-19",
    "source": "Squarespace Site"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}

Postman Collection Item JSON

{
  "name": "Update Single Other Income",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"other_income\": {\n    \"amount\": {\n      \"amount\": \"125.00\",\n      \"code\": \"USD\"\n    },\n    \"date\": \"2019-04-19\",\n    \"source\": \"Squarespace Site\"\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}}"
      ]
    },
    "description": "Edit the source of this other income, the amount and the date. \n"
  },
  "response": [
    {
      "name": "Update 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    \"amount\": {\n      \"amount\": \"125.00\",\n      \"code\": \"USD\"\n    },\n    \"date\": \"2019-04-19\",\n    \"source\": \"Squarespace Site\"\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BFBtRSlMWAQJWV1MPAgNXUAUDClBUW1ccUw1XFBoDUAUDC1FSUwMABVAHB1JUGh9WBQ0RUmw="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:20:54 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:54 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\": 0\n            }\n        }\n    }\n}"
    }
  ]
}