Chilkat Online Tools

delphiDll / New FreshBooks / Delete Payment

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Accounting_systemid: PWideChar;
Amount: PWideChar;
Code: PWideChar;
Clientid: Integer;
Creditid: PWideChar;
Date: PWideChar;
From_credit: Boolean;
Gateway: PWideChar;
Id: Integer;
Invoiceid: Integer;
Logid: Integer;
Note: PWideChar;
Orderid: PWideChar;
Overpaymentid: PWideChar;
Transactionid: PWideChar;
v_Type: PWideChar;
Updated: PWideChar;
Vis_state: Integer;

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

http := CkHttp_Create();

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

// The following JSON is sent in the request body.

// {
//   "payment": {
//     "vis_state": 1
//   }
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateInt(json,'payment.vis_state',1);

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

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

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

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

// {
//   "response": {
//     "result": {
//       "payment": {
//         "accounting_systemid": "wkMd2g",
//         "amount": {
//           "amount": "10.00",
//           "code": "USD"
//         },
//         "clientid": 31006,
//         "creditid": null,
//         "date": "2019-04-19",
//         "from_credit": false,
//         "gateway": null,
//         "id": 7658,
//         "invoiceid": 26398,
//         "logid": 7658,
//         "note": "Updated with proper invoice amount",
//         "orderid": null,
//         "overpaymentid": null,
//         "transactionid": null,
//         "type": "Check",
//         "updated": "2019-04-24 14:23:57",
//         "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

Accounting_systemid := CkJsonObject__stringOf(jResp,'response.result.payment.accounting_systemid');
Amount := CkJsonObject__stringOf(jResp,'response.result.payment.amount.amount');
Code := CkJsonObject__stringOf(jResp,'response.result.payment.amount.code');
Clientid := CkJsonObject_IntOf(jResp,'response.result.payment.clientid');
Creditid := CkJsonObject__stringOf(jResp,'response.result.payment.creditid');
Date := CkJsonObject__stringOf(jResp,'response.result.payment.date');
From_credit := CkJsonObject_BoolOf(jResp,'response.result.payment.from_credit');
Gateway := CkJsonObject__stringOf(jResp,'response.result.payment.gateway');
Id := CkJsonObject_IntOf(jResp,'response.result.payment.id');
Invoiceid := CkJsonObject_IntOf(jResp,'response.result.payment.invoiceid');
Logid := CkJsonObject_IntOf(jResp,'response.result.payment.logid');
Note := CkJsonObject__stringOf(jResp,'response.result.payment.note');
Orderid := CkJsonObject__stringOf(jResp,'response.result.payment.orderid');
Overpaymentid := CkJsonObject__stringOf(jResp,'response.result.payment.overpaymentid');
Transactionid := CkJsonObject__stringOf(jResp,'response.result.payment.transactionid');
v_Type := CkJsonObject__stringOf(jResp,'response.result.payment.type');
Updated := CkJsonObject__stringOf(jResp,'response.result.payment.updated');
Vis_state := CkJsonObject_IntOf(jResp,'response.result.payment.vis_state');

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

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

Postman Collection Item JSON

{
  "name": "Delete Payment",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"payment\":{\n  \t\"vis_state\": 1\n  }\n }"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "payments",
        "payments",
        "{{paymentId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Payment",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"payment\":{\n  \t\"vis_state\": 1\n  }\n }"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "payments",
            "payments",
            "{{paymentId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGEUkJTQFPAltXBANWVlQBCwRdU1YEAAFKUAEaEVReVFsGBFwAC10CVAYDDQATTVUDCEVSPA=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:23:57 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:23:57 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            \"payment\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"amount\": {\n                    \"amount\": \"10.00\",\n                    \"code\": \"USD\"\n                },\n                \"clientid\": 31006,\n                \"creditid\": null,\n                \"date\": \"2019-04-19\",\n                \"from_credit\": false,\n                \"gateway\": null,\n                \"id\": 7658,\n                \"invoiceid\": 26398,\n                \"logid\": 7658,\n                \"note\": \"Updated with proper invoice amount\",\n                \"orderid\": null,\n                \"overpaymentid\": null,\n                \"transactionid\": null,\n                \"type\": \"Check\",\n                \"updated\": \"2019-04-24 14:23:57\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}