Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateInt("payment.invoiceid",123)
$oJson.UpdateString("payment.amount.amount","3300.00")
$oJson.UpdateString("payment.date","2019-04-19")
$oJson.UpdateString("payment.type","Check")
$oJson.UpdateString("payment.note","Paid in full")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sAccounting_systemid = $oJResp.StringOf("response.result.payment.accounting_systemid")
Local $sAmount = $oJResp.StringOf("response.result.payment.amount.amount")
Local $sCode = $oJResp.StringOf("response.result.payment.amount.code")
Local $iClientid = $oJResp.IntOf("response.result.payment.clientid")
Local $sCreditid = $oJResp.StringOf("response.result.payment.creditid")
Local $sDate = $oJResp.StringOf("response.result.payment.date")
Local $bFrom_credit = $oJResp.BoolOf("response.result.payment.from_credit")
Local $sGateway = $oJResp.StringOf("response.result.payment.gateway")
Local $iId = $oJResp.IntOf("response.result.payment.id")
Local $iInvoiceid = $oJResp.IntOf("response.result.payment.invoiceid")
Local $iLogid = $oJResp.IntOf("response.result.payment.logid")
Local $sNote = $oJResp.StringOf("response.result.payment.note")
Local $sOrderid = $oJResp.StringOf("response.result.payment.orderid")
Local $iOverpaymentid = $oJResp.IntOf("response.result.payment.overpaymentid")
Local $sTransactionid = $oJResp.StringOf("response.result.payment.transactionid")
Local $sV_Type = $oJResp.StringOf("response.result.payment.type")
Local $sUpdated = $oJResp.StringOf("response.result.payment.updated")
Local $iVis_state = $oJResp.IntOf("response.result.payment.vis_state")
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}"
}
]
}
