Chilkat Online Tools

Xojo / New FreshBooks / List Payments

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

// {
//   "response": {
//     "result": {
//       "page": 1,
//       "pages": 1,
//       "payments": [
//         {
//           "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
//         },
//         {
//           "accounting_systemid": "wkMd2g",
//           "amount": {
//             "amount": "8000.00",
//             "code": "USD"
//           },
//           "clientid": 31006,
//           "creditid": null,
//           "date": "2019-04-19",
//           "from_credit": false,
//           "gateway": null,
//           "id": 7656,
//           "invoiceid": 24068,
//           "logid": 7656,
//           "note": "VISA",
//           "orderid": null,
//           "overpaymentid": null,
//           "transactionid": null,
//           "type": "Credit Card",
//           "updated": "2019-04-19 13:59:30",
//           "vis_state": 0
//         },
//         {
//           "accounting_systemid": "wkMd2g",
//           "amount": {
//             "amount": "50.00",
//             "code": "USD"
//           },
//           "clientid": 32080,
//           "creditid": null,
//           "date": "2019-04-19",
//           "from_credit": false,
//           "gateway": null,
//           "id": 7654,
//           "invoiceid": 26250,
//           "logid": 7654,
//           "note": "Paid on time",
//           "orderid": null,
//           "overpaymentid": null,
//           "transactionid": null,
//           "type": "Cash",
//           "updated": "2019-04-19 13:28:17",
//           "vis_state": 0
//         }
//       ],
//       "per_page": 15,
//       "total": 3
//     }
//   }
// }

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

Dim accounting_systemid As String
Dim Amount As String
Dim Code As String
Dim clientid As Int32
Dim creditid As String
Dim date As String
Dim from_credit As Boolean
Dim gateway As String
Dim id As Int32
Dim invoiceid As Int32
Dim logid As Int32
Dim note As String
Dim orderid As String
Dim overpaymentid As String
Dim transactionid As String
Dim v_type As String
Dim updated As String
Dim vis_state As Int32

Dim Page As Int32
Page = jResp.IntOf("response.result.page")
Dim Pages As Int32
Pages = jResp.IntOf("response.result.pages")
Dim Per_page As Int32
Per_page = jResp.IntOf("response.result.per_page")
Dim Total As Int32
Total = jResp.IntOf("response.result.total")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("response.result.payments")
While i < count_i
    jResp.I = i
    accounting_systemid = jResp.StringOf("response.result.payments[i].accounting_systemid")
    Amount = jResp.StringOf("response.result.payments[i].amount.amount")
    Code = jResp.StringOf("response.result.payments[i].amount.code")
    clientid = jResp.IntOf("response.result.payments[i].clientid")
    creditid = jResp.StringOf("response.result.payments[i].creditid")
    date = jResp.StringOf("response.result.payments[i].date")
    from_credit = jResp.BoolOf("response.result.payments[i].from_credit")
    gateway = jResp.StringOf("response.result.payments[i].gateway")
    id = jResp.IntOf("response.result.payments[i].id")
    invoiceid = jResp.IntOf("response.result.payments[i].invoiceid")
    logid = jResp.IntOf("response.result.payments[i].logid")
    note = jResp.StringOf("response.result.payments[i].note")
    orderid = jResp.StringOf("response.result.payments[i].orderid")
    overpaymentid = jResp.StringOf("response.result.payments[i].overpaymentid")
    transactionid = jResp.StringOf("response.result.payments[i].transactionid")
    v_type = jResp.StringOf("response.result.payments[i].type")
    updated = jResp.StringOf("response.result.payments[i].updated")
    vis_state = jResp.IntOf("response.result.payments[i].vis_state")
    i = i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Payments",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"paymentId\", jsonData.response.result.payments[0].logid);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "payments",
        "payments"
      ]
    }
  },
  "response": [
    {
      "name": "List Payments",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "payments",
            "payments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGQEcVUR1RHVJdDgZQU1oKAgBWUVcHBg9XSBwHH0AEV1ACUV1WDwAEC1FUDVdQQx8EBVpEBDs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:22:01 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:22:01 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            \"page\": 1,\n            \"pages\": 1,\n            \"payments\": [\n                {\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                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": {\n                        \"amount\": \"8000.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\": 7656,\n                    \"invoiceid\": 24068,\n                    \"logid\": 7656,\n                    \"note\": \"VISA\",\n                    \"orderid\": null,\n                    \"overpaymentid\": null,\n                    \"transactionid\": null,\n                    \"type\": \"Credit Card\",\n                    \"updated\": \"2019-04-19 13:59:30\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": {\n                        \"amount\": \"50.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"clientid\": 32080,\n                    \"creditid\": null,\n                    \"date\": \"2019-04-19\",\n                    \"from_credit\": false,\n                    \"gateway\": null,\n                    \"id\": 7654,\n                    \"invoiceid\": 26250,\n                    \"logid\": 7654,\n                    \"note\": \"Paid on time\",\n                    \"orderid\": null,\n                    \"overpaymentid\": null,\n                    \"transactionid\": null,\n                    \"type\": \"Cash\",\n                    \"updated\": \"2019-04-19 13:28:17\",\n                    \"vis_state\": 0\n                }\n            ],\n            \"per_page\": 15,\n            \"total\": 3\n        }\n    }\n}"
    },
    {
      "name": "List Payments",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "payments",
            "payments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGQEcVUR1RHVJdDgZQU1oKAgBWUVcHBg9XSBwHH0AEV1ACUV1WDwAEC1FUDVdQQx8EBVpEBDs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:22:01 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:22:01 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            \"page\": 1,\n            \"pages\": 1,\n            \"payments\": [\n                {\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                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": {\n                        \"amount\": \"8000.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\": 7656,\n                    \"invoiceid\": 24068,\n                    \"logid\": 7656,\n                    \"note\": \"VISA\",\n                    \"orderid\": null,\n                    \"overpaymentid\": null,\n                    \"transactionid\": null,\n                    \"type\": \"Credit Card\",\n                    \"updated\": \"2019-04-19 13:59:30\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": {\n                        \"amount\": \"50.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"clientid\": 32080,\n                    \"creditid\": null,\n                    \"date\": \"2019-04-19\",\n                    \"from_credit\": false,\n                    \"gateway\": null,\n                    \"id\": 7654,\n                    \"invoiceid\": 26250,\n                    \"logid\": 7654,\n                    \"note\": \"Paid on time\",\n                    \"orderid\": null,\n                    \"overpaymentid\": null,\n                    \"transactionid\": null,\n                    \"type\": \"Cash\",\n                    \"updated\": \"2019-04-19 13:28:17\",\n                    \"vis_state\": 0\n                }\n            ],\n            \"per_page\": 15,\n            \"total\": 3\n        }\n    }\n}"
    }
  ]
}