Chilkat Online Tools

Ruby / New FreshBooks / Delete Credit

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.

# {
#   "credit_note": {
#     "vis_state": 1
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("credit_note.vis_state",1)

# 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}}/credit_notes/credit_notes/{{creditId}}",sbRequestBody,"utf-8","application/json",false,false)
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": {
#       "credit_note": {
#         "accounting_systemid": "E86Qp",
#         "amount": {
#           "amount": "150.00",
#           "code": "CAD"
#         },
#         "city": "",
#         "clientid": 599843,
#         "code": "",
#         "country": "",
#         "create_date": "2020-07-31",
#         "credit_number": "0000069",
#         "credit_type": "goodwill",
#         "creditid": 30947,
#         "currency_code": "CAD",
#         "current_organization": "Squarespace",
#         "description": "Goodwill Credit",
#         "display_status": "created",
#         "dispute_status": null,
#         "ext_archive": 0,
#         "fname": "",
#         "id": 30947,
#         "language": "en",
#         "last_order_status": null,
#         "lname": "",
#         "notes": "Free $150 voucher",
#         "organization": "Squarespace",
#         "paid": {
#           "amount": "150.00",
#           "code": "CAD"
#         },
#         "payment_status": "paid",
#         "province": "",
#         "sentid": 1,
#         "status": "created",
#         "street": "",
#         "street2": "",
#         "template": "clean-grouped",
#         "terms": "Will be applied to future invoice",
#         "vat_name": "",
#         "vat_number": "",
#         "vis_state": 1
#       }
#     }
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Accounting_systemid = jResp.stringOf("response.result.credit_note.accounting_systemid")
Amount = jResp.stringOf("response.result.credit_note.amount.amount")
Code = jResp.stringOf("response.result.credit_note.amount.code")
City = jResp.stringOf("response.result.credit_note.city")
Clientid = jResp.IntOf("response.result.credit_note.clientid")
Credit_noteCode = jResp.stringOf("response.result.credit_note.code")
Country = jResp.stringOf("response.result.credit_note.country")
Create_date = jResp.stringOf("response.result.credit_note.create_date")
Credit_number = jResp.stringOf("response.result.credit_note.credit_number")
Credit_type = jResp.stringOf("response.result.credit_note.credit_type")
Creditid = jResp.IntOf("response.result.credit_note.creditid")
Currency_code = jResp.stringOf("response.result.credit_note.currency_code")
Current_organization = jResp.stringOf("response.result.credit_note.current_organization")
Description = jResp.stringOf("response.result.credit_note.description")
Display_status = jResp.stringOf("response.result.credit_note.display_status")
Dispute_status = jResp.stringOf("response.result.credit_note.dispute_status")
Ext_archive = jResp.IntOf("response.result.credit_note.ext_archive")
Fname = jResp.stringOf("response.result.credit_note.fname")
Id = jResp.IntOf("response.result.credit_note.id")
Language = jResp.stringOf("response.result.credit_note.language")
Last_order_status = jResp.stringOf("response.result.credit_note.last_order_status")
Lname = jResp.stringOf("response.result.credit_note.lname")
Notes = jResp.stringOf("response.result.credit_note.notes")
Organization = jResp.stringOf("response.result.credit_note.organization")
PaidAmount = jResp.stringOf("response.result.credit_note.paid.amount")
PaidCode = jResp.stringOf("response.result.credit_note.paid.code")
Payment_status = jResp.stringOf("response.result.credit_note.payment_status")
Province = jResp.stringOf("response.result.credit_note.province")
Sentid = jResp.IntOf("response.result.credit_note.sentid")
Status = jResp.stringOf("response.result.credit_note.status")
Street = jResp.stringOf("response.result.credit_note.street")
Street2 = jResp.stringOf("response.result.credit_note.street2")
Template = jResp.stringOf("response.result.credit_note.template")
Terms = jResp.stringOf("response.result.credit_note.terms")
Vat_name = jResp.stringOf("response.result.credit_note.vat_name")
Vat_number = jResp.stringOf("response.result.credit_note.vat_number")
Vis_state = jResp.IntOf("response.result.credit_note.vis_state")

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
  "credit_note": {
    "vis_state": 1
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}

Postman Collection Item JSON

{
  "name": "Delete Credit",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"credit_note\": {\n    \"vis_state\": 1\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "credit_notes",
        "credit_notes",
        "{{creditId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Credit",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"credit_note\": {\n    \"vis_state\": 1\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "credit_notes",
            "credit_notes",
            "{{creditId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Date",
          "value": "Fri, 11 Sep 2020 14:41:22 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gHQ1NXCxI8DF8WXRECW0ZXVwxND14VVkBIBhtRSFALCwZUV1ECBgJRUAUAAVtKV1ccQAAGDlsEBVYECwAGAAsBUwYVTQACVEBVOQ=="
        },
        {
          "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": "595"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1599835343"
        },
        {
          "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            \"credit_note\": {\n                \"accounting_systemid\": \"E86Qp\",\n                \"amount\": {\n                    \"amount\": \"150.00\",\n                    \"code\": \"CAD\"\n                },\n                \"city\": \"\",\n                \"clientid\": 599843,\n                \"code\": \"\",\n                \"country\": \"\",\n                \"create_date\": \"2020-07-31\",\n                \"credit_number\": \"0000069\",\n                \"credit_type\": \"goodwill\",\n                \"creditid\": 30947,\n                \"currency_code\": \"CAD\",\n                \"current_organization\": \"Squarespace\",\n                \"description\": \"Goodwill Credit\",\n                \"display_status\": \"created\",\n                \"dispute_status\": null,\n                \"ext_archive\": 0,\n                \"fname\": \"\",\n                \"id\": 30947,\n                \"language\": \"en\",\n                \"last_order_status\": null,\n                \"lname\": \"\",\n                \"notes\": \"Free $150 voucher\",\n                \"organization\": \"Squarespace\",\n                \"paid\": {\n                    \"amount\": \"150.00\",\n                    \"code\": \"CAD\"\n                },\n                \"payment_status\": \"paid\",\n                \"province\": \"\",\n                \"sentid\": 1,\n                \"status\": \"created\",\n                \"street\": \"\",\n                \"street2\": \"\",\n                \"template\": \"clean-grouped\",\n                \"terms\": \"Will be applied to future invoice\",\n                \"vat_name\": \"\",\n                \"vat_number\": \"\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}