Foxpro / New FreshBooks / Single Invoice w/ Logo
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL loDate_paid
LOCAL loDate_format
LOCAL lcAccountid
LOCAL lcAccounting_systemid
LOCAL lcAddress
LOCAL lcAmount
LOCAL lcCode
LOCAL lnAuto_bill
LOCAL lcAutobill_status
LOCAL lnBasecampid
LOCAL lcCity
LOCAL lcInvoiceCode
LOCAL lcCountry
LOCAL lcCreate_date
LOCAL lcCreated_at
LOCAL lcCurrency_code
LOCAL lcCurrent_organization
LOCAL lnCustomerid
LOCAL lcDeposit_amount
LOCAL lcDeposit_percentage
LOCAL lcDeposit_status
LOCAL lcDescription
LOCAL lcDiscount_description
LOCAL lcDiscount_totalAmount
LOCAL lcDiscount_totalCode
LOCAL lcDiscount_value
LOCAL lcDisplay_status
LOCAL lcDispute_status
LOCAL lcDue_date
LOCAL lnDue_offset_days
LOCAL lnEstimateid
LOCAL lnExt_archive
LOCAL lcFname
LOCAL lcFulfillment_date
LOCAL lcGeneration_date
LOCAL lnGmail
LOCAL lnId
LOCAL lcInvoice_number
LOCAL lnInvoiceid
LOCAL lcLanguage
LOCAL lcLast_order_status
LOCAL lcLname
LOCAL lcNotes
LOCAL lcOrganization
LOCAL lcOutstandingAmount
LOCAL lcOutstandingCode
LOCAL lnOwnerid
LOCAL lcPaidAmount
LOCAL lcPaidCode
LOCAL lnParent
LOCAL lcPayment_details
LOCAL lcPayment_status
LOCAL lcPo_number
LOCAL lcDescription_heading
LOCAL lcHours_heading
LOCAL lnImage_banner_position_y
LOCAL lcImage_banner_src
LOCAL lcImage_logo_src
LOCAL lnPresentationInvoiceid
LOCAL lcItem_heading
LOCAL lcLabel
LOCAL lcQuantity_heading
LOCAL lcRate_heading
LOCAL lcTask_heading
LOCAL lcTheme_font_name
LOCAL lcTheme_layout
LOCAL lcTheme_primary_color
LOCAL lcTime_entry_notes_heading
LOCAL lcUnit_cost_heading
LOCAL lcProvince
LOCAL lcReturn_uri
LOCAL lnSentid
LOCAL lnShow_attachments
LOCAL lnStatus
LOCAL lcStreet
LOCAL lcStreet2
LOCAL lcTemplate
LOCAL lcTerms
LOCAL lcUpdated
LOCAL lcV3_status
LOCAL lcVat_name
LOCAL lcVat_number
LOCAL lnVis_state
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("include[]","presentation")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_paid = CreateObject('Chilkat.DtObj')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_format = CreateObject('Chilkat.DtObj')
lcAccountid = loJResp.StringOf("response.result.invoice.accountid")
lcAccounting_systemid = loJResp.StringOf("response.result.invoice.accounting_systemid")
lcAddress = loJResp.StringOf("response.result.invoice.address")
lcAmount = loJResp.StringOf("response.result.invoice.amount.amount")
lcCode = loJResp.StringOf("response.result.invoice.amount.code")
lnAuto_bill = loJResp.BoolOf("response.result.invoice.auto_bill")
lcAutobill_status = loJResp.StringOf("response.result.invoice.autobill_status")
lnBasecampid = loJResp.IntOf("response.result.invoice.basecampid")
lcCity = loJResp.StringOf("response.result.invoice.city")
lcInvoiceCode = loJResp.StringOf("response.result.invoice.code")
lcCountry = loJResp.StringOf("response.result.invoice.country")
lcCreate_date = loJResp.StringOf("response.result.invoice.create_date")
lcCreated_at = loJResp.StringOf("response.result.invoice.created_at")
lcCurrency_code = loJResp.StringOf("response.result.invoice.currency_code")
lcCurrent_organization = loJResp.StringOf("response.result.invoice.current_organization")
lnCustomerid = loJResp.IntOf("response.result.invoice.customerid")
loJResp.DtOf("response.result.invoice.date_paid",0,loDate_paid)
lcDeposit_amount = loJResp.StringOf("response.result.invoice.deposit_amount")
lcDeposit_percentage = loJResp.StringOf("response.result.invoice.deposit_percentage")
lcDeposit_status = loJResp.StringOf("response.result.invoice.deposit_status")
lcDescription = loJResp.StringOf("response.result.invoice.description")
lcDiscount_description = loJResp.StringOf("response.result.invoice.discount_description")
lcDiscount_totalAmount = loJResp.StringOf("response.result.invoice.discount_total.amount")
lcDiscount_totalCode = loJResp.StringOf("response.result.invoice.discount_total.code")
lcDiscount_value = loJResp.StringOf("response.result.invoice.discount_value")
lcDisplay_status = loJResp.StringOf("response.result.invoice.display_status")
lcDispute_status = loJResp.StringOf("response.result.invoice.dispute_status")
lcDue_date = loJResp.StringOf("response.result.invoice.due_date")
lnDue_offset_days = loJResp.IntOf("response.result.invoice.due_offset_days")
lnEstimateid = loJResp.IntOf("response.result.invoice.estimateid")
lnExt_archive = loJResp.IntOf("response.result.invoice.ext_archive")
lcFname = loJResp.StringOf("response.result.invoice.fname")
lcFulfillment_date = loJResp.StringOf("response.result.invoice.fulfillment_date")
lcGeneration_date = loJResp.StringOf("response.result.invoice.generation_date")
lnGmail = loJResp.BoolOf("response.result.invoice.gmail")
lnId = loJResp.IntOf("response.result.invoice.id")
lcInvoice_number = loJResp.StringOf("response.result.invoice.invoice_number")
lnInvoiceid = loJResp.IntOf("response.result.invoice.invoiceid")
lcLanguage = loJResp.StringOf("response.result.invoice.language")
lcLast_order_status = loJResp.StringOf("response.result.invoice.last_order_status")
lcLname = loJResp.StringOf("response.result.invoice.lname")
lcNotes = loJResp.StringOf("response.result.invoice.notes")
lcOrganization = loJResp.StringOf("response.result.invoice.organization")
lcOutstandingAmount = loJResp.StringOf("response.result.invoice.outstanding.amount")
lcOutstandingCode = loJResp.StringOf("response.result.invoice.outstanding.code")
lnOwnerid = loJResp.IntOf("response.result.invoice.ownerid")
lcPaidAmount = loJResp.StringOf("response.result.invoice.paid.amount")
lcPaidCode = loJResp.StringOf("response.result.invoice.paid.code")
lnParent = loJResp.IntOf("response.result.invoice.parent")
lcPayment_details = loJResp.StringOf("response.result.invoice.payment_details")
lcPayment_status = loJResp.StringOf("response.result.invoice.payment_status")
lcPo_number = loJResp.StringOf("response.result.invoice.po_number")
loJResp.DtOf("response.result.invoice.presentation.date_format",0,loDate_format)
lcDescription_heading = loJResp.StringOf("response.result.invoice.presentation.description_heading")
lcHours_heading = loJResp.StringOf("response.result.invoice.presentation.hours_heading")
lnImage_banner_position_y = loJResp.IntOf("response.result.invoice.presentation.image_banner_position_y")
lcImage_banner_src = loJResp.StringOf("response.result.invoice.presentation.image_banner_src")
lcImage_logo_src = loJResp.StringOf("response.result.invoice.presentation.image_logo_src")
lnPresentationInvoiceid = loJResp.IntOf("response.result.invoice.presentation.invoiceid")
lcItem_heading = loJResp.StringOf("response.result.invoice.presentation.item_heading")
lcLabel = loJResp.StringOf("response.result.invoice.presentation.label")
lcQuantity_heading = loJResp.StringOf("response.result.invoice.presentation.quantity_heading")
lcRate_heading = loJResp.StringOf("response.result.invoice.presentation.rate_heading")
lcTask_heading = loJResp.StringOf("response.result.invoice.presentation.task_heading")
lcTheme_font_name = loJResp.StringOf("response.result.invoice.presentation.theme_font_name")
lcTheme_layout = loJResp.StringOf("response.result.invoice.presentation.theme_layout")
lcTheme_primary_color = loJResp.StringOf("response.result.invoice.presentation.theme_primary_color")
lcTime_entry_notes_heading = loJResp.StringOf("response.result.invoice.presentation.time_entry_notes_heading")
lcUnit_cost_heading = loJResp.StringOf("response.result.invoice.presentation.unit_cost_heading")
lcProvince = loJResp.StringOf("response.result.invoice.province")
lcReturn_uri = loJResp.StringOf("response.result.invoice.return_uri")
lnSentid = loJResp.IntOf("response.result.invoice.sentid")
lnShow_attachments = loJResp.BoolOf("response.result.invoice.show_attachments")
lnStatus = loJResp.IntOf("response.result.invoice.status")
lcStreet = loJResp.StringOf("response.result.invoice.street")
lcStreet2 = loJResp.StringOf("response.result.invoice.street2")
lcTemplate = loJResp.StringOf("response.result.invoice.template")
lcTerms = loJResp.StringOf("response.result.invoice.terms")
lcUpdated = loJResp.StringOf("response.result.invoice.updated")
lcV3_status = loJResp.StringOf("response.result.invoice.v3_status")
lcVat_name = loJResp.StringOf("response.result.invoice.vat_name")
lcVat_number = loJResp.StringOf("response.result.invoice.vat_number")
lnVis_state = loJResp.IntOf("response.result.invoice.vis_state")
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
RELEASE loDate_paid
RELEASE loDate_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}"
}
]
}
