Ruby / New FreshBooks / Single Invoice w/ Logo
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("include[]","presentation")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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-22 10:50:19",
# "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": "viewed",
# "dispute_status": null,
# "due_date": "2019-04-20",
# "due_offset_days": 0,
# "estimateid": 0,
# "ext_archive": 0,
# "fname": "Client",
# "fulfillment_date": "2019-04-20",
# "generation_date": null,
# "gmail": false,
# "id": 29618,
# "invoice_number": "0000012",
# "invoiceid": 29618,
# "language": "en",
# "last_order_status": null,
# "lname": "one",
# "notes": "",
# "organization": "first company",
# "outstanding": {
# "amount": "180.00",
# "code": "USD"
# },
# "ownerid": 31004,
# "paid": {
# "amount": "0.00",
# "code": "USD"
# },
# "parent": 0,
# "payment_details": "",
# "payment_status": "unpaid",
# "po_number": null,
# "presentation": {
# "date_format": "mm/dd/yyyy",
# "description_heading": null,
# "hours_heading": null,
# "image_banner_position_y": 0,
# "image_banner_src": null,
# "image_logo_src": "/service/api/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6ImNyYXBwcy5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtOWM4NGZjMjIxZmY2OGYxZDhmYzM3ZDhhMGU2NzdmY2M3YmQ3MWM3MyIsImxlbmd0aCI6MjIzNTA2LCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTljODRmYzIyMWZmNjhmMWQ4ZmMzN2Q4YTBlNjc3ZmNjN2JkNzFjNzMifQ.JKJhOAD4xudhv8uPpyVw6yFhvJC5ypYzYGRWvq0UTDA",
# "invoiceid": 29618,
# "item_heading": null,
# "label": null,
# "quantity_heading": null,
# "rate_heading": null,
# "task_heading": null,
# "theme_font_name": null,
# "theme_layout": null,
# "theme_primary_color": "#000000",
# "time_entry_notes_heading": null,
# "unit_cost_heading": null
# },
# "province": "",
# "return_uri": null,
# "sentid": 31004,
# "show_attachments": true,
# "status": 3,
# "street": "",
# "street2": "",
# "template": "clean-grouped",
# "terms": "",
# "updated": "2019-04-23 17:59:12",
# "v3_status": "overdue",
# "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 = Chilkat::CkDtObj.new()
Date_format = Chilkat::CkDtObj.new()
Accountid = jResp.stringOf("response.result.invoice.accountid")
Accounting_systemid = jResp.stringOf("response.result.invoice.accounting_systemid")
Address = jResp.stringOf("response.result.invoice.address")
Amount = jResp.stringOf("response.result.invoice.amount.amount")
Code = jResp.stringOf("response.result.invoice.amount.code")
Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill")
Autobill_status = jResp.stringOf("response.result.invoice.autobill_status")
Basecampid = jResp.IntOf("response.result.invoice.basecampid")
City = jResp.stringOf("response.result.invoice.city")
InvoiceCode = jResp.stringOf("response.result.invoice.code")
Country = jResp.stringOf("response.result.invoice.country")
Create_date = jResp.stringOf("response.result.invoice.create_date")
Created_at = jResp.stringOf("response.result.invoice.created_at")
Currency_code = jResp.stringOf("response.result.invoice.currency_code")
Current_organization = jResp.stringOf("response.result.invoice.current_organization")
Customerid = jResp.IntOf("response.result.invoice.customerid")
jResp.DtOf("response.result.invoice.date_paid",false,Date_paid)
Deposit_amount = jResp.stringOf("response.result.invoice.deposit_amount")
Deposit_percentage = jResp.stringOf("response.result.invoice.deposit_percentage")
Deposit_status = jResp.stringOf("response.result.invoice.deposit_status")
Description = jResp.stringOf("response.result.invoice.description")
Discount_description = jResp.stringOf("response.result.invoice.discount_description")
Discount_totalAmount = jResp.stringOf("response.result.invoice.discount_total.amount")
Discount_totalCode = jResp.stringOf("response.result.invoice.discount_total.code")
Discount_value = jResp.stringOf("response.result.invoice.discount_value")
Display_status = jResp.stringOf("response.result.invoice.display_status")
Dispute_status = jResp.stringOf("response.result.invoice.dispute_status")
Due_date = jResp.stringOf("response.result.invoice.due_date")
Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days")
Estimateid = jResp.IntOf("response.result.invoice.estimateid")
Ext_archive = jResp.IntOf("response.result.invoice.ext_archive")
Fname = jResp.stringOf("response.result.invoice.fname")
Fulfillment_date = jResp.stringOf("response.result.invoice.fulfillment_date")
Generation_date = jResp.stringOf("response.result.invoice.generation_date")
Gmail = jResp.BoolOf("response.result.invoice.gmail")
Id = jResp.IntOf("response.result.invoice.id")
Invoice_number = jResp.stringOf("response.result.invoice.invoice_number")
Invoiceid = jResp.IntOf("response.result.invoice.invoiceid")
Language = jResp.stringOf("response.result.invoice.language")
Last_order_status = jResp.stringOf("response.result.invoice.last_order_status")
Lname = jResp.stringOf("response.result.invoice.lname")
Notes = jResp.stringOf("response.result.invoice.notes")
Organization = jResp.stringOf("response.result.invoice.organization")
OutstandingAmount = jResp.stringOf("response.result.invoice.outstanding.amount")
OutstandingCode = jResp.stringOf("response.result.invoice.outstanding.code")
Ownerid = jResp.IntOf("response.result.invoice.ownerid")
PaidAmount = jResp.stringOf("response.result.invoice.paid.amount")
PaidCode = jResp.stringOf("response.result.invoice.paid.code")
Parent = jResp.IntOf("response.result.invoice.parent")
Payment_details = jResp.stringOf("response.result.invoice.payment_details")
Payment_status = jResp.stringOf("response.result.invoice.payment_status")
Po_number = jResp.stringOf("response.result.invoice.po_number")
jResp.DtOf("response.result.invoice.presentation.date_format",false,Date_format)
Description_heading = jResp.stringOf("response.result.invoice.presentation.description_heading")
Hours_heading = jResp.stringOf("response.result.invoice.presentation.hours_heading")
Image_banner_position_y = jResp.IntOf("response.result.invoice.presentation.image_banner_position_y")
Image_banner_src = jResp.stringOf("response.result.invoice.presentation.image_banner_src")
Image_logo_src = jResp.stringOf("response.result.invoice.presentation.image_logo_src")
PresentationInvoiceid = jResp.IntOf("response.result.invoice.presentation.invoiceid")
Item_heading = jResp.stringOf("response.result.invoice.presentation.item_heading")
Label = jResp.stringOf("response.result.invoice.presentation.label")
Quantity_heading = jResp.stringOf("response.result.invoice.presentation.quantity_heading")
Rate_heading = jResp.stringOf("response.result.invoice.presentation.rate_heading")
Task_heading = jResp.stringOf("response.result.invoice.presentation.task_heading")
Theme_font_name = jResp.stringOf("response.result.invoice.presentation.theme_font_name")
Theme_layout = jResp.stringOf("response.result.invoice.presentation.theme_layout")
Theme_primary_color = jResp.stringOf("response.result.invoice.presentation.theme_primary_color")
Time_entry_notes_heading = jResp.stringOf("response.result.invoice.presentation.time_entry_notes_heading")
Unit_cost_heading = jResp.stringOf("response.result.invoice.presentation.unit_cost_heading")
Province = jResp.stringOf("response.result.invoice.province")
Return_uri = jResp.stringOf("response.result.invoice.return_uri")
Sentid = jResp.IntOf("response.result.invoice.sentid")
Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments")
Status = jResp.IntOf("response.result.invoice.status")
Street = jResp.stringOf("response.result.invoice.street")
Street2 = jResp.stringOf("response.result.invoice.street2")
Template = jResp.stringOf("response.result.invoice.template")
Terms = jResp.stringOf("response.result.invoice.terms")
Updated = jResp.stringOf("response.result.invoice.updated")
V3_status = jResp.stringOf("response.result.invoice.v3_status")
Vat_name = jResp.stringOf("response.result.invoice.vat_name")
Vat_number = jResp.stringOf("response.result.invoice.vat_number")
Vis_state = jResp.IntOf("response.result.invoice.vis_state")
Curl Command
curl -G -d "include[]=presentation"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}
Postman Collection Item JSON
{
"name": "Single Invoice w/ Logo",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"imgSrc\", \"\\\"\" + jsonData.response.result.invoice.presentation.image_logo_src + \"\\\"\")",
"pm.environment.set(\"themeColor\", \"\\\"\" + jsonData.response.result.invoice.presentation.theme_primary_color + \"\\\"\")",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}?include[]=presentation",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
],
"query": [
{
"key": "include[]",
"value": "presentation"
}
]
}
},
"response": [
{
"name": "Single Invoice w/ Logo",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}?include%5B%5D=presentation",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
],
"query": [
{
"key": "include%5B%5D",
"value": "presentation"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPAlJdAQ9YV1ALAwdVWVsOBQZKSQAaEVJQUwQGVQ5RDghQC1EGX1kTTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:05:31 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": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:05:31 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-22 10:50:19\",\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\": \"viewed\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Client\",\n \"fulfillment_date\": \"2019-04-20\",\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 29618,\n \"invoice_number\": \"0000012\",\n \"invoiceid\": 29618,\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\": 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 \"presentation\": {\n \"date_format\": \"mm/dd/yyyy\",\n \"description_heading\": null,\n \"hours_heading\": null,\n \"image_banner_position_y\": 0,\n \"image_banner_src\": null,\n \"image_logo_src\": \"/service/api/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6ImNyYXBwcy5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtOWM4NGZjMjIxZmY2OGYxZDhmYzM3ZDhhMGU2NzdmY2M3YmQ3MWM3MyIsImxlbmd0aCI6MjIzNTA2LCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTljODRmYzIyMWZmNjhmMWQ4ZmMzN2Q4YTBlNjc3ZmNjN2JkNzFjNzMifQ.JKJhOAD4xudhv8uPpyVw6yFhvJC5ypYzYGRWvq0UTDA\",\n \"invoiceid\": 29618,\n \"item_heading\": null,\n \"label\": null,\n \"quantity_heading\": null,\n \"rate_heading\": null,\n \"task_heading\": null,\n \"theme_font_name\": null,\n \"theme_layout\": null,\n \"theme_primary_color\": \"#000000\",\n \"time_entry_notes_heading\": null,\n \"unit_cost_heading\": null\n },\n \"province\": \"\",\n \"return_uri\": null,\n \"sentid\": 31004,\n \"show_attachments\": true,\n \"status\": 3,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-04-23 17:59:12\",\n \"v3_status\": \"overdue\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
