VB.NET / New FreshBooks / Get Single Invoice Profile
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>"
http.SetRequestHeader("content","app")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",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": {
' "invoice_profile": {
' "accounting_systemid": "wkMd2g",
' "address": "",
' "amount": {
' "amount": "0.00",
' "code": "USD"
' },
' "auto_bill": false,
' "bill_gateway": null,
' "city": "",
' "code": "",
' "country": "Canada",
' "create_date": "2019-04-25",
' "currency_code": "USD",
' "customerid": 31006,
' "description": "",
' "disable": false,
' "discount_total": {
' "amount": "0.00",
' "code": "USD"
' },
' "discount_value": "0",
' "due_offset_days": 0,
' "ext_archive": null,
' "fname": "Nicolas",
' "frequency": "m",
' "id": 456,
' "include_unbilled_time": false,
' "language": "en",
' "lname": "one",
' "notes": "",
' "numberRecurring": 3,
' "occurrences_to_date": 0,
' "organization": "first company",
' "ownerid": 1,
' "payment_details": "",
' "po_number": null,
' "profileid": 456,
' "province": "",
' "require_auto_bill": false,
' "retainer_id": null,
' "send_email": true,
' "send_gmail": false,
' "street": "",
' "street2": "",
' "terms": null,
' "total_accrued_revenue": null,
' "updated": "2019-04-24 13:47:38",
' "vat_name": null,
' "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
Dim Accounting_systemid As String = jResp.StringOf("response.result.invoice_profile.accounting_systemid")
Dim Address As String = jResp.StringOf("response.result.invoice_profile.address")
Dim Amount As String = jResp.StringOf("response.result.invoice_profile.amount.amount")
Dim Code As String = jResp.StringOf("response.result.invoice_profile.amount.code")
Dim Auto_bill As Boolean = jResp.BoolOf("response.result.invoice_profile.auto_bill")
Dim Bill_gateway As String = jResp.StringOf("response.result.invoice_profile.bill_gateway")
Dim City As String = jResp.StringOf("response.result.invoice_profile.city")
Dim Invoice_profileCode As String = jResp.StringOf("response.result.invoice_profile.code")
Dim Country As String = jResp.StringOf("response.result.invoice_profile.country")
Dim Create_date As String = jResp.StringOf("response.result.invoice_profile.create_date")
Dim Currency_code As String = jResp.StringOf("response.result.invoice_profile.currency_code")
Dim Customerid As Integer = jResp.IntOf("response.result.invoice_profile.customerid")
Dim Description As String = jResp.StringOf("response.result.invoice_profile.description")
Dim Disable As Boolean = jResp.BoolOf("response.result.invoice_profile.disable")
Dim Discount_totalAmount As String = jResp.StringOf("response.result.invoice_profile.discount_total.amount")
Dim Discount_totalCode As String = jResp.StringOf("response.result.invoice_profile.discount_total.code")
Dim Discount_value As String = jResp.StringOf("response.result.invoice_profile.discount_value")
Dim Due_offset_days As Integer = jResp.IntOf("response.result.invoice_profile.due_offset_days")
Dim Ext_archive As String = jResp.StringOf("response.result.invoice_profile.ext_archive")
Dim Fname As String = jResp.StringOf("response.result.invoice_profile.fname")
Dim Frequency As String = jResp.StringOf("response.result.invoice_profile.frequency")
Dim Id As Integer = jResp.IntOf("response.result.invoice_profile.id")
Dim Include_unbilled_time As Boolean = jResp.BoolOf("response.result.invoice_profile.include_unbilled_time")
Dim Language As String = jResp.StringOf("response.result.invoice_profile.language")
Dim Lname As String = jResp.StringOf("response.result.invoice_profile.lname")
Dim Notes As String = jResp.StringOf("response.result.invoice_profile.notes")
Dim NumberRecurring As Integer = jResp.IntOf("response.result.invoice_profile.numberRecurring")
Dim Occurrences_to_date As Integer = jResp.IntOf("response.result.invoice_profile.occurrences_to_date")
Dim Organization As String = jResp.StringOf("response.result.invoice_profile.organization")
Dim Ownerid As Integer = jResp.IntOf("response.result.invoice_profile.ownerid")
Dim Payment_details As String = jResp.StringOf("response.result.invoice_profile.payment_details")
Dim Po_number As String = jResp.StringOf("response.result.invoice_profile.po_number")
Dim Profileid As Integer = jResp.IntOf("response.result.invoice_profile.profileid")
Dim Province As String = jResp.StringOf("response.result.invoice_profile.province")
Dim Require_auto_bill As Boolean = jResp.BoolOf("response.result.invoice_profile.require_auto_bill")
Dim Retainer_id As String = jResp.StringOf("response.result.invoice_profile.retainer_id")
Dim Send_email As Boolean = jResp.BoolOf("response.result.invoice_profile.send_email")
Dim Send_gmail As Boolean = jResp.BoolOf("response.result.invoice_profile.send_gmail")
Dim Street As String = jResp.StringOf("response.result.invoice_profile.street")
Dim Street2 As String = jResp.StringOf("response.result.invoice_profile.street2")
Dim Terms As String = jResp.StringOf("response.result.invoice_profile.terms")
Dim Total_accrued_revenue As String = jResp.StringOf("response.result.invoice_profile.total_accrued_revenue")
Dim Updated As String = jResp.StringOf("response.result.invoice_profile.updated")
Dim Vat_name As String = jResp.StringOf("response.result.invoice_profile.vat_name")
Dim Vat_number As String = jResp.StringOf("response.result.invoice_profile.vat_number")
Dim Vis_state As Integer = jResp.IntOf("response.result.invoice_profile.vis_state")
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "content: app"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}
Postman Collection Item JSON
{
"name": "Get Single Invoice Profile",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"invoiceProfileId\", jsonData.response.result.invoice_profile.id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "content",
"value": "app",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
},
"description": "\t"
},
"response": [
{
"name": "Get Single Invoice Profile",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "content",
"value": "app",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAQ9VUwQGA1JfVlEGVQxRCQ4YHwJJGwUEAAFQXA8GAFBVXAIIXAJAG1dWChdUaw=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:16:06 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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:16:06 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_profile\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"bill_gateway\": null,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-25\",\n \"currency_code\": \"USD\",\n \"customerid\": 31006,\n \"description\": \"\",\n \"disable\": false,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"due_offset_days\": 0,\n \"ext_archive\": null,\n \"fname\": \"Nicolas\",\n \"frequency\": \"m\",\n \"id\": 456,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\n \"numberRecurring\": 3,\n \"occurrences_to_date\": 0,\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 456,\n \"province\": \"\",\n \"require_auto_bill\": false,\n \"retainer_id\": null,\n \"send_email\": true,\n \"send_gmail\": false,\n \"street\": \"\",\n \"street2\": \"\",\n \"terms\": null,\n \"total_accrued_revenue\": null,\n \"updated\": \"2019-04-24 13:47:38\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
