Chilkat Online Tools

phpAx / New FreshBooks / Single Payment

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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-19 14:05:33",
//         "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

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

?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Single Payment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "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": "Single Payment",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGEUkJTQFPA1VQAgNUVFcPBQVUUFYBBQ9KSQAaEQFUVlIHAQhVXQkNCwVTD1QTTVUDCEVSPA=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:21:49 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": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:21:49 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-19 14:05:33\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}