Chilkat Online Tools

TCL / New FreshBooks / Create Prepayment Credit

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "credit_note": {
#     "credit_number": "0000070",
#     "currency_code": "CAD",
#     "create_date": "2020-07-31",
#     "notes": "Thank you for paying ahead of time",
#     "credit_type": "prepayment",
#     "terms": "Will be applied to future invoice",
#     "lines": [
#       {
#         "name": "Credit",
#         "description": "PrePayment for work",
#         "taxName1": null,
#         "taxAmount1": null,
#         "taxName2": null,
#         "taxAmount2": null,
#         "compounded_tax": false,
#         "qty": 1,
#         "unit_cost": {
#           "amount": "200",
#           "code": "CAD"
#         },
#         "credit_note": null
#       }
#     ],
#     "clientid": 123
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "credit_note.credit_number" "0000070"
CkJsonObject_UpdateString $json "credit_note.currency_code" "CAD"
CkJsonObject_UpdateString $json "credit_note.create_date" "2020-07-31"
CkJsonObject_UpdateString $json "credit_note.notes" "Thank you for paying ahead of time"
CkJsonObject_UpdateString $json "credit_note.credit_type" "prepayment"
CkJsonObject_UpdateString $json "credit_note.terms" "Will be applied to future invoice"
CkJsonObject_UpdateString $json "credit_note.lines[0].name" "Credit"
CkJsonObject_UpdateString $json "credit_note.lines[0].description" "PrePayment for work"
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxName1"
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxAmount1"
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxName2"
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxAmount2"
CkJsonObject_UpdateBool $json "credit_note.lines[0].compounded_tax" 0
CkJsonObject_UpdateInt $json "credit_note.lines[0].qty" 1
CkJsonObject_UpdateString $json "credit_note.lines[0].unit_cost.amount" "200"
CkJsonObject_UpdateString $json "credit_note.lines[0].unit_cost.code" "CAD"
CkJsonObject_UpdateNull $json "credit_note.lines[0].credit_note"
CkJsonObject_UpdateInt $json "credit_note.clientid" 123

CkHttp_SetRequestHeader $http "Authorization" "Bearer"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Authorization: Bearer "
	-d '{
    "credit_note": {
        "credit_number": "0000070",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "Thank you for paying ahead of time",
        "credit_type": "prepayment",
        "terms": "Will be applied to future invoice",
        "lines": [
            {
                "name": "Credit",
                "description": "PrePayment for work",
                "taxName1": null,
                "taxAmount1": null,
                "taxName2": null,
                "taxAmount2": null,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "200",
                    "code": "CAD"
                },
                "credit_note": null
            }
        ],
        "clientid": {{clientId}}
    }
}'
https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes

Postman Collection Item JSON

{
  "name": "Create Prepayment Credit",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer ",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000070\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"Thank you for paying ahead of time\",\n        \"credit_type\": \"prepayment\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"lines\": [\n            {\n                \"name\": \"Credit\",\n                \"description\": \"PrePayment for work\",\n                \"taxName1\": null,\n                \"taxAmount1\": null,\n                \"taxName2\": null,\n                \"taxAmount2\": null,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"200\",\n                    \"code\": \"CAD\"\n                },\n                \"credit_note\": null\n            }\n        ],\n        \"clientid\": {{clientId}}\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "E86Qp",
        "credit_notes",
        "credit_notes"
      ]
    }
  },
  "response": [
  ]
}