Chilkat Online Tools

Ruby / New FreshBooks / Add Payment to Bill

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("bill_payment.billid","7")
json.UpdateString("bill_payment.amount.amount","375")
json.UpdateString("bill_payment.amount.code","USD")
json.UpdateString("bill_payment.payment_type","Check")
json.UpdateString("bill_payment.paid_date","2020-10-09")
json.UpdateString("bill_payment.note","")
json.UpdateNull("bill_payment.bill")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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 = jResp.stringOf("response.result.bill_payment.amount.amount")
Code = jResp.stringOf("response.result.bill_payment.amount.code")
Billid = jResp.IntOf("response.result.bill_payment.billid")
Id = jResp.IntOf("response.result.bill_payment.id")
Matched_with_expense = jResp.BoolOf("response.result.bill_payment.matched_with_expense")
Note = jResp.stringOf("response.result.bill_payment.note")
Paid_date = jResp.stringOf("response.result.bill_payment.paid_date")
Payment_type = jResp.stringOf("response.result.bill_payment.payment_type")
Vis_state = jResp.IntOf("response.result.bill_payment.vis_state")

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}"
    }
  ]
}