Chilkat Online Tools

Ruby / New FreshBooks / Edit 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": "300",
#       "code": "USD"
#     },
#     "payment_type": "Check",
#     "paid_date": "2020-10-09",
#     "note": "",
#     "bill": "7"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("bill_payment.billid","7")
json.UpdateString("bill_payment.amount.amount","300")
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.UpdateString("bill_payment.bill","7")

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

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

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "bill_payment": {
        "billid": "7",
        "amount": {
            "amount": "300",
            "code": "USD"
        },
        "payment_type": "Check",
        "paid_date": "2020-10-09",
        "note": "",
        "bill": "7"
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}

Postman Collection Item JSON

{
  "name": "Edit Payment to Bill",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"bill_payment\": {\n        \"billid\": \"7\",\n        \"amount\": {\n            \"amount\": \"300\",\n            \"code\": \"USD\"\n        },\n        \"payment_type\": \"Check\",\n        \"paid_date\": \"2020-10-09\",\n        \"note\": \"\",\n        \"bill\": \"7\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "bill_payments",
        "bill_payments",
        "{{billPaymentId}}"
      ]
    }
  },
  "response": [
  ]
}