Swift3 / New FreshBooks / Single Invoice w/ Logo
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("include[]", value: "presentation")
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
http.setRequestHeader("Content-Type", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
let Date_paid = CkoDtObj()!
let Date_format = CkoDtObj()!
var Accountid: String? = jResp.string(of: "response.result.invoice.accountid")
var Accounting_systemid: String? = jResp.string(of: "response.result.invoice.accounting_systemid")
var Address: String? = jResp.string(of: "response.result.invoice.address")
var Amount: String? = jResp.string(of: "response.result.invoice.amount.amount")
var Code: String? = jResp.string(of: "response.result.invoice.amount.code")
var Auto_bill: Bool = jResp.bool(of: "response.result.invoice.auto_bill")
var Autobill_status: String? = jResp.string(of: "response.result.invoice.autobill_status")
var Basecampid: Int = jResp.int(of: "response.result.invoice.basecampid").intValue
var City: String? = jResp.string(of: "response.result.invoice.city")
var InvoiceCode: String? = jResp.string(of: "response.result.invoice.code")
var Country: String? = jResp.string(of: "response.result.invoice.country")
var Create_date: String? = jResp.string(of: "response.result.invoice.create_date")
var Created_at: String? = jResp.string(of: "response.result.invoice.created_at")
var Currency_code: String? = jResp.string(of: "response.result.invoice.currency_code")
var Current_organization: String? = jResp.string(of: "response.result.invoice.current_organization")
var Customerid: Int = jResp.int(of: "response.result.invoice.customerid").intValue
jResp.dt(of: "response.result.invoice.date_paid", bLocal: false, dt: Date_paid)
var Deposit_amount: String? = jResp.string(of: "response.result.invoice.deposit_amount")
var Deposit_percentage: String? = jResp.string(of: "response.result.invoice.deposit_percentage")
var Deposit_status: String? = jResp.string(of: "response.result.invoice.deposit_status")
var Description: String? = jResp.string(of: "response.result.invoice.description")
var Discount_description: String? = jResp.string(of: "response.result.invoice.discount_description")
var Discount_totalAmount: String? = jResp.string(of: "response.result.invoice.discount_total.amount")
var Discount_totalCode: String? = jResp.string(of: "response.result.invoice.discount_total.code")
var Discount_value: String? = jResp.string(of: "response.result.invoice.discount_value")
var Display_status: String? = jResp.string(of: "response.result.invoice.display_status")
var Dispute_status: String? = jResp.string(of: "response.result.invoice.dispute_status")
var Due_date: String? = jResp.string(of: "response.result.invoice.due_date")
var Due_offset_days: Int = jResp.int(of: "response.result.invoice.due_offset_days").intValue
var Estimateid: Int = jResp.int(of: "response.result.invoice.estimateid").intValue
var Ext_archive: Int = jResp.int(of: "response.result.invoice.ext_archive").intValue
var Fname: String? = jResp.string(of: "response.result.invoice.fname")
var Fulfillment_date: String? = jResp.string(of: "response.result.invoice.fulfillment_date")
var Generation_date: String? = jResp.string(of: "response.result.invoice.generation_date")
var Gmail: Bool = jResp.bool(of: "response.result.invoice.gmail")
var Id: Int = jResp.int(of: "response.result.invoice.id").intValue
var Invoice_number: String? = jResp.string(of: "response.result.invoice.invoice_number")
var Invoiceid: Int = jResp.int(of: "response.result.invoice.invoiceid").intValue
var Language: String? = jResp.string(of: "response.result.invoice.language")
var Last_order_status: String? = jResp.string(of: "response.result.invoice.last_order_status")
var Lname: String? = jResp.string(of: "response.result.invoice.lname")
var Notes: String? = jResp.string(of: "response.result.invoice.notes")
var Organization: String? = jResp.string(of: "response.result.invoice.organization")
var OutstandingAmount: String? = jResp.string(of: "response.result.invoice.outstanding.amount")
var OutstandingCode: String? = jResp.string(of: "response.result.invoice.outstanding.code")
var Ownerid: Int = jResp.int(of: "response.result.invoice.ownerid").intValue
var PaidAmount: String? = jResp.string(of: "response.result.invoice.paid.amount")
var PaidCode: String? = jResp.string(of: "response.result.invoice.paid.code")
var Parent: Int = jResp.int(of: "response.result.invoice.parent").intValue
var Payment_details: String? = jResp.string(of: "response.result.invoice.payment_details")
var Payment_status: String? = jResp.string(of: "response.result.invoice.payment_status")
var Po_number: String? = jResp.string(of: "response.result.invoice.po_number")
jResp.dt(of: "response.result.invoice.presentation.date_format", bLocal: false, dt: Date_format)
var Description_heading: String? = jResp.string(of: "response.result.invoice.presentation.description_heading")
var Hours_heading: String? = jResp.string(of: "response.result.invoice.presentation.hours_heading")
var Image_banner_position_y: Int = jResp.int(of: "response.result.invoice.presentation.image_banner_position_y").intValue
var Image_banner_src: String? = jResp.string(of: "response.result.invoice.presentation.image_banner_src")
var Image_logo_src: String? = jResp.string(of: "response.result.invoice.presentation.image_logo_src")
var PresentationInvoiceid: Int = jResp.int(of: "response.result.invoice.presentation.invoiceid").intValue
var Item_heading: String? = jResp.string(of: "response.result.invoice.presentation.item_heading")
var Label: String? = jResp.string(of: "response.result.invoice.presentation.label")
var Quantity_heading: String? = jResp.string(of: "response.result.invoice.presentation.quantity_heading")
var Rate_heading: String? = jResp.string(of: "response.result.invoice.presentation.rate_heading")
var Task_heading: String? = jResp.string(of: "response.result.invoice.presentation.task_heading")
var Theme_font_name: String? = jResp.string(of: "response.result.invoice.presentation.theme_font_name")
var Theme_layout: String? = jResp.string(of: "response.result.invoice.presentation.theme_layout")
var Theme_primary_color: String? = jResp.string(of: "response.result.invoice.presentation.theme_primary_color")
var Time_entry_notes_heading: String? = jResp.string(of: "response.result.invoice.presentation.time_entry_notes_heading")
var Unit_cost_heading: String? = jResp.string(of: "response.result.invoice.presentation.unit_cost_heading")
var Province: String? = jResp.string(of: "response.result.invoice.province")
var Return_uri: String? = jResp.string(of: "response.result.invoice.return_uri")
var Sentid: Int = jResp.int(of: "response.result.invoice.sentid").intValue
var Show_attachments: Bool = jResp.bool(of: "response.result.invoice.show_attachments")
var Status: Int = jResp.int(of: "response.result.invoice.status").intValue
var Street: String? = jResp.string(of: "response.result.invoice.street")
var Street2: String? = jResp.string(of: "response.result.invoice.street2")
var Template: String? = jResp.string(of: "response.result.invoice.template")
var Terms: String? = jResp.string(of: "response.result.invoice.terms")
var Updated: String? = jResp.string(of: "response.result.invoice.updated")
var V3_status: String? = jResp.string(of: "response.result.invoice.v3_status")
var Vat_name: String? = jResp.string(of: "response.result.invoice.vat_name")
var Vat_number: String? = jResp.string(of: "response.result.invoice.vat_number")
var Vis_state: Int = jResp.int(of: "response.result.invoice.vis_state").intValue
}
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}"
}
]
}
