Chilkat Online Tools

VB.NET / New FreshBooks / Get default invoice presentation styles

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/presentations",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "response": {
'     "result": {
'       "presentation": {
'         "date_format": "mm/dd/yyyy",
'         "description_heading": null,
'         "hours_heading": null,
'         "image_banner_position_y": 0,
'         "image_banner_src": null,
'         "image_logo_src": "/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6InBpenphZG90bmV0LmpwZyIsImxlbmd0aCI6MTA2MDM3LCJmaWxlbmFtZSI6InVwbG9hZC0xM2UwMmRiYzI2ZWEyMmQzYTJmZmY3ZmZmYWUwZjZjMzE5MzUxMWQ4IiwiYnVja2V0IjoidXBsb2FkcyIsImtleSI6Iidkb2NzLSctNDIzNjQxMC91cGxvYWQtMTNlMDJkYmMyNmVhMjJkM2EyZmZmN2ZmZmFlMGY2YzMxOTM1MTFkOCJ9.d7YhBtzuxdiglt5d6eUVZc_dORsnOAJuDx1XvYj2utg",
'         "invoiceid": 99748,
'         "item_heading": null,
'         "label": null,
'         "quantity_heading": null,
'         "rate_heading": null,
'         "task_heading": null,
'         "theme_font_name": "modern",
'         "theme_layout": "simple",
'         "theme_primary_color": "#663399",
'         "time_entry_notes_heading": null,
'         "unit_cost_heading": null
'       }
'     }
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code



Dim Date_format As New Chilkat.DtObj

jResp.DtOf("response.result.presentation.date_format",False,Date_format)
Dim Description_heading As String = jResp.StringOf("response.result.presentation.description_heading")
Dim Hours_heading As String = jResp.StringOf("response.result.presentation.hours_heading")
Dim Image_banner_position_y As Integer = jResp.IntOf("response.result.presentation.image_banner_position_y")
Dim Image_banner_src As String = jResp.StringOf("response.result.presentation.image_banner_src")
Dim Image_logo_src As String = jResp.StringOf("response.result.presentation.image_logo_src")
Dim Invoiceid As Integer = jResp.IntOf("response.result.presentation.invoiceid")
Dim Item_heading As String = jResp.StringOf("response.result.presentation.item_heading")
Dim Label As String = jResp.StringOf("response.result.presentation.label")
Dim Quantity_heading As String = jResp.StringOf("response.result.presentation.quantity_heading")
Dim Rate_heading As String = jResp.StringOf("response.result.presentation.rate_heading")
Dim Task_heading As String = jResp.StringOf("response.result.presentation.task_heading")
Dim Theme_font_name As String = jResp.StringOf("response.result.presentation.theme_font_name")
Dim Theme_layout As String = jResp.StringOf("response.result.presentation.theme_layout")
Dim Theme_primary_color As String = jResp.StringOf("response.result.presentation.theme_primary_color")
Dim Time_entry_notes_heading As String = jResp.StringOf("response.result.presentation.time_entry_notes_heading")
Dim Unit_cost_heading As String = jResp.StringOf("response.result.presentation.unit_cost_heading")

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/presentations

Postman Collection Item JSON

{
  "name": "Get default invoice presentation styles",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/presentations",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoices",
        "presentations"
      ]
    }
  },
  "response": [
    {
      "name": "Get default invoice presentation styles",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/presentations",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "invoices",
            "presentations"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXQxdcElQPRwMQX1gPFUEUAxxUT1MHBAVSVAkEAlpVW1EHWgFOFQkYEAIEDFMIAgQAXFcCUlABDQsSSAcDW0JSOw=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1558636751"
        },
        {
          "key": "Retry-After",
          "value": "57"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 23 May 2018 18:38:13 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": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Thu, 23 May 2019 18:38:13 GMT"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17381-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            \"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\": \"/uploads/images/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6InBpenphZG90bmV0LmpwZyIsImxlbmd0aCI6MTA2MDM3LCJmaWxlbmFtZSI6InVwbG9hZC0xM2UwMmRiYzI2ZWEyMmQzYTJmZmY3ZmZmYWUwZjZjMzE5MzUxMWQ4IiwiYnVja2V0IjoidXBsb2FkcyIsImtleSI6Iidkb2NzLSctNDIzNjQxMC91cGxvYWQtMTNlMDJkYmMyNmVhMjJkM2EyZmZmN2ZmZmFlMGY2YzMxOTM1MTFkOCJ9.d7YhBtzuxdiglt5d6eUVZc_dORsnOAJuDx1XvYj2utg\",\n                \"invoiceid\": 99748,\n                \"item_heading\": null,\n                \"label\": null,\n                \"quantity_heading\": null,\n                \"rate_heading\": null,\n                \"task_heading\": null,\n                \"theme_font_name\": \"modern\",\n                \"theme_layout\": \"simple\",\n                \"theme_primary_color\": \"#663399\",\n                \"time_entry_notes_heading\": null,\n                \"unit_cost_heading\": null\n            }\n        }\n    }\n}"
    }
  ]
}