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.
# {
# "invoice": {
# "vis_state": 1
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateInt("invoice.vis_state",1)
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",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": {
# "invoice": {
# "accountid": "wkMd2g",
# "accounting_systemid": "wkMd2g",
# "address": "",
# "amount": {
# "amount": "180.00",
# "code": "USD"
# },
# "auto_bill": false,
# "autobill_status": null,
# "basecampid": 0,
# "city": "",
# "code": "",
# "country": "Canada",
# "create_date": "2019-04-20",
# "created_at": "2019-04-24 14:06:53",
# "currency_code": "USD",
# "current_organization": "first company",
# "customerid": 31006,
# "date_paid": null,
# "deposit_amount": null,
# "deposit_percentage": null,
# "deposit_status": "none",
# "description": "",
# "discount_description": null,
# "discount_total": {
# "amount": "0.00",
# "code": "USD"
# },
# "discount_value": "0",
# "display_status": "draft",
# "dispute_status": null,
# "due_date": "2019-04-20",
# "due_offset_days": 0,
# "estimateid": 0,
# "ext_archive": 0,
# "fname": "Nicolas",
# "fulfillment_date": null,
# "generation_date": null,
# "gmail": false,
# "id": 34420,
# "invoice_number": "0000013",
# "invoiceid": 34420,
# "language": "en",
# "last_order_status": null,
# "lname": "one",
# "notes": "",
# "organization": "first company",
# "outstanding": {
# "amount": "180.00",
# "code": "USD"
# },
# "ownerid": 1,
# "paid": {
# "amount": "0.00",
# "code": "USD"
# },
# "parent": 0,
# "payment_details": "",
# "payment_status": "unpaid",
# "po_number": null,
# "province": "",
# "return_uri": null,
# "sentid": 1,
# "show_attachments": true,
# "status": 1,
# "street": "",
# "street2": "",
# "template": "clean-grouped",
# "terms": "",
# "updated": "2019-04-24 14:06:53",
# "v3_status": "draft",
# "vat_name": "",
# "vat_number": "",
# "vis_state": 0
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Date_paid = Chilkat::CkDtObj.new()
Accountid = jResp.stringOf("response.result.invoice.accountid")
Accounting_systemid = jResp.stringOf("response.result.invoice.accounting_systemid")
Address = jResp.stringOf("response.result.invoice.address")
Amount = jResp.stringOf("response.result.invoice.amount.amount")
Code = jResp.stringOf("response.result.invoice.amount.code")
Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill")
Autobill_status = jResp.stringOf("response.result.invoice.autobill_status")
Basecampid = jResp.IntOf("response.result.invoice.basecampid")
City = jResp.stringOf("response.result.invoice.city")
InvoiceCode = jResp.stringOf("response.result.invoice.code")
Country = jResp.stringOf("response.result.invoice.country")
Create_date = jResp.stringOf("response.result.invoice.create_date")
Created_at = jResp.stringOf("response.result.invoice.created_at")
Currency_code = jResp.stringOf("response.result.invoice.currency_code")
Current_organization = jResp.stringOf("response.result.invoice.current_organization")
Customerid = jResp.IntOf("response.result.invoice.customerid")
jResp.DtOf("response.result.invoice.date_paid",false,Date_paid)
Deposit_amount = jResp.stringOf("response.result.invoice.deposit_amount")
Deposit_percentage = jResp.stringOf("response.result.invoice.deposit_percentage")
Deposit_status = jResp.stringOf("response.result.invoice.deposit_status")
Description = jResp.stringOf("response.result.invoice.description")
Discount_description = jResp.stringOf("response.result.invoice.discount_description")
Discount_totalAmount = jResp.stringOf("response.result.invoice.discount_total.amount")
Discount_totalCode = jResp.stringOf("response.result.invoice.discount_total.code")
Discount_value = jResp.stringOf("response.result.invoice.discount_value")
Display_status = jResp.stringOf("response.result.invoice.display_status")
Dispute_status = jResp.stringOf("response.result.invoice.dispute_status")
Due_date = jResp.stringOf("response.result.invoice.due_date")
Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days")
Estimateid = jResp.IntOf("response.result.invoice.estimateid")
Ext_archive = jResp.IntOf("response.result.invoice.ext_archive")
Fname = jResp.stringOf("response.result.invoice.fname")
Fulfillment_date = jResp.stringOf("response.result.invoice.fulfillment_date")
Generation_date = jResp.stringOf("response.result.invoice.generation_date")
Gmail = jResp.BoolOf("response.result.invoice.gmail")
Id = jResp.IntOf("response.result.invoice.id")
Invoice_number = jResp.stringOf("response.result.invoice.invoice_number")
Invoiceid = jResp.IntOf("response.result.invoice.invoiceid")
Language = jResp.stringOf("response.result.invoice.language")
Last_order_status = jResp.stringOf("response.result.invoice.last_order_status")
Lname = jResp.stringOf("response.result.invoice.lname")
Notes = jResp.stringOf("response.result.invoice.notes")
Organization = jResp.stringOf("response.result.invoice.organization")
OutstandingAmount = jResp.stringOf("response.result.invoice.outstanding.amount")
OutstandingCode = jResp.stringOf("response.result.invoice.outstanding.code")
Ownerid = jResp.IntOf("response.result.invoice.ownerid")
PaidAmount = jResp.stringOf("response.result.invoice.paid.amount")
PaidCode = jResp.stringOf("response.result.invoice.paid.code")
Parent = jResp.IntOf("response.result.invoice.parent")
Payment_details = jResp.stringOf("response.result.invoice.payment_details")
Payment_status = jResp.stringOf("response.result.invoice.payment_status")
Po_number = jResp.stringOf("response.result.invoice.po_number")
Province = jResp.stringOf("response.result.invoice.province")
Return_uri = jResp.stringOf("response.result.invoice.return_uri")
Sentid = jResp.IntOf("response.result.invoice.sentid")
Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments")
Status = jResp.IntOf("response.result.invoice.status")
Street = jResp.stringOf("response.result.invoice.street")
Street2 = jResp.stringOf("response.result.invoice.street2")
Template = jResp.stringOf("response.result.invoice.template")
Terms = jResp.stringOf("response.result.invoice.terms")
Updated = jResp.stringOf("response.result.invoice.updated")
V3_status = jResp.stringOf("response.result.invoice.v3_status")
Vat_name = jResp.stringOf("response.result.invoice.vat_name")
Vat_number = jResp.stringOf("response.result.invoice.vat_number")
Vis_state = jResp.IntOf("response.result.invoice.vis_state")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}
Postman Collection Item JSON
{
"name": "Delete Invoice",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice\": {\n \"vis_state\": 1\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
},
"description": "Note: \n- In order to delete an invoice, you will first need to delete all payments associated with that invoice or turn them to credits. \n- If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is deleted: \n \titem new inventory = item current inventory + item quantity from deleted invoice\n- Similarly, if the deleted invoice gets undeleted, the corresponding inventory wil be updated:\n\t\titem new inventory = item current inventory - item quantity from undeleted invoice"
},
"response": [
{
"name": "Delete Invoice",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice\": {\n \"vis_state\": \n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPAVBdAQBSU1EJBwJXUlEOCQNKUAAaEVAEVlIJAAgAWghWAQNRWAITTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:07:28 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:07:28 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\": {\n \"accountid\": \"wkMd2g\",\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-04-24 14:06:53\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"\",\n \"discount_description\": null,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Nicolas\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 34420,\n \"invoice_number\": \"0000013\",\n \"invoiceid\": 34420,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"one\",\n \"notes\": \"\",\n \"organization\": \"first company\",\n \"outstanding\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 1,\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"parent\": 0,\n \"payment_details\": \"\",\n \"payment_status\": \"unpaid\",\n \"po_number\": null,\n \"province\": \"\",\n \"return_uri\": null,\n \"sentid\": 1,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-04-24 14:06:53\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
