PowerBuilder / New FreshBooks / Single Invoice w/ Logo
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
oleobject loo_Date_paid
oleobject loo_Date_format
string ls_Accountid
string ls_Accounting_systemid
string ls_Address
string ls_Amount
string ls_Code
integer li_Auto_bill
string ls_Autobill_status
integer li_Basecampid
string ls_City
string ls_InvoiceCode
string ls_Country
string ls_Create_date
string ls_Created_at
string ls_Currency_code
string ls_Current_organization
integer li_Customerid
string ls_Deposit_amount
string ls_Deposit_percentage
string ls_Deposit_status
string ls_Description
string ls_Discount_description
string ls_Discount_totalAmount
string ls_Discount_totalCode
string ls_Discount_value
string ls_Display_status
string ls_Dispute_status
string ls_Due_date
integer li_Due_offset_days
integer li_Estimateid
integer li_Ext_archive
string ls_Fname
string ls_Fulfillment_date
string ls_Generation_date
integer li_Gmail
integer li_Id
string ls_Invoice_number
integer li_Invoiceid
string ls_Language
string ls_Last_order_status
string ls_Lname
string ls_Notes
string ls_Organization
string ls_OutstandingAmount
string ls_OutstandingCode
integer li_Ownerid
string ls_PaidAmount
string ls_PaidCode
integer li_Parent
string ls_Payment_details
string ls_Payment_status
string ls_Po_number
string ls_Description_heading
string ls_Hours_heading
integer li_Image_banner_position_y
string ls_Image_banner_src
string ls_Image_logo_src
integer li_PresentationInvoiceid
string ls_Item_heading
string ls_Label
string ls_Quantity_heading
string ls_Rate_heading
string ls_Task_heading
string ls_Theme_font_name
string ls_Theme_layout
string ls_Theme_primary_color
string ls_Time_entry_notes_heading
string ls_Unit_cost_heading
string ls_Province
string ls_Return_uri
integer li_Sentid
integer li_Show_attachments
integer li_Status
string ls_Street
string ls_Street2
string ls_Template
string ls_Terms
string ls_Updated
string ls_V3_status
string ls_Vat_name
string ls_Vat_number
integer li_Vis_state
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("include[]","presentation")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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-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
loo_Date_paid = create oleobject
// Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
li_rc = loo_Date_paid.ConnectToNewObject("Chilkat.DtObj")
loo_Date_format = create oleobject
// Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
li_rc = loo_Date_format.ConnectToNewObject("Chilkat.DtObj")
ls_Accountid = loo_JResp.StringOf("response.result.invoice.accountid")
ls_Accounting_systemid = loo_JResp.StringOf("response.result.invoice.accounting_systemid")
ls_Address = loo_JResp.StringOf("response.result.invoice.address")
ls_Amount = loo_JResp.StringOf("response.result.invoice.amount.amount")
ls_Code = loo_JResp.StringOf("response.result.invoice.amount.code")
li_Auto_bill = loo_JResp.BoolOf("response.result.invoice.auto_bill")
ls_Autobill_status = loo_JResp.StringOf("response.result.invoice.autobill_status")
li_Basecampid = loo_JResp.IntOf("response.result.invoice.basecampid")
ls_City = loo_JResp.StringOf("response.result.invoice.city")
ls_InvoiceCode = loo_JResp.StringOf("response.result.invoice.code")
ls_Country = loo_JResp.StringOf("response.result.invoice.country")
ls_Create_date = loo_JResp.StringOf("response.result.invoice.create_date")
ls_Created_at = loo_JResp.StringOf("response.result.invoice.created_at")
ls_Currency_code = loo_JResp.StringOf("response.result.invoice.currency_code")
ls_Current_organization = loo_JResp.StringOf("response.result.invoice.current_organization")
li_Customerid = loo_JResp.IntOf("response.result.invoice.customerid")
loo_JResp.DtOf("response.result.invoice.date_paid",0,loo_Date_paid)
ls_Deposit_amount = loo_JResp.StringOf("response.result.invoice.deposit_amount")
ls_Deposit_percentage = loo_JResp.StringOf("response.result.invoice.deposit_percentage")
ls_Deposit_status = loo_JResp.StringOf("response.result.invoice.deposit_status")
ls_Description = loo_JResp.StringOf("response.result.invoice.description")
ls_Discount_description = loo_JResp.StringOf("response.result.invoice.discount_description")
ls_Discount_totalAmount = loo_JResp.StringOf("response.result.invoice.discount_total.amount")
ls_Discount_totalCode = loo_JResp.StringOf("response.result.invoice.discount_total.code")
ls_Discount_value = loo_JResp.StringOf("response.result.invoice.discount_value")
ls_Display_status = loo_JResp.StringOf("response.result.invoice.display_status")
ls_Dispute_status = loo_JResp.StringOf("response.result.invoice.dispute_status")
ls_Due_date = loo_JResp.StringOf("response.result.invoice.due_date")
li_Due_offset_days = loo_JResp.IntOf("response.result.invoice.due_offset_days")
li_Estimateid = loo_JResp.IntOf("response.result.invoice.estimateid")
li_Ext_archive = loo_JResp.IntOf("response.result.invoice.ext_archive")
ls_Fname = loo_JResp.StringOf("response.result.invoice.fname")
ls_Fulfillment_date = loo_JResp.StringOf("response.result.invoice.fulfillment_date")
ls_Generation_date = loo_JResp.StringOf("response.result.invoice.generation_date")
li_Gmail = loo_JResp.BoolOf("response.result.invoice.gmail")
li_Id = loo_JResp.IntOf("response.result.invoice.id")
ls_Invoice_number = loo_JResp.StringOf("response.result.invoice.invoice_number")
li_Invoiceid = loo_JResp.IntOf("response.result.invoice.invoiceid")
ls_Language = loo_JResp.StringOf("response.result.invoice.language")
ls_Last_order_status = loo_JResp.StringOf("response.result.invoice.last_order_status")
ls_Lname = loo_JResp.StringOf("response.result.invoice.lname")
ls_Notes = loo_JResp.StringOf("response.result.invoice.notes")
ls_Organization = loo_JResp.StringOf("response.result.invoice.organization")
ls_OutstandingAmount = loo_JResp.StringOf("response.result.invoice.outstanding.amount")
ls_OutstandingCode = loo_JResp.StringOf("response.result.invoice.outstanding.code")
li_Ownerid = loo_JResp.IntOf("response.result.invoice.ownerid")
ls_PaidAmount = loo_JResp.StringOf("response.result.invoice.paid.amount")
ls_PaidCode = loo_JResp.StringOf("response.result.invoice.paid.code")
li_Parent = loo_JResp.IntOf("response.result.invoice.parent")
ls_Payment_details = loo_JResp.StringOf("response.result.invoice.payment_details")
ls_Payment_status = loo_JResp.StringOf("response.result.invoice.payment_status")
ls_Po_number = loo_JResp.StringOf("response.result.invoice.po_number")
loo_JResp.DtOf("response.result.invoice.presentation.date_format",0,loo_Date_format)
ls_Description_heading = loo_JResp.StringOf("response.result.invoice.presentation.description_heading")
ls_Hours_heading = loo_JResp.StringOf("response.result.invoice.presentation.hours_heading")
li_Image_banner_position_y = loo_JResp.IntOf("response.result.invoice.presentation.image_banner_position_y")
ls_Image_banner_src = loo_JResp.StringOf("response.result.invoice.presentation.image_banner_src")
ls_Image_logo_src = loo_JResp.StringOf("response.result.invoice.presentation.image_logo_src")
li_PresentationInvoiceid = loo_JResp.IntOf("response.result.invoice.presentation.invoiceid")
ls_Item_heading = loo_JResp.StringOf("response.result.invoice.presentation.item_heading")
ls_Label = loo_JResp.StringOf("response.result.invoice.presentation.label")
ls_Quantity_heading = loo_JResp.StringOf("response.result.invoice.presentation.quantity_heading")
ls_Rate_heading = loo_JResp.StringOf("response.result.invoice.presentation.rate_heading")
ls_Task_heading = loo_JResp.StringOf("response.result.invoice.presentation.task_heading")
ls_Theme_font_name = loo_JResp.StringOf("response.result.invoice.presentation.theme_font_name")
ls_Theme_layout = loo_JResp.StringOf("response.result.invoice.presentation.theme_layout")
ls_Theme_primary_color = loo_JResp.StringOf("response.result.invoice.presentation.theme_primary_color")
ls_Time_entry_notes_heading = loo_JResp.StringOf("response.result.invoice.presentation.time_entry_notes_heading")
ls_Unit_cost_heading = loo_JResp.StringOf("response.result.invoice.presentation.unit_cost_heading")
ls_Province = loo_JResp.StringOf("response.result.invoice.province")
ls_Return_uri = loo_JResp.StringOf("response.result.invoice.return_uri")
li_Sentid = loo_JResp.IntOf("response.result.invoice.sentid")
li_Show_attachments = loo_JResp.BoolOf("response.result.invoice.show_attachments")
li_Status = loo_JResp.IntOf("response.result.invoice.status")
ls_Street = loo_JResp.StringOf("response.result.invoice.street")
ls_Street2 = loo_JResp.StringOf("response.result.invoice.street2")
ls_Template = loo_JResp.StringOf("response.result.invoice.template")
ls_Terms = loo_JResp.StringOf("response.result.invoice.terms")
ls_Updated = loo_JResp.StringOf("response.result.invoice.updated")
ls_V3_status = loo_JResp.StringOf("response.result.invoice.v3_status")
ls_Vat_name = loo_JResp.StringOf("response.result.invoice.vat_name")
ls_Vat_number = loo_JResp.StringOf("response.result.invoice.vat_number")
li_Vis_state = loo_JResp.IntOf("response.result.invoice.vis_state")
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
destroy loo_Date_paid
destroy loo_Date_format
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}"
}
]
}
