Mono / New FreshBooks / Update Invoice w/ Expense
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
// 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": {
// "lines": [
// {
// "type": 1,
// "description": "Gas",
// "expenseid": 123,
// "taxName1": "",
// "taxAmount1": 0,
// "name": "Updated Expense",
// "qty": 1,
// "taxName2": "",
// "taxAmount2": 0,
// "unit_cost": {
// "amount": "120.00",
// "code": "USD"
// }
// }
// ]
// }
// }
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateInt("invoice.lines[0].type",1);
json.UpdateString("invoice.lines[0].description","Gas");
json.UpdateInt("invoice.lines[0].expenseid",123);
json.UpdateString("invoice.lines[0].taxName1","");
json.UpdateInt("invoice.lines[0].taxAmount1",0);
json.UpdateString("invoice.lines[0].name","Updated Expense");
json.UpdateInt("invoice.lines[0].qty",1);
json.UpdateString("invoice.lines[0].taxName2","");
json.UpdateInt("invoice.lines[0].taxAmount2",0);
json.UpdateString("invoice.lines[0].unit_cost.amount","120.00");
json.UpdateString("invoice.lines[0].unit_cost.code","USD");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
http.SetRequestHeader("Content-Type","application/json");
Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
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) {
Debug.WriteLine(http.LastErrorText);
return;
}
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());
int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
Debug.WriteLine("Response Header:");
Debug.WriteLine(resp.Header);
Debug.WriteLine("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "invoice": {
// "accountid": "wkMd2g",
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "120.00",
// "code": "USD"
// },
// "auto_bill": false,
// "autobill_status": null,
// "basecampid": 0,
// "city": "Toronto",
// "code": "M6P 3T1",
// "country": "Canada",
// "create_date": "2019-04-20",
// "created_at": "2019-06-25 15:16:42",
// "currency_code": "USD",
// "current_organization": "Kevin's Cashmere",
// "customerid": 151486,
// "date_paid": null,
// "deposit_amount": null,
// "deposit_percentage": null,
// "deposit_status": "none",
// "description": "Gas",
// "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": "Kevin",
// "fulfillment_date": null,
// "generation_date": null,
// "gmail": false,
// "id": 152844,
// "invoice_number": "0000048",
// "invoiceid": 152844,
// "language": "en",
// "last_order_status": null,
// "lname": "Cashmere",
// "notes": "",
// "organization": "Kevin's Cashmere",
// "outstanding": {
// "amount": "120.00",
// "code": "USD"
// },
// "ownerid": 31004,
// "paid": {
// "amount": "0.00",
// "code": "USD"
// },
// "parent": 0,
// "payment_details": "",
// "payment_status": "unpaid",
// "po_number": null,
// "province": "Ontario",
// "return_uri": null,
// "sentid": 31004,
// "show_attachments": true,
// "status": 1,
// "street": "1655 Dupont St. W.",
// "street2": "",
// "template": "clean-grouped",
// "terms": "",
// "updated": "2019-06-25 15:20:32",
// "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
Chilkat.DtObj Date_paid = new Chilkat.DtObj();
string Accountid = jResp.StringOf("response.result.invoice.accountid");
string Accounting_systemid = jResp.StringOf("response.result.invoice.accounting_systemid");
string Address = jResp.StringOf("response.result.invoice.address");
string Amount = jResp.StringOf("response.result.invoice.amount.amount");
string Code = jResp.StringOf("response.result.invoice.amount.code");
bool Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill");
string Autobill_status = jResp.StringOf("response.result.invoice.autobill_status");
int Basecampid = jResp.IntOf("response.result.invoice.basecampid");
string City = jResp.StringOf("response.result.invoice.city");
string InvoiceCode = jResp.StringOf("response.result.invoice.code");
string Country = jResp.StringOf("response.result.invoice.country");
string Create_date = jResp.StringOf("response.result.invoice.create_date");
string Created_at = jResp.StringOf("response.result.invoice.created_at");
string Currency_code = jResp.StringOf("response.result.invoice.currency_code");
string Current_organization = jResp.StringOf("response.result.invoice.current_organization");
int Customerid = jResp.IntOf("response.result.invoice.customerid");
jResp.DtOf("response.result.invoice.date_paid",false,Date_paid);
string Deposit_amount = jResp.StringOf("response.result.invoice.deposit_amount");
string Deposit_percentage = jResp.StringOf("response.result.invoice.deposit_percentage");
string Deposit_status = jResp.StringOf("response.result.invoice.deposit_status");
string Description = jResp.StringOf("response.result.invoice.description");
string Discount_description = jResp.StringOf("response.result.invoice.discount_description");
string Discount_totalAmount = jResp.StringOf("response.result.invoice.discount_total.amount");
string Discount_totalCode = jResp.StringOf("response.result.invoice.discount_total.code");
string Discount_value = jResp.StringOf("response.result.invoice.discount_value");
string Display_status = jResp.StringOf("response.result.invoice.display_status");
string Dispute_status = jResp.StringOf("response.result.invoice.dispute_status");
string Due_date = jResp.StringOf("response.result.invoice.due_date");
int Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days");
int Estimateid = jResp.IntOf("response.result.invoice.estimateid");
int Ext_archive = jResp.IntOf("response.result.invoice.ext_archive");
string Fname = jResp.StringOf("response.result.invoice.fname");
string Fulfillment_date = jResp.StringOf("response.result.invoice.fulfillment_date");
string Generation_date = jResp.StringOf("response.result.invoice.generation_date");
bool Gmail = jResp.BoolOf("response.result.invoice.gmail");
int Id = jResp.IntOf("response.result.invoice.id");
string Invoice_number = jResp.StringOf("response.result.invoice.invoice_number");
int Invoiceid = jResp.IntOf("response.result.invoice.invoiceid");
string Language = jResp.StringOf("response.result.invoice.language");
string Last_order_status = jResp.StringOf("response.result.invoice.last_order_status");
string Lname = jResp.StringOf("response.result.invoice.lname");
string Notes = jResp.StringOf("response.result.invoice.notes");
string Organization = jResp.StringOf("response.result.invoice.organization");
string OutstandingAmount = jResp.StringOf("response.result.invoice.outstanding.amount");
string OutstandingCode = jResp.StringOf("response.result.invoice.outstanding.code");
int Ownerid = jResp.IntOf("response.result.invoice.ownerid");
string PaidAmount = jResp.StringOf("response.result.invoice.paid.amount");
string PaidCode = jResp.StringOf("response.result.invoice.paid.code");
int Parent = jResp.IntOf("response.result.invoice.parent");
string Payment_details = jResp.StringOf("response.result.invoice.payment_details");
string Payment_status = jResp.StringOf("response.result.invoice.payment_status");
string Po_number = jResp.StringOf("response.result.invoice.po_number");
string Province = jResp.StringOf("response.result.invoice.province");
string Return_uri = jResp.StringOf("response.result.invoice.return_uri");
int Sentid = jResp.IntOf("response.result.invoice.sentid");
bool Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments");
int Status = jResp.IntOf("response.result.invoice.status");
string Street = jResp.StringOf("response.result.invoice.street");
string Street2 = jResp.StringOf("response.result.invoice.street2");
string Template = jResp.StringOf("response.result.invoice.template");
string Terms = jResp.StringOf("response.result.invoice.terms");
string Updated = jResp.StringOf("response.result.invoice.updated");
string V3_status = jResp.StringOf("response.result.invoice.v3_status");
string Vat_name = jResp.StringOf("response.result.invoice.vat_name");
string Vat_number = jResp.StringOf("response.result.invoice.vat_number");
int 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": {
"lines": [
{
"type": 1,
"description": "Gas",
"expenseid": {{expenseId}},
"taxName1": "",
"taxAmount1": 0,
"name": "Updated Expense",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "120.00",
"code": "USD"
}
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}
Postman Collection Item JSON
{
"name": "Update Invoice w/ Expense",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"lines\": [\n {\n \"type\": 1,\n \"description\": \"Gas\",\n \"expenseid\": {{expenseId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Updated Expense\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n }\n }\n ]\n\t}\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": "- 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 updated:\n\t\titem new inventory = item current inventory + delta of invoice line item old quantity and new quantity"
},
"response": [
{
"name": "Update Invoice w/ Expense",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"lines\": [\n {\n \"type\": 1,\n \"description\": \"Gas\",\n \"expenseid\": {{expenseId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Updated Expense\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n }\n }\n ]\n\t}\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPBlRSDgJUUFUBAwJVV1IBBRtVUwgaEQBWVFdSUA5SDA5XUwIECwUTTVUDCEVSPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "500"
},
{
"key": "X-RateLimit-Remaining",
"value": "497"
},
{
"key": "X-RateLimit-Reset",
"value": "1561490493"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Mon, 25 Jun 2018 19:20:32 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": "Tue, 25 Jun 2019 19:20:32 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17380-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\": \"120.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"Toronto\",\n \"code\": \"M6P 3T1\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-06-25 15:16:42\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"Kevin's Cashmere\",\n \"customerid\": 151486,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"Gas\",\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\": \"Kevin\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 152844,\n \"invoice_number\": \"0000048\",\n \"invoiceid\": 152844,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"Cashmere\",\n \"notes\": \"\",\n \"organization\": \"Kevin's Cashmere\",\n \"outstanding\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 31004,\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\": \"Ontario\",\n \"return_uri\": null,\n \"sentid\": 31004,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"1655 Dupont St. W.\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-06-25 15:20:32\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
},
{
"name": "Update Invoice w/ Expense",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"lines\": [\n {\n \"type\": 1,\n \"description\": \"Gas\",\n \"expenseid\": {{expenseId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Updated Expense\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n }\n }\n ]\n\t}\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPBlRSDgJUUFUBAwJVV1IBBRtVUwgaEQBWVFdSUA5SDA5XUwIECwUTTVUDCEVSPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "500"
},
{
"key": "X-RateLimit-Remaining",
"value": "497"
},
{
"key": "X-RateLimit-Reset",
"value": "1561490493"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Mon, 25 Jun 2018 19:20:32 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": "Tue, 25 Jun 2019 19:20:32 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17380-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\": \"120.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"Toronto\",\n \"code\": \"M6P 3T1\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-06-25 15:16:42\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"Kevin's Cashmere\",\n \"customerid\": 151486,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"Gas\",\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\": \"Kevin\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 152844,\n \"invoice_number\": \"0000048\",\n \"invoiceid\": 152844,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"Cashmere\",\n \"notes\": \"\",\n \"organization\": \"Kevin's Cashmere\",\n \"outstanding\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 31004,\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\": \"Ontario\",\n \"return_uri\": null,\n \"sentid\": 31004,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"1655 Dupont St. W.\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-06-25 15:20:32\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
