Xojo / New FreshBooks / List Invoice Profiles
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-Type","application/json"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",sbResponseBody)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(http.LastHeader)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "invoice_profiles": [
// {
// "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
// },
// {
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "0.00",
// "code": "USD"
// },
// "auto_bill": false,
// "bill_gateway": null,
// "city": "",
// "code": "",
// "country": "Canada",
// "create_date": "2019-04-20",
// "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": 378,
// "include_unbilled_time": false,
// "language": "en",
// "lname": "one",
// "notes": "",
// "numberRecurring": 3,
// "occurrences_to_date": 1,
// "organization": "first company",
// "ownerid": 31004,
// "payment_details": "",
// "po_number": null,
// "profileid": 378,
// "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
// },
// {
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "50.00",
// "code": "USD"
// },
// "auto_bill": false,
// "bill_gateway": null,
// "city": "Houston",
// "code": "",
// "country": "United States",
// "create_date": "2019-04-19",
// "currency_code": "USD",
// "customerid": 32080,
// "description": "Fanny pack with palm trees",
// "disable": false,
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "due_offset_days": 0,
// "ext_archive": null,
// "fname": "Myrta",
// "frequency": "2w",
// "id": 376,
// "include_unbilled_time": false,
// "language": "en",
// "lname": "Westhofer",
// "notes": "",
// "numberRecurring": 10,
// "occurrences_to_date": 1,
// "organization": "Prosacco Group",
// "ownerid": 1,
// "payment_details": "",
// "po_number": null,
// "profileid": 376,
// "province": "Texas",
// "require_auto_bill": false,
// "retainer_id": null,
// "send_email": true,
// "send_gmail": false,
// "street": "70347 Ramsey Plaza",
// "street2": "",
// "terms": null,
// "total_accrued_revenue": null,
// "updated": "2019-04-23 16:26:56",
// "vat_name": null,
// "vat_number": null,
// "vis_state": 0
// }
// ],
// "page": 1,
// "pages": 1,
// "per_page": 15,
// "total": 3
// }
// }
// }
// 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
Dim address As String
Dim Amount As String
Dim Code As String
Dim auto_bill As Boolean
Dim bill_gateway As String
Dim city As String
Dim code As String
Dim country As String
Dim create_date As String
Dim currency_code As String
Dim customerid As Int32
Dim description As String
Dim disable As Boolean
Dim discount_totalAmount As String
Dim discount_totalCode As String
Dim discount_value As String
Dim due_offset_days As Int32
Dim ext_archive As String
Dim fname As String
Dim frequency As String
Dim id As Int32
Dim include_unbilled_time As Boolean
Dim language As String
Dim lname As String
Dim notes As String
Dim numberRecurring As Int32
Dim occurrences_to_date As Int32
Dim organization As String
Dim ownerid As Int32
Dim payment_details As String
Dim po_number As String
Dim profileid As Int32
Dim province As String
Dim require_auto_bill As Boolean
Dim retainer_id As String
Dim send_email As Boolean
Dim send_gmail As Boolean
Dim street As String
Dim street2 As String
Dim terms As String
Dim total_accrued_revenue As String
Dim updated As String
Dim vat_name As String
Dim vat_number As String
Dim vis_state As Int32
Dim Page As Int32
Page = jResp.IntOf("response.result.page")
Dim Pages As Int32
Pages = jResp.IntOf("response.result.pages")
Dim Per_page As Int32
Per_page = jResp.IntOf("response.result.per_page")
Dim Total As Int32
Total = jResp.IntOf("response.result.total")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("response.result.invoice_profiles")
While i < count_i
jResp.I = i
accounting_systemid = jResp.StringOf("response.result.invoice_profiles[i].accounting_systemid")
address = jResp.StringOf("response.result.invoice_profiles[i].address")
Amount = jResp.StringOf("response.result.invoice_profiles[i].amount.amount")
Code = jResp.StringOf("response.result.invoice_profiles[i].amount.code")
auto_bill = jResp.BoolOf("response.result.invoice_profiles[i].auto_bill")
bill_gateway = jResp.StringOf("response.result.invoice_profiles[i].bill_gateway")
city = jResp.StringOf("response.result.invoice_profiles[i].city")
code = jResp.StringOf("response.result.invoice_profiles[i].code")
country = jResp.StringOf("response.result.invoice_profiles[i].country")
create_date = jResp.StringOf("response.result.invoice_profiles[i].create_date")
currency_code = jResp.StringOf("response.result.invoice_profiles[i].currency_code")
customerid = jResp.IntOf("response.result.invoice_profiles[i].customerid")
description = jResp.StringOf("response.result.invoice_profiles[i].description")
disable = jResp.BoolOf("response.result.invoice_profiles[i].disable")
discount_totalAmount = jResp.StringOf("response.result.invoice_profiles[i].discount_total.amount")
discount_totalCode = jResp.StringOf("response.result.invoice_profiles[i].discount_total.code")
discount_value = jResp.StringOf("response.result.invoice_profiles[i].discount_value")
due_offset_days = jResp.IntOf("response.result.invoice_profiles[i].due_offset_days")
ext_archive = jResp.StringOf("response.result.invoice_profiles[i].ext_archive")
fname = jResp.StringOf("response.result.invoice_profiles[i].fname")
frequency = jResp.StringOf("response.result.invoice_profiles[i].frequency")
id = jResp.IntOf("response.result.invoice_profiles[i].id")
include_unbilled_time = jResp.BoolOf("response.result.invoice_profiles[i].include_unbilled_time")
language = jResp.StringOf("response.result.invoice_profiles[i].language")
lname = jResp.StringOf("response.result.invoice_profiles[i].lname")
notes = jResp.StringOf("response.result.invoice_profiles[i].notes")
numberRecurring = jResp.IntOf("response.result.invoice_profiles[i].numberRecurring")
occurrences_to_date = jResp.IntOf("response.result.invoice_profiles[i].occurrences_to_date")
organization = jResp.StringOf("response.result.invoice_profiles[i].organization")
ownerid = jResp.IntOf("response.result.invoice_profiles[i].ownerid")
payment_details = jResp.StringOf("response.result.invoice_profiles[i].payment_details")
po_number = jResp.StringOf("response.result.invoice_profiles[i].po_number")
profileid = jResp.IntOf("response.result.invoice_profiles[i].profileid")
province = jResp.StringOf("response.result.invoice_profiles[i].province")
require_auto_bill = jResp.BoolOf("response.result.invoice_profiles[i].require_auto_bill")
retainer_id = jResp.StringOf("response.result.invoice_profiles[i].retainer_id")
send_email = jResp.BoolOf("response.result.invoice_profiles[i].send_email")
send_gmail = jResp.BoolOf("response.result.invoice_profiles[i].send_gmail")
street = jResp.StringOf("response.result.invoice_profiles[i].street")
street2 = jResp.StringOf("response.result.invoice_profiles[i].street2")
terms = jResp.StringOf("response.result.invoice_profiles[i].terms")
total_accrued_revenue = jResp.StringOf("response.result.invoice_profiles[i].total_accrued_revenue")
updated = jResp.StringOf("response.result.invoice_profiles[i].updated")
vat_name = jResp.StringOf("response.result.invoice_profiles[i].vat_name")
vat_number = jResp.StringOf("response.result.invoice_profiles[i].vat_number")
vis_state = jResp.IntOf("response.result.invoice_profiles[i].vis_state")
i = i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles
Postman Collection Item JSON
{
"name": "List Invoice Profiles",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"invoiceProfileId\", jsonData.response.result.invoice_profiles[0].id)"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"response": [
{
"name": "List Invoice Profiles",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dQBJIUU4HHwNRUAcPC1dSUFcEWg1aDBQZAx9HW1EFVApVB1QFBFFQXVEIUENOUVBbFQFs"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:13:07 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:13:07 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_profiles\": [\n {\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 \"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-20\",\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\": 378,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"\",\n \"numberRecurring\": 3,\n \"occurrences_to_date\": 1,\n \"organization\": \"first company\",\n \"ownerid\": 31004,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 378,\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 \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"50.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"bill_gateway\": null,\n \"city\": \"Houston\",\n \"code\": \"\",\n \"country\": \"United States\",\n \"create_date\": \"2019-04-19\",\n \"currency_code\": \"USD\",\n \"customerid\": 32080,\n \"description\": \"Fanny pack with palm trees\",\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\": \"Myrta\",\n \"frequency\": \"2w\",\n \"id\": 376,\n \"include_unbilled_time\": false,\n \"language\": \"en\",\n \"lname\": \"Westhofer\",\n \"notes\": \"\",\n \"numberRecurring\": 10,\n \"occurrences_to_date\": 1,\n \"organization\": \"Prosacco Group\",\n \"ownerid\": 1,\n \"payment_details\": \"\",\n \"po_number\": null,\n \"profileid\": 376,\n \"province\": \"Texas\",\n \"require_auto_bill\": false,\n \"retainer_id\": null,\n \"send_email\": true,\n \"send_gmail\": false,\n \"street\": \"70347 Ramsey Plaza\",\n \"street2\": \"\",\n \"terms\": null,\n \"total_accrued_revenue\": null,\n \"updated\": \"2019-04-23 16:26:56\",\n \"vat_name\": null,\n \"vat_number\": null,\n \"vis_state\": 0\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 3\n }\n }\n}"
}
]
}