TCL / New FreshBooks / Delete Invoice Profile
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.
# {
# "invoice_profile": {
# "vis_state": 1
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateInt $json "invoice_profile.vis_state" 1
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "invoice_profile": {
# "accounting_systemid": "wkMd2g",
# "address": "",
# "amount": {
# "amount": "0.00",
# "code": "USD"
# },
# "auto_bill": false,
# "bill_gateway": null,
# "city": "",
# "code": "",
# "country": "Canada",
# "create_date": "2019-04-25",
# "currency_code": "USD",
# "customerid": 31006,
# "description": "",
# "disable": false,
# "discount_total": {
# "amount": "0.00",
# "code": "USD"
# },
# "discount_value": "0",
# "due_offset_days": 0,
# "ext_archive": null,
# "fname": "Nicolas",
# "frequency": "m",
# "id": 456,
# "include_unbilled_time": false,
# "language": "en",
# "lname": "one",
# "notes": "",
# "numberRecurring": 3,
# "occurrences_to_date": 0,
# "organization": "first company",
# "ownerid": 1,
# "payment_details": "",
# "po_number": null,
# "profileid": 456,
# "province": "",
# "require_auto_bill": false,
# "retainer_id": null,
# "send_email": true,
# "send_gmail": false,
# "street": "",
# "street2": "",
# "terms": null,
# "total_accrued_revenue": null,
# "updated": "2019-04-24 14:17:40",
# "vat_name": null,
# "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
set Accounting_systemid [CkJsonObject_stringOf $jResp "response.result.invoice_profile.accounting_systemid"]
set Address [CkJsonObject_stringOf $jResp "response.result.invoice_profile.address"]
set Amount [CkJsonObject_stringOf $jResp "response.result.invoice_profile.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.invoice_profile.amount.code"]
set Auto_bill [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.auto_bill"]
set Bill_gateway [CkJsonObject_stringOf $jResp "response.result.invoice_profile.bill_gateway"]
set City [CkJsonObject_stringOf $jResp "response.result.invoice_profile.city"]
set Invoice_profileCode [CkJsonObject_stringOf $jResp "response.result.invoice_profile.code"]
set Country [CkJsonObject_stringOf $jResp "response.result.invoice_profile.country"]
set Create_date [CkJsonObject_stringOf $jResp "response.result.invoice_profile.create_date"]
set Currency_code [CkJsonObject_stringOf $jResp "response.result.invoice_profile.currency_code"]
set Customerid [CkJsonObject_IntOf $jResp "response.result.invoice_profile.customerid"]
set Description [CkJsonObject_stringOf $jResp "response.result.invoice_profile.description"]
set Disable [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.disable"]
set Discount_totalAmount [CkJsonObject_stringOf $jResp "response.result.invoice_profile.discount_total.amount"]
set Discount_totalCode [CkJsonObject_stringOf $jResp "response.result.invoice_profile.discount_total.code"]
set Discount_value [CkJsonObject_stringOf $jResp "response.result.invoice_profile.discount_value"]
set Due_offset_days [CkJsonObject_IntOf $jResp "response.result.invoice_profile.due_offset_days"]
set Ext_archive [CkJsonObject_stringOf $jResp "response.result.invoice_profile.ext_archive"]
set Fname [CkJsonObject_stringOf $jResp "response.result.invoice_profile.fname"]
set Frequency [CkJsonObject_stringOf $jResp "response.result.invoice_profile.frequency"]
set Id [CkJsonObject_IntOf $jResp "response.result.invoice_profile.id"]
set Include_unbilled_time [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.include_unbilled_time"]
set Language [CkJsonObject_stringOf $jResp "response.result.invoice_profile.language"]
set Lname [CkJsonObject_stringOf $jResp "response.result.invoice_profile.lname"]
set Notes [CkJsonObject_stringOf $jResp "response.result.invoice_profile.notes"]
set NumberRecurring [CkJsonObject_IntOf $jResp "response.result.invoice_profile.numberRecurring"]
set Occurrences_to_date [CkJsonObject_IntOf $jResp "response.result.invoice_profile.occurrences_to_date"]
set Organization [CkJsonObject_stringOf $jResp "response.result.invoice_profile.organization"]
set Ownerid [CkJsonObject_IntOf $jResp "response.result.invoice_profile.ownerid"]
set Payment_details [CkJsonObject_stringOf $jResp "response.result.invoice_profile.payment_details"]
set Po_number [CkJsonObject_stringOf $jResp "response.result.invoice_profile.po_number"]
set Profileid [CkJsonObject_IntOf $jResp "response.result.invoice_profile.profileid"]
set Province [CkJsonObject_stringOf $jResp "response.result.invoice_profile.province"]
set Require_auto_bill [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.require_auto_bill"]
set Retainer_id [CkJsonObject_stringOf $jResp "response.result.invoice_profile.retainer_id"]
set Send_email [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.send_email"]
set Send_gmail [CkJsonObject_BoolOf $jResp "response.result.invoice_profile.send_gmail"]
set Street [CkJsonObject_stringOf $jResp "response.result.invoice_profile.street"]
set Street2 [CkJsonObject_stringOf $jResp "response.result.invoice_profile.street2"]
set Terms [CkJsonObject_stringOf $jResp "response.result.invoice_profile.terms"]
set Total_accrued_revenue [CkJsonObject_stringOf $jResp "response.result.invoice_profile.total_accrued_revenue"]
set Updated [CkJsonObject_stringOf $jResp "response.result.invoice_profile.updated"]
set Vat_name [CkJsonObject_stringOf $jResp "response.result.invoice_profile.vat_name"]
set Vat_number [CkJsonObject_stringOf $jResp "response.result.invoice_profile.vat_number"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.invoice_profile.vis_state"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice_profile": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}
Postman Collection Item JSON
{
"name": "Delete Invoice Profile",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"vis_state\": 1\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
}
},
"response": [
{
"name": "Delete Invoice Profile",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\": {\n \"vis_state\": 1\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAAdfVAgOB1FSV1YIUAxQCQEYBgpJG1cEVVIDUg8FAFcACgNTVANAG1dWChdUaw=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:17:40 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:17:40 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"invoice_profile\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"bill_gateway\": null,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-25\",\n \"currency_code\": \"USD\",\n \"customerid\": 31006,\n \"description\": \"\",\n \"disable\": false,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"due_offset_days\": 0,\n \"ext_archive\": null,\n \"fname\": \"Nicolas\",\n \"frequency\": \"m\",\n \"id\": 456,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\n \"numberRecurring\": 3,\n \"occurrences_to_date\": 0,\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 456,\n \"province\": \"\",\n \"require_auto_bill\": false,\n \"retainer_id\": null,\n \"send_email\": true,\n \"send_gmail\": false,\n \"street\": \"\",\n \"street2\": \"\",\n \"terms\": null,\n \"total_accrued_revenue\": null,\n \"updated\": \"2019-04-24 14:17:40\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
