delphiDll / New FreshBooks / Delete Invoice
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Date_paid: HCkDtObj;
Accountid: PWideChar;
Accounting_systemid: PWideChar;
Address: PWideChar;
Amount: PWideChar;
Code: PWideChar;
Auto_bill: Boolean;
Autobill_status: PWideChar;
Basecampid: Integer;
City: PWideChar;
InvoiceCode: PWideChar;
Country: PWideChar;
Create_date: PWideChar;
Created_at: PWideChar;
Currency_code: PWideChar;
Current_organization: PWideChar;
Customerid: Integer;
Deposit_amount: PWideChar;
Deposit_percentage: PWideChar;
Deposit_status: PWideChar;
Description: PWideChar;
Discount_description: PWideChar;
Discount_totalAmount: PWideChar;
Discount_totalCode: PWideChar;
Discount_value: PWideChar;
Display_status: PWideChar;
Dispute_status: PWideChar;
Due_date: PWideChar;
Due_offset_days: Integer;
Estimateid: Integer;
Ext_archive: Integer;
Fname: PWideChar;
Fulfillment_date: PWideChar;
Generation_date: PWideChar;
Gmail: Boolean;
Id: Integer;
Invoice_number: PWideChar;
Invoiceid: Integer;
Language: PWideChar;
Last_order_status: PWideChar;
Lname: PWideChar;
Notes: PWideChar;
Organization: PWideChar;
OutstandingAmount: PWideChar;
OutstandingCode: PWideChar;
Ownerid: Integer;
PaidAmount: PWideChar;
PaidCode: PWideChar;
Parent: Integer;
Payment_details: PWideChar;
Payment_status: PWideChar;
Po_number: PWideChar;
Province: PWideChar;
Return_uri: PWideChar;
Sentid: Integer;
Show_attachments: Boolean;
Status: Integer;
Street: PWideChar;
Street2: PWideChar;
Template: PWideChar;
Terms: PWideChar;
Updated: PWideChar;
V3_status: PWideChar;
Vat_name: PWideChar;
Vat_number: PWideChar;
Vis_state: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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 := CkJsonObject_Create();
CkJsonObject_UpdateInt(json,'invoice.vis_state',1);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
Date_paid := CkDtObj_Create();
Accountid := CkJsonObject__stringOf(jResp,'response.result.invoice.accountid');
Accounting_systemid := CkJsonObject__stringOf(jResp,'response.result.invoice.accounting_systemid');
Address := CkJsonObject__stringOf(jResp,'response.result.invoice.address');
Amount := CkJsonObject__stringOf(jResp,'response.result.invoice.amount.amount');
Code := CkJsonObject__stringOf(jResp,'response.result.invoice.amount.code');
Auto_bill := CkJsonObject_BoolOf(jResp,'response.result.invoice.auto_bill');
Autobill_status := CkJsonObject__stringOf(jResp,'response.result.invoice.autobill_status');
Basecampid := CkJsonObject_IntOf(jResp,'response.result.invoice.basecampid');
City := CkJsonObject__stringOf(jResp,'response.result.invoice.city');
InvoiceCode := CkJsonObject__stringOf(jResp,'response.result.invoice.code');
Country := CkJsonObject__stringOf(jResp,'response.result.invoice.country');
Create_date := CkJsonObject__stringOf(jResp,'response.result.invoice.create_date');
Created_at := CkJsonObject__stringOf(jResp,'response.result.invoice.created_at');
Currency_code := CkJsonObject__stringOf(jResp,'response.result.invoice.currency_code');
Current_organization := CkJsonObject__stringOf(jResp,'response.result.invoice.current_organization');
Customerid := CkJsonObject_IntOf(jResp,'response.result.invoice.customerid');
CkJsonObject_DtOf(jResp,'response.result.invoice.date_paid',False,Date_paid);
Deposit_amount := CkJsonObject__stringOf(jResp,'response.result.invoice.deposit_amount');
Deposit_percentage := CkJsonObject__stringOf(jResp,'response.result.invoice.deposit_percentage');
Deposit_status := CkJsonObject__stringOf(jResp,'response.result.invoice.deposit_status');
Description := CkJsonObject__stringOf(jResp,'response.result.invoice.description');
Discount_description := CkJsonObject__stringOf(jResp,'response.result.invoice.discount_description');
Discount_totalAmount := CkJsonObject__stringOf(jResp,'response.result.invoice.discount_total.amount');
Discount_totalCode := CkJsonObject__stringOf(jResp,'response.result.invoice.discount_total.code');
Discount_value := CkJsonObject__stringOf(jResp,'response.result.invoice.discount_value');
Display_status := CkJsonObject__stringOf(jResp,'response.result.invoice.display_status');
Dispute_status := CkJsonObject__stringOf(jResp,'response.result.invoice.dispute_status');
Due_date := CkJsonObject__stringOf(jResp,'response.result.invoice.due_date');
Due_offset_days := CkJsonObject_IntOf(jResp,'response.result.invoice.due_offset_days');
Estimateid := CkJsonObject_IntOf(jResp,'response.result.invoice.estimateid');
Ext_archive := CkJsonObject_IntOf(jResp,'response.result.invoice.ext_archive');
Fname := CkJsonObject__stringOf(jResp,'response.result.invoice.fname');
Fulfillment_date := CkJsonObject__stringOf(jResp,'response.result.invoice.fulfillment_date');
Generation_date := CkJsonObject__stringOf(jResp,'response.result.invoice.generation_date');
Gmail := CkJsonObject_BoolOf(jResp,'response.result.invoice.gmail');
Id := CkJsonObject_IntOf(jResp,'response.result.invoice.id');
Invoice_number := CkJsonObject__stringOf(jResp,'response.result.invoice.invoice_number');
Invoiceid := CkJsonObject_IntOf(jResp,'response.result.invoice.invoiceid');
Language := CkJsonObject__stringOf(jResp,'response.result.invoice.language');
Last_order_status := CkJsonObject__stringOf(jResp,'response.result.invoice.last_order_status');
Lname := CkJsonObject__stringOf(jResp,'response.result.invoice.lname');
Notes := CkJsonObject__stringOf(jResp,'response.result.invoice.notes');
Organization := CkJsonObject__stringOf(jResp,'response.result.invoice.organization');
OutstandingAmount := CkJsonObject__stringOf(jResp,'response.result.invoice.outstanding.amount');
OutstandingCode := CkJsonObject__stringOf(jResp,'response.result.invoice.outstanding.code');
Ownerid := CkJsonObject_IntOf(jResp,'response.result.invoice.ownerid');
PaidAmount := CkJsonObject__stringOf(jResp,'response.result.invoice.paid.amount');
PaidCode := CkJsonObject__stringOf(jResp,'response.result.invoice.paid.code');
Parent := CkJsonObject_IntOf(jResp,'response.result.invoice.parent');
Payment_details := CkJsonObject__stringOf(jResp,'response.result.invoice.payment_details');
Payment_status := CkJsonObject__stringOf(jResp,'response.result.invoice.payment_status');
Po_number := CkJsonObject__stringOf(jResp,'response.result.invoice.po_number');
Province := CkJsonObject__stringOf(jResp,'response.result.invoice.province');
Return_uri := CkJsonObject__stringOf(jResp,'response.result.invoice.return_uri');
Sentid := CkJsonObject_IntOf(jResp,'response.result.invoice.sentid');
Show_attachments := CkJsonObject_BoolOf(jResp,'response.result.invoice.show_attachments');
Status := CkJsonObject_IntOf(jResp,'response.result.invoice.status');
Street := CkJsonObject__stringOf(jResp,'response.result.invoice.street');
Street2 := CkJsonObject__stringOf(jResp,'response.result.invoice.street2');
Template := CkJsonObject__stringOf(jResp,'response.result.invoice.template');
Terms := CkJsonObject__stringOf(jResp,'response.result.invoice.terms');
Updated := CkJsonObject__stringOf(jResp,'response.result.invoice.updated');
V3_status := CkJsonObject__stringOf(jResp,'response.result.invoice.v3_status');
Vat_name := CkJsonObject__stringOf(jResp,'response.result.invoice.vat_name');
Vat_number := CkJsonObject__stringOf(jResp,'response.result.invoice.vat_number');
Vis_state := CkJsonObject_IntOf(jResp,'response.result.invoice.vis_state');
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(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}"
}
]
}
