SQL Server / New FreshBooks / Delete Invoice
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.vis_state', 1
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @Date_paid int
-- Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.DtObj', @Date_paid OUT
DECLARE @Accountid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accountid OUT, 'response.result.invoice.accountid'
DECLARE @Accounting_systemid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accounting_systemid OUT, 'response.result.invoice.accounting_systemid'
DECLARE @Address nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address OUT, 'response.result.invoice.address'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.invoice.amount.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.invoice.amount.code'
DECLARE @Auto_bill int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_bill OUT, 'response.result.invoice.auto_bill'
DECLARE @Autobill_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Autobill_status OUT, 'response.result.invoice.autobill_status'
DECLARE @Basecampid int
EXEC sp_OAMethod @jResp, 'IntOf', @Basecampid OUT, 'response.result.invoice.basecampid'
DECLARE @City nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @City OUT, 'response.result.invoice.city'
DECLARE @InvoiceCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @InvoiceCode OUT, 'response.result.invoice.code'
DECLARE @Country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Country OUT, 'response.result.invoice.country'
DECLARE @Create_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Create_date OUT, 'response.result.invoice.create_date'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'response.result.invoice.created_at'
DECLARE @Currency_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Currency_code OUT, 'response.result.invoice.currency_code'
DECLARE @Current_organization nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Current_organization OUT, 'response.result.invoice.current_organization'
DECLARE @Customerid int
EXEC sp_OAMethod @jResp, 'IntOf', @Customerid OUT, 'response.result.invoice.customerid'
EXEC sp_OAMethod @jResp, 'DtOf', @success OUT, 'response.result.invoice.date_paid', 0, @Date_paid
DECLARE @Deposit_amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Deposit_amount OUT, 'response.result.invoice.deposit_amount'
DECLARE @Deposit_percentage nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Deposit_percentage OUT, 'response.result.invoice.deposit_percentage'
DECLARE @Deposit_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Deposit_status OUT, 'response.result.invoice.deposit_status'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'response.result.invoice.description'
DECLARE @Discount_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_description OUT, 'response.result.invoice.discount_description'
DECLARE @Discount_totalAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_totalAmount OUT, 'response.result.invoice.discount_total.amount'
DECLARE @Discount_totalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_totalCode OUT, 'response.result.invoice.discount_total.code'
DECLARE @Discount_value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_value OUT, 'response.result.invoice.discount_value'
DECLARE @Display_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Display_status OUT, 'response.result.invoice.display_status'
DECLARE @Dispute_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Dispute_status OUT, 'response.result.invoice.dispute_status'
DECLARE @Due_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Due_date OUT, 'response.result.invoice.due_date'
DECLARE @Due_offset_days int
EXEC sp_OAMethod @jResp, 'IntOf', @Due_offset_days OUT, 'response.result.invoice.due_offset_days'
DECLARE @Estimateid int
EXEC sp_OAMethod @jResp, 'IntOf', @Estimateid OUT, 'response.result.invoice.estimateid'
DECLARE @Ext_archive int
EXEC sp_OAMethod @jResp, 'IntOf', @Ext_archive OUT, 'response.result.invoice.ext_archive'
DECLARE @Fname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fname OUT, 'response.result.invoice.fname'
DECLARE @Fulfillment_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fulfillment_date OUT, 'response.result.invoice.fulfillment_date'
DECLARE @Generation_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Generation_date OUT, 'response.result.invoice.generation_date'
DECLARE @Gmail int
EXEC sp_OAMethod @jResp, 'BoolOf', @Gmail OUT, 'response.result.invoice.gmail'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'response.result.invoice.id'
DECLARE @Invoice_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Invoice_number OUT, 'response.result.invoice.invoice_number'
DECLARE @Invoiceid int
EXEC sp_OAMethod @jResp, 'IntOf', @Invoiceid OUT, 'response.result.invoice.invoiceid'
DECLARE @Language nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Language OUT, 'response.result.invoice.language'
DECLARE @Last_order_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_order_status OUT, 'response.result.invoice.last_order_status'
DECLARE @Lname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Lname OUT, 'response.result.invoice.lname'
DECLARE @Notes nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'response.result.invoice.notes'
DECLARE @Organization nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Organization OUT, 'response.result.invoice.organization'
DECLARE @OutstandingAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OutstandingAmount OUT, 'response.result.invoice.outstanding.amount'
DECLARE @OutstandingCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OutstandingCode OUT, 'response.result.invoice.outstanding.code'
DECLARE @Ownerid int
EXEC sp_OAMethod @jResp, 'IntOf', @Ownerid OUT, 'response.result.invoice.ownerid'
DECLARE @PaidAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PaidAmount OUT, 'response.result.invoice.paid.amount'
DECLARE @PaidCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @PaidCode OUT, 'response.result.invoice.paid.code'
DECLARE @Parent int
EXEC sp_OAMethod @jResp, 'IntOf', @Parent OUT, 'response.result.invoice.parent'
DECLARE @Payment_details nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_details OUT, 'response.result.invoice.payment_details'
DECLARE @Payment_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_status OUT, 'response.result.invoice.payment_status'
DECLARE @Po_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Po_number OUT, 'response.result.invoice.po_number'
DECLARE @Province nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Province OUT, 'response.result.invoice.province'
DECLARE @Return_uri nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Return_uri OUT, 'response.result.invoice.return_uri'
DECLARE @Sentid int
EXEC sp_OAMethod @jResp, 'IntOf', @Sentid OUT, 'response.result.invoice.sentid'
DECLARE @Show_attachments int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_attachments OUT, 'response.result.invoice.show_attachments'
DECLARE @Status int
EXEC sp_OAMethod @jResp, 'IntOf', @Status OUT, 'response.result.invoice.status'
DECLARE @Street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street OUT, 'response.result.invoice.street'
DECLARE @Street2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street2 OUT, 'response.result.invoice.street2'
DECLARE @Template nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Template OUT, 'response.result.invoice.template'
DECLARE @Terms nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Terms OUT, 'response.result.invoice.terms'
DECLARE @Updated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated OUT, 'response.result.invoice.updated'
DECLARE @V3_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @V3_status OUT, 'response.result.invoice.v3_status'
DECLARE @Vat_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_name OUT, 'response.result.invoice.vat_name'
DECLARE @Vat_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_number OUT, 'response.result.invoice.vat_number'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.invoice.vis_state'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
EXEC @hr = sp_OADestroy @Date_paid
END
GO
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}"
}
]
}
