Chilkat Online Tools

TCL / New FreshBooks / Make Payment

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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": {
#     "invoiceid": 123,
#     "amount": {
#       "amount": "3300.00"
#     },
#     "date": "2019-04-19",
#     "type": "Check",
#     "note": "Paid in full"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "payment.invoiceid" 123
CkJsonObject_UpdateString $json "payment.amount.amount" "3300.00"
CkJsonObject_UpdateString $json "payment.date" "2019-04-19"
CkJsonObject_UpdateString $json "payment.type" "Check"
CkJsonObject_UpdateString $json "payment.note" "Paid in full"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "response": {
#     "result": {
#       "payment": {
#         "accounting_systemid": "wkMd2g",
#         "amount": {
#           "amount": "180.00",
#           "code": "USD"
#         },
#         "clientid": 31006,
#         "creditid": null,
#         "date": "2019-04-19",
#         "from_credit": false,
#         "gateway": null,
#         "id": 10318,
#         "invoiceid": 34420,
#         "logid": 10318,
#         "note": "Paid in full",
#         "orderid": null,
#         "overpaymentid": 10320,
#         "transactionid": null,
#         "type": "Check",
#         "updated": "2019-04-24 14:22:18",
#         "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

set Accounting_systemid [CkJsonObject_stringOf $jResp "response.result.payment.accounting_systemid"]
set Amount [CkJsonObject_stringOf $jResp "response.result.payment.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.payment.amount.code"]
set Clientid [CkJsonObject_IntOf $jResp "response.result.payment.clientid"]
set Creditid [CkJsonObject_stringOf $jResp "response.result.payment.creditid"]
set Date [CkJsonObject_stringOf $jResp "response.result.payment.date"]
set From_credit [CkJsonObject_BoolOf $jResp "response.result.payment.from_credit"]
set Gateway [CkJsonObject_stringOf $jResp "response.result.payment.gateway"]
set Id [CkJsonObject_IntOf $jResp "response.result.payment.id"]
set Invoiceid [CkJsonObject_IntOf $jResp "response.result.payment.invoiceid"]
set Logid [CkJsonObject_IntOf $jResp "response.result.payment.logid"]
set Note [CkJsonObject_stringOf $jResp "response.result.payment.note"]
set Orderid [CkJsonObject_stringOf $jResp "response.result.payment.orderid"]
set Overpaymentid [CkJsonObject_IntOf $jResp "response.result.payment.overpaymentid"]
set Transactionid [CkJsonObject_stringOf $jResp "response.result.payment.transactionid"]
set v_Type [CkJsonObject_stringOf $jResp "response.result.payment.type"]
set Updated [CkJsonObject_stringOf $jResp "response.result.payment.updated"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.payment.vis_state"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "payment":{
    "invoiceid": {{invoiceId}},
    "amount": {
      "amount": "3300.00"
    },
    "date": "2019-04-19",
    "type": "Check",
    "note": "Paid in full"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments

Postman Collection Item JSON

{
  "name": "Make Payment",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"payment\":{\n    \"invoiceid\": {{invoiceId}},\n    \"amount\": {\n      \"amount\": \"3300.00\"\n    },\n    \"date\": \"2019-04-19\",\n    \"type\": \"Check\",\n    \"note\": \"Paid in full\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "payments",
        "payments"
      ]
    },
    "description": "Add a payment to a specific invoice"
  },
  "response": [
    {
      "name": "Make Payment",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"payment\":{\n    \"invoiceid\": {{invoiceId}},\n    \"amount\": {\n      \"amount\": \"3300.00\"\n    },\n    \"date\": \"2019-04-19\",\n    \"type\": \"Check\",\n    \"note\": \"Paid in full\"\n  }\n}"
        },
        "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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGQEcVUR1RHVRRAw5XXloIBwRdVFAECARKVQcOH0AAAVpUAwlTXQlRUFEGClUJQx8EBVpEBDs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:22:18 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:22:18 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\": \"180.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\": 10318,\n                \"invoiceid\": 34420,\n                \"logid\": 10318,\n                \"note\": \"Paid in full\",\n                \"orderid\": null,\n                \"overpaymentid\": 10320,\n                \"transactionid\": null,\n                \"type\": \"Check\",\n                \"updated\": \"2019-04-24 14:22:18\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}