Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateInt("invoice.vis_state",1)
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim Date_paid As New Chilkat.DtObj
Dim Accountid As String
Accountid = jResp.StringOf("response.result.invoice.accountid")
Dim Accounting_systemid As String
Accounting_systemid = jResp.StringOf("response.result.invoice.accounting_systemid")
Dim Address As String
Address = jResp.StringOf("response.result.invoice.address")
Dim Amount As String
Amount = jResp.StringOf("response.result.invoice.amount.amount")
Dim Code As String
Code = jResp.StringOf("response.result.invoice.amount.code")
Dim Auto_bill As Boolean
Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill")
Dim Autobill_status As String
Autobill_status = jResp.StringOf("response.result.invoice.autobill_status")
Dim Basecampid As Int32
Basecampid = jResp.IntOf("response.result.invoice.basecampid")
Dim City As String
City = jResp.StringOf("response.result.invoice.city")
Dim InvoiceCode As String
InvoiceCode = jResp.StringOf("response.result.invoice.code")
Dim Country As String
Country = jResp.StringOf("response.result.invoice.country")
Dim Create_date As String
Create_date = jResp.StringOf("response.result.invoice.create_date")
Dim Created_at As String
Created_at = jResp.StringOf("response.result.invoice.created_at")
Dim Currency_code As String
Currency_code = jResp.StringOf("response.result.invoice.currency_code")
Dim Current_organization As String
Current_organization = jResp.StringOf("response.result.invoice.current_organization")
Dim Customerid As Int32
Customerid = jResp.IntOf("response.result.invoice.customerid")
success = jResp.DtOf("response.result.invoice.date_paid",False,Date_paid)
Dim Deposit_amount As String
Deposit_amount = jResp.StringOf("response.result.invoice.deposit_amount")
Dim Deposit_percentage As String
Deposit_percentage = jResp.StringOf("response.result.invoice.deposit_percentage")
Dim Deposit_status As String
Deposit_status = jResp.StringOf("response.result.invoice.deposit_status")
Dim Description As String
Description = jResp.StringOf("response.result.invoice.description")
Dim Discount_description As String
Discount_description = jResp.StringOf("response.result.invoice.discount_description")
Dim Discount_totalAmount As String
Discount_totalAmount = jResp.StringOf("response.result.invoice.discount_total.amount")
Dim Discount_totalCode As String
Discount_totalCode = jResp.StringOf("response.result.invoice.discount_total.code")
Dim Discount_value As String
Discount_value = jResp.StringOf("response.result.invoice.discount_value")
Dim Display_status As String
Display_status = jResp.StringOf("response.result.invoice.display_status")
Dim Dispute_status As String
Dispute_status = jResp.StringOf("response.result.invoice.dispute_status")
Dim Due_date As String
Due_date = jResp.StringOf("response.result.invoice.due_date")
Dim Due_offset_days As Int32
Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days")
Dim Estimateid As Int32
Estimateid = jResp.IntOf("response.result.invoice.estimateid")
Dim Ext_archive As Int32
Ext_archive = jResp.IntOf("response.result.invoice.ext_archive")
Dim Fname As String
Fname = jResp.StringOf("response.result.invoice.fname")
Dim Fulfillment_date As String
Fulfillment_date = jResp.StringOf("response.result.invoice.fulfillment_date")
Dim Generation_date As String
Generation_date = jResp.StringOf("response.result.invoice.generation_date")
Dim Gmail As Boolean
Gmail = jResp.BoolOf("response.result.invoice.gmail")
Dim Id As Int32
Id = jResp.IntOf("response.result.invoice.id")
Dim Invoice_number As String
Invoice_number = jResp.StringOf("response.result.invoice.invoice_number")
Dim Invoiceid As Int32
Invoiceid = jResp.IntOf("response.result.invoice.invoiceid")
Dim Language As String
Language = jResp.StringOf("response.result.invoice.language")
Dim Last_order_status As String
Last_order_status = jResp.StringOf("response.result.invoice.last_order_status")
Dim Lname As String
Lname = jResp.StringOf("response.result.invoice.lname")
Dim Notes As String
Notes = jResp.StringOf("response.result.invoice.notes")
Dim Organization As String
Organization = jResp.StringOf("response.result.invoice.organization")
Dim OutstandingAmount As String
OutstandingAmount = jResp.StringOf("response.result.invoice.outstanding.amount")
Dim OutstandingCode As String
OutstandingCode = jResp.StringOf("response.result.invoice.outstanding.code")
Dim Ownerid As Int32
Ownerid = jResp.IntOf("response.result.invoice.ownerid")
Dim PaidAmount As String
PaidAmount = jResp.StringOf("response.result.invoice.paid.amount")
Dim PaidCode As String
PaidCode = jResp.StringOf("response.result.invoice.paid.code")
Dim Parent As Int32
Parent = jResp.IntOf("response.result.invoice.parent")
Dim Payment_details As String
Payment_details = jResp.StringOf("response.result.invoice.payment_details")
Dim Payment_status As String
Payment_status = jResp.StringOf("response.result.invoice.payment_status")
Dim Po_number As String
Po_number = jResp.StringOf("response.result.invoice.po_number")
Dim Province As String
Province = jResp.StringOf("response.result.invoice.province")
Dim Return_uri As String
Return_uri = jResp.StringOf("response.result.invoice.return_uri")
Dim Sentid As Int32
Sentid = jResp.IntOf("response.result.invoice.sentid")
Dim Show_attachments As Boolean
Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments")
Dim Status As Int32
Status = jResp.IntOf("response.result.invoice.status")
Dim Street As String
Street = jResp.StringOf("response.result.invoice.street")
Dim Street2 As String
Street2 = jResp.StringOf("response.result.invoice.street2")
Dim Template As String
Template = jResp.StringOf("response.result.invoice.template")
Dim Terms As String
Terms = jResp.StringOf("response.result.invoice.terms")
Dim Updated As String
Updated = jResp.StringOf("response.result.invoice.updated")
Dim V3_status As String
V3_status = jResp.StringOf("response.result.invoice.v3_status")
Dim Vat_name As String
Vat_name = jResp.StringOf("response.result.invoice.vat_name")
Dim Vat_number As String
Vat_number = jResp.StringOf("response.result.invoice.vat_number")
Dim Vis_state As Int32
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}"
}
]
}
