Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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": {
// "amount": {
// "amount": "10.00",
// "code": "USD"
// },
// "note": "Updated with proper invoice amount"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("payment.amount.amount","10.00")
loJson.UpdateString("payment.amount.code","USD")
loJson.UpdateString("payment.note","Updated with proper invoice amount")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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:24:09",
// "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
lcAccounting_systemid = loJResp.StringOf("response.result.payment.accounting_systemid")
lcAmount = loJResp.StringOf("response.result.payment.amount.amount")
lcCode = loJResp.StringOf("response.result.payment.amount.code")
lnClientid = loJResp.IntOf("response.result.payment.clientid")
lcCreditid = loJResp.StringOf("response.result.payment.creditid")
lcDate = loJResp.StringOf("response.result.payment.date")
llFrom_credit = loJResp.BoolOf("response.result.payment.from_credit")
lcGateway = loJResp.StringOf("response.result.payment.gateway")
lnId = loJResp.IntOf("response.result.payment.id")
lnInvoiceid = loJResp.IntOf("response.result.payment.invoiceid")
lnLogid = loJResp.IntOf("response.result.payment.logid")
lcNote = loJResp.StringOf("response.result.payment.note")
lcOrderid = loJResp.StringOf("response.result.payment.orderid")
lcOverpaymentid = loJResp.StringOf("response.result.payment.overpaymentid")
lcTransactionid = loJResp.StringOf("response.result.payment.transactionid")
lcV_Type = loJResp.StringOf("response.result.payment.type")
lcUpdated = loJResp.StringOf("response.result.payment.updated")
lnVis_state = loJResp.IntOf("response.result.payment.vis_state")
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"payment": {
"amount": {
"amount": "10.00",
"code": "USD"
},
"note": "Updated with proper invoice amount"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}
Postman Collection Item JSON
{
"name": "Update Payment",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"payment\": {\n \"amount\": {\n \"amount\": \"10.00\",\n \"code\": \"USD\"\n },\n \"note\": \"Updated with proper invoice amount\"\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": "Update Payment",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"payment\": {\n \"amount\": {\n \"amount\": \"10.00\",\n \"code\": \"USD\"\n },\n \"note\": \"Updated with proper invoice amount\"\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGEUkJTQFPAVdRAwZUU1QNBwBcWFECBAJKVQQHH0BSBVoGAFxaW1sGAlYHAFgFQx8EBVpEBDs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:24:17 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:24:17 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:24:09\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
