Chilkat Online Tools

delphiAx / New FreshBooks / Delete Single Other Income

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Amount: WideString;
Code: WideString;
Category_name: WideString;
Created_at: WideString;
Date: WideString;
Incomeid: Integer;
Note: WideString;
Payment_type: WideString;
Source: WideString;
Updated_at: WideString;
Vis_state: Integer;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

// 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
//   }
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateInt('other_income.vis_state',1);

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

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes/{{incomeId}}',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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

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 do
  begin
    jResp.I := i;
    i := i + 1;
  end;

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