PureBasic / New FreshBooks / Add Payment to Bill
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"bill_payment.billid","7")
CkJsonObject::ckUpdateString(json,"bill_payment.amount.amount","375")
CkJsonObject::ckUpdateString(json,"bill_payment.amount.code","USD")
CkJsonObject::ckUpdateString(json,"bill_payment.payment_type","Check")
CkJsonObject::ckUpdateString(json,"bill_payment.paid_date","2020-10-09")
CkJsonObject::ckUpdateString(json,"bill_payment.note","")
CkJsonObject::ckUpdateNull(json,"bill_payment.bill")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill_payment.amount.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.bill_payment.amount.code")
Billid.i = CkJsonObject::ckIntOf(jResp,"response.result.bill_payment.billid")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.bill_payment.id")
Matched_with_expense.i = CkJsonObject::ckBoolOf(jResp,"response.result.bill_payment.matched_with_expense")
Note.s = CkJsonObject::ckStringOf(jResp,"response.result.bill_payment.note")
Paid_date.s = CkJsonObject::ckStringOf(jResp,"response.result.bill_payment.paid_date")
Payment_type.s = CkJsonObject::ckStringOf(jResp,"response.result.bill_payment.payment_type")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.bill_payment.vis_state")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
