PowerBuilder / New FreshBooks / Delete Invoice
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
oleobject loo_Date_paid
string ls_Accountid
string ls_Accounting_systemid
string ls_Address
string ls_Amount
string ls_Code
integer li_Auto_bill
string ls_Autobill_status
integer li_Basecampid
string ls_City
string ls_InvoiceCode
string ls_Country
string ls_Create_date
string ls_Created_at
string ls_Currency_code
string ls_Current_organization
integer li_Customerid
string ls_Deposit_amount
string ls_Deposit_percentage
string ls_Deposit_status
string ls_Description
string ls_Discount_description
string ls_Discount_totalAmount
string ls_Discount_totalCode
string ls_Discount_value
string ls_Display_status
string ls_Dispute_status
string ls_Due_date
integer li_Due_offset_days
integer li_Estimateid
integer li_Ext_archive
string ls_Fname
string ls_Fulfillment_date
string ls_Generation_date
integer li_Gmail
integer li_Id
string ls_Invoice_number
integer li_Invoiceid
string ls_Language
string ls_Last_order_status
string ls_Lname
string ls_Notes
string ls_Organization
string ls_OutstandingAmount
string ls_OutstandingCode
integer li_Ownerid
string ls_PaidAmount
string ls_PaidCode
integer li_Parent
string ls_Payment_details
string ls_Payment_status
string ls_Po_number
string ls_Province
string ls_Return_uri
integer li_Sentid
integer li_Show_attachments
integer li_Status
string ls_Street
string ls_Street2
string ls_Template
string ls_Terms
string ls_Updated
string ls_V3_status
string ls_Vat_name
string ls_Vat_number
integer li_Vis_state
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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
// }
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateInt("invoice.vis_state",1)
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
loo_Date_paid = create oleobject
// Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
li_rc = loo_Date_paid.ConnectToNewObject("Chilkat.DtObj")
ls_Accountid = loo_JResp.StringOf("response.result.invoice.accountid")
ls_Accounting_systemid = loo_JResp.StringOf("response.result.invoice.accounting_systemid")
ls_Address = loo_JResp.StringOf("response.result.invoice.address")
ls_Amount = loo_JResp.StringOf("response.result.invoice.amount.amount")
ls_Code = loo_JResp.StringOf("response.result.invoice.amount.code")
li_Auto_bill = loo_JResp.BoolOf("response.result.invoice.auto_bill")
ls_Autobill_status = loo_JResp.StringOf("response.result.invoice.autobill_status")
li_Basecampid = loo_JResp.IntOf("response.result.invoice.basecampid")
ls_City = loo_JResp.StringOf("response.result.invoice.city")
ls_InvoiceCode = loo_JResp.StringOf("response.result.invoice.code")
ls_Country = loo_JResp.StringOf("response.result.invoice.country")
ls_Create_date = loo_JResp.StringOf("response.result.invoice.create_date")
ls_Created_at = loo_JResp.StringOf("response.result.invoice.created_at")
ls_Currency_code = loo_JResp.StringOf("response.result.invoice.currency_code")
ls_Current_organization = loo_JResp.StringOf("response.result.invoice.current_organization")
li_Customerid = loo_JResp.IntOf("response.result.invoice.customerid")
loo_JResp.DtOf("response.result.invoice.date_paid",0,loo_Date_paid)
ls_Deposit_amount = loo_JResp.StringOf("response.result.invoice.deposit_amount")
ls_Deposit_percentage = loo_JResp.StringOf("response.result.invoice.deposit_percentage")
ls_Deposit_status = loo_JResp.StringOf("response.result.invoice.deposit_status")
ls_Description = loo_JResp.StringOf("response.result.invoice.description")
ls_Discount_description = loo_JResp.StringOf("response.result.invoice.discount_description")
ls_Discount_totalAmount = loo_JResp.StringOf("response.result.invoice.discount_total.amount")
ls_Discount_totalCode = loo_JResp.StringOf("response.result.invoice.discount_total.code")
ls_Discount_value = loo_JResp.StringOf("response.result.invoice.discount_value")
ls_Display_status = loo_JResp.StringOf("response.result.invoice.display_status")
ls_Dispute_status = loo_JResp.StringOf("response.result.invoice.dispute_status")
ls_Due_date = loo_JResp.StringOf("response.result.invoice.due_date")
li_Due_offset_days = loo_JResp.IntOf("response.result.invoice.due_offset_days")
li_Estimateid = loo_JResp.IntOf("response.result.invoice.estimateid")
li_Ext_archive = loo_JResp.IntOf("response.result.invoice.ext_archive")
ls_Fname = loo_JResp.StringOf("response.result.invoice.fname")
ls_Fulfillment_date = loo_JResp.StringOf("response.result.invoice.fulfillment_date")
ls_Generation_date = loo_JResp.StringOf("response.result.invoice.generation_date")
li_Gmail = loo_JResp.BoolOf("response.result.invoice.gmail")
li_Id = loo_JResp.IntOf("response.result.invoice.id")
ls_Invoice_number = loo_JResp.StringOf("response.result.invoice.invoice_number")
li_Invoiceid = loo_JResp.IntOf("response.result.invoice.invoiceid")
ls_Language = loo_JResp.StringOf("response.result.invoice.language")
ls_Last_order_status = loo_JResp.StringOf("response.result.invoice.last_order_status")
ls_Lname = loo_JResp.StringOf("response.result.invoice.lname")
ls_Notes = loo_JResp.StringOf("response.result.invoice.notes")
ls_Organization = loo_JResp.StringOf("response.result.invoice.organization")
ls_OutstandingAmount = loo_JResp.StringOf("response.result.invoice.outstanding.amount")
ls_OutstandingCode = loo_JResp.StringOf("response.result.invoice.outstanding.code")
li_Ownerid = loo_JResp.IntOf("response.result.invoice.ownerid")
ls_PaidAmount = loo_JResp.StringOf("response.result.invoice.paid.amount")
ls_PaidCode = loo_JResp.StringOf("response.result.invoice.paid.code")
li_Parent = loo_JResp.IntOf("response.result.invoice.parent")
ls_Payment_details = loo_JResp.StringOf("response.result.invoice.payment_details")
ls_Payment_status = loo_JResp.StringOf("response.result.invoice.payment_status")
ls_Po_number = loo_JResp.StringOf("response.result.invoice.po_number")
ls_Province = loo_JResp.StringOf("response.result.invoice.province")
ls_Return_uri = loo_JResp.StringOf("response.result.invoice.return_uri")
li_Sentid = loo_JResp.IntOf("response.result.invoice.sentid")
li_Show_attachments = loo_JResp.BoolOf("response.result.invoice.show_attachments")
li_Status = loo_JResp.IntOf("response.result.invoice.status")
ls_Street = loo_JResp.StringOf("response.result.invoice.street")
ls_Street2 = loo_JResp.StringOf("response.result.invoice.street2")
ls_Template = loo_JResp.StringOf("response.result.invoice.template")
ls_Terms = loo_JResp.StringOf("response.result.invoice.terms")
ls_Updated = loo_JResp.StringOf("response.result.invoice.updated")
ls_V3_status = loo_JResp.StringOf("response.result.invoice.v3_status")
ls_Vat_name = loo_JResp.StringOf("response.result.invoice.vat_name")
ls_Vat_number = loo_JResp.StringOf("response.result.invoice.vat_number")
li_Vis_state = loo_JResp.IntOf("response.result.invoice.vis_state")
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
destroy loo_Date_paid
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}"
}
]
}
