Foxpro / New FreshBooks / Add Payment to Bill
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAmount
LOCAL lcCode
LOCAL lnBillid
LOCAL lnId
LOCAL lnMatched_with_expense
LOCAL lcNote
LOCAL lcPaid_date
LOCAL lcPayment_type
LOCAL lnVis_state
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "bill_payment": {
* "billid": "7",
* "amount": {
* "amount": "375",
* "code": "USD"
* },
* "payment_type": "Check",
* "paid_date": "2020-10-09",
* "note": "",
* "bill": null
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("bill_payment.billid","7")
loJson.UpdateString("bill_payment.amount.amount","375")
loJson.UpdateString("bill_payment.amount.code","USD")
loJson.UpdateString("bill_payment.payment_type","Check")
loJson.UpdateString("bill_payment.paid_date","2020-10-09")
loJson.UpdateString("bill_payment.note","")
loJson.UpdateNull("bill_payment.bill")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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 loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "response": {
* "result": {
* "bill_payment": {
* "amount": {
* "amount": "100.00",
* "code": "EUR"
* },
* "billid": 1141,
* "id": 909,
* "matched_with_expense": false,
* "note": "",
* "paid_date": "2021-01-30",
* "payment_type": "Check",
* "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
lcAmount = loJResp.StringOf("response.result.bill_payment.amount.amount")
lcCode = loJResp.StringOf("response.result.bill_payment.amount.code")
lnBillid = loJResp.IntOf("response.result.bill_payment.billid")
lnId = loJResp.IntOf("response.result.bill_payment.id")
lnMatched_with_expense = loJResp.BoolOf("response.result.bill_payment.matched_with_expense")
lcNote = loJResp.StringOf("response.result.bill_payment.note")
lcPaid_date = loJResp.StringOf("response.result.bill_payment.paid_date")
lcPayment_type = loJResp.StringOf("response.result.bill_payment.payment_type")
lnVis_state = loJResp.IntOf("response.result.bill_payment.vis_state")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"bill_payment": {
"billid": "7",
"amount": {
"amount": "375",
"code": "USD"
},
"payment_type": "Check",
"paid_date": "2020-10-09",
"note": "",
"bill": null
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments
Postman Collection Item JSON
{
"name": "Add Payment to Bill",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"billPaymentId\", jsonData.response.result.bill_payment.id)"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_payment\": {\n \"billid\": \"7\",\n \"amount\": {\n \"amount\": \"375\",\n \"code\": \"USD\"\n },\n \"payment_type\": \"Check\",\n \"paid_date\": \"2020-10-09\",\n \"note\": \"\",\n \"bill\": null\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_payments",
"bill_payments"
]
}
},
"response": [
{
"name": "Add Payment to Bill",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_payment\": {\n \"billid\": {{billId}},\n \"amount\": {\n \"amount\": \"100\",\n \"code\": \"EUR\"\n },\n \"payment_type\": \"Check\",\n \"paid_date\": \"2021-01-30\",\n \"note\": \"\",\n \"bill\": null\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_payments",
"bill_payments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Thu, 28 Jan 2021 19:48:34 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRYCG10HVhZLAlZbXwlJAEgMVgwQRRVNVk8IHQFTUlcOBAFQUgkOBlFRVlsITgpXCBQWBQBVDwcAAlFXAFIGUwcFDREcAgAORFRq"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "X-RateLimit-Limit",
"value": "600"
},
{
"key": "X-RateLimit-Remaining",
"value": "597"
},
{
"key": "X-RateLimit-Reset",
"value": "1611863375"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"bill_payment\": {\n \"amount\": {\n \"amount\": \"100.00\",\n \"code\": \"EUR\"\n },\n \"billid\": 1141,\n \"id\": 909,\n \"matched_with_expense\": false,\n \"note\": \"\",\n \"paid_date\": \"2021-01-30\",\n \"payment_type\": \"Check\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
