Chilkat Online Tools

Swift / New FreshBooks / Edit Payment to Bill

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("bill_payment.billid", value: "7")
    json.UpdateString("bill_payment.amount.amount", value: "300")
    json.UpdateString("bill_payment.amount.code", value: "USD")
    json.UpdateString("bill_payment.payment_type", value: "Check")
    json.UpdateString("bill_payment.paid_date", value: "2020-10-09")
    json.UpdateString("bill_payment.note", value: "")
    json.UpdateString("bill_payment.bill", value: "7")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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