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
string ls_Account_number
string ls_City
string ls_Country
string ls_Created_at
string ls_Currency_code
integer li_Is_1099
string ls_Language
string ls_Phone
string ls_Postal_code
string ls_Primary_contact_email
string ls_Primary_contact_first_name
string ls_Primary_contact_last_name
string ls_Province
string ls_Street
string ls_Street2
string ls_Updated_at
string ls_Vendor_name
integer li_Vendorid
integer li_Vis_state
string ls_Website
integer j
integer li_Count_j
string ls_Amount
string ls_Code
string ls_Amount
integer li_Enabled
string ls_Name
integer li_System_taxid
string ls_Tax_authorityid
integer li_Taxid
integer li_Page
integer li_Pages
integer li_Per_page
integer li_Total
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("search[date_min]","2021-10-09")
loo_QueryParams.UpdateString("search[date_max]","search[date_min]")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/5pyBd/bills/bills",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
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.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": {
// "bill_vendors": [
// {
// "account_number": "8394858982590",
// "city": null,
// "country": null,
// "created_at": "2020-10-06 14:20:20",
// "currency_code": "CAD",
// "is_1099": false,
// "language": "en",
// "outstanding_balance": [
// {
// "amount": {
// "amount": "5.00",
// "code": "CAD"
// }
// }
// ],
// "overdue_balance": [
// ],
// "phone": "8335970553",
// "postal_code": null,
// "primary_contact_email": "hdavid@freshbooks.com",
// "primary_contact_first_name": "Hannah",
// "primary_contact_last_name": "David",
// "province": null,
// "street": null,
// "street2": null,
// "tax_defaults": [
// {
// "amount": "13.56",
// "created_at": "2020-10-06 14:23:06",
// "enabled": true,
// "name": "GST",
// "system_taxid": 36859,
// "tax_authorityid": null,
// "taxid": 1,
// "updated_at": "2020-10-06 14:23:06",
// "vendorid": 1
// },
// {
// "amount": "13",
// "created_at": "2020-10-06 14:23:06",
// "enabled": true,
// "name": "HST",
// "system_taxid": 37696,
// "tax_authorityid": null,
// "taxid": 3,
// "updated_at": "2020-10-06 14:23:06",
// "vendorid": 1
// }
// ],
// "updated_at": "2020-10-06 14:22:49",
// "vendor_name": "Staples",
// "vendorid": 1,
// "vis_state": 0,
// "website": null
// }
// ],
// "page": 1,
// "pages": 1,
// "per_page": 15,
// "total": 1
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
li_Page = loo_JResp.IntOf("response.result.page")
li_Pages = loo_JResp.IntOf("response.result.pages")
li_Per_page = loo_JResp.IntOf("response.result.per_page")
li_Total = loo_JResp.IntOf("response.result.total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.bill_vendors")
do while i < li_Count_i
loo_JResp.I = i
ls_Account_number = loo_JResp.StringOf("response.result.bill_vendors[i].account_number")
ls_City = loo_JResp.StringOf("response.result.bill_vendors[i].city")
ls_Country = loo_JResp.StringOf("response.result.bill_vendors[i].country")
ls_Created_at = loo_JResp.StringOf("response.result.bill_vendors[i].created_at")
ls_Currency_code = loo_JResp.StringOf("response.result.bill_vendors[i].currency_code")
li_Is_1099 = loo_JResp.BoolOf("response.result.bill_vendors[i].is_1099")
ls_Language = loo_JResp.StringOf("response.result.bill_vendors[i].language")
ls_Phone = loo_JResp.StringOf("response.result.bill_vendors[i].phone")
ls_Postal_code = loo_JResp.StringOf("response.result.bill_vendors[i].postal_code")
ls_Primary_contact_email = loo_JResp.StringOf("response.result.bill_vendors[i].primary_contact_email")
ls_Primary_contact_first_name = loo_JResp.StringOf("response.result.bill_vendors[i].primary_contact_first_name")
ls_Primary_contact_last_name = loo_JResp.StringOf("response.result.bill_vendors[i].primary_contact_last_name")
ls_Province = loo_JResp.StringOf("response.result.bill_vendors[i].province")
ls_Street = loo_JResp.StringOf("response.result.bill_vendors[i].street")
ls_Street2 = loo_JResp.StringOf("response.result.bill_vendors[i].street2")
ls_Updated_at = loo_JResp.StringOf("response.result.bill_vendors[i].updated_at")
ls_Vendor_name = loo_JResp.StringOf("response.result.bill_vendors[i].vendor_name")
li_Vendorid = loo_JResp.IntOf("response.result.bill_vendors[i].vendorid")
li_Vis_state = loo_JResp.IntOf("response.result.bill_vendors[i].vis_state")
ls_Website = loo_JResp.StringOf("response.result.bill_vendors[i].website")
j = 0
li_Count_j = loo_JResp.SizeOfArray("response.result.bill_vendors[i].outstanding_balance")
do while j < li_Count_j
loo_JResp.J = j
ls_Amount = loo_JResp.StringOf("response.result.bill_vendors[i].outstanding_balance[j].amount.amount")
ls_Code = loo_JResp.StringOf("response.result.bill_vendors[i].outstanding_balance[j].amount.code")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("response.result.bill_vendors[i].overdue_balance")
do while j < li_Count_j
loo_JResp.J = j
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("response.result.bill_vendors[i].tax_defaults")
do while j < li_Count_j
loo_JResp.J = j
ls_Amount = loo_JResp.StringOf("response.result.bill_vendors[i].tax_defaults[j].amount")
ls_Created_at = loo_JResp.StringOf("response.result.bill_vendors[i].tax_defaults[j].created_at")
li_Enabled = loo_JResp.BoolOf("response.result.bill_vendors[i].tax_defaults[j].enabled")
ls_Name = loo_JResp.StringOf("response.result.bill_vendors[i].tax_defaults[j].name")
li_System_taxid = loo_JResp.IntOf("response.result.bill_vendors[i].tax_defaults[j].system_taxid")
ls_Tax_authorityid = loo_JResp.StringOf("response.result.bill_vendors[i].tax_defaults[j].tax_authorityid")
li_Taxid = loo_JResp.IntOf("response.result.bill_vendors[i].tax_defaults[j].taxid")
ls_Updated_at = loo_JResp.StringOf("response.result.bill_vendors[i].tax_defaults[j].updated_at")
li_Vendorid = loo_JResp.IntOf("response.result.bill_vendors[i].tax_defaults[j].vendorid")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "search[date_min]=2021-10-09"
-d "search[date_max]=search%5Bdate_min%5D"
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/5pyBd/bills/bills
Postman Collection Item JSON
{
"name": "Get Bills",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"billId\", jsonData.response.result.bills[0].id)"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "eyJraWQiOiJhMTlPSlR5aVlKOXhPM3FoWnhWeE1KZE5ZNXJ4cUhpQzBSTUY0TWRheGtjIiwiYWxnIjoiUlMyNTYifQ.eyJqdGkiOiJjZTI5MTQ1MWUxMTYyMThmNDdlZDhhMGIyYWJhZGVkODhhZDIyZWUxNDlhNmI0OTczMzVlNWU3MDMxNTdmZDJmIiwiaWF0IjoxNjM3MDc4ODUyLCJleHAiOjE2MzcxMjIwNTIsInN1YiI6IlNtdXhJZGVudGl0eTs2NzA1NDgiLCJjbGllbnRfaWQiOiI1MzFlMjI0NzMxYWUxYjcyNzkyMDUwYzIxYjdjYjg4YjQ4YjVjZmYyM2IyNjQ0OGYxMGM3YjZkZDE2YzM4M2NiIiwic2NvcGUiOiJhZG1pbjphbGwiLCJhdXRoLmZyZXNoYm9va3MuY29tL3N1Yl90eXBlIjoicmVzb3VyY2Vfb3duZXIifQ.XZYsOTZZJyxc4ny1NVrAShnNqbpS1GGc54jlRSO8gll4axcdadpluV_gflS_CyZfPSw6ivhu1lwxczj5xGNllZkMI85nVs17EPmpq4MqO9b08oaWoWIptxD329uO893jxW4cFQdGLbCAnJ2BNddWoVIaHS-1EiVPbEh8EKTFeJ-j5tYHRbWcuy32ftuKrqX53z5dY3sUMRsmhsGMfOEzTUfz0J1epHqJSDGHn-HQLljZ4fbmGwCf4LlWPnsgGJj5nDxiRWbUOPXW2J73_tAAH2-u49MRhO2nf_8meHKHhCVZZ0PM4lPzaAqv5OkofwCSEEgIX4Af3Ifh88O9uLtbGg",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/5pyBd/bills/bills?search[date_min]=2021-10-09&search[date_max]=search[date_min]",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"5pyBd",
"bills",
"bills"
],
"query": [
{
"key": "search[date_min]",
"value": "2021-10-09"
},
{
"key": "search[date_max]",
"value": "search[date_min]"
}
]
}
},
"response": [
{
"name": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 09 Oct 2020 15:19:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRAGDFQNShECWl1eXxNcD1UOQRFGGgdNVk0LBQlRU1sOBwVTVwgABFBeVk4dUxRACVxRAFIGC1QHBAdaV1RWA0RPXlJcFwQ/"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "X-RateLimit-Limit",
"value": "600"
},
{
"key": "X-RateLimit-Remaining",
"value": "599"
},
{
"key": "X-RateLimit-Reset",
"value": "1602256808"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"bill_vendors\": [\n {\n \"account_number\": \"8394858982590\",\n \"city\": null,\n \"country\": null,\n \"created_at\": \"2020-10-06 14:20:20\",\n \"currency_code\": \"CAD\",\n \"is_1099\": false,\n \"language\": \"en\",\n \"outstanding_balance\": [\n {\n \"amount\": {\n \"amount\": \"5.00\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"overdue_balance\": [],\n \"phone\": \"8335970553\",\n \"postal_code\": null,\n \"primary_contact_email\": \"hdavid@freshbooks.com\",\n \"primary_contact_first_name\": \"Hannah\",\n \"primary_contact_last_name\": \"David\",\n \"province\": null,\n \"street\": null,\n \"street2\": null,\n \"tax_defaults\": [\n {\n \"amount\": \"13.56\",\n \"created_at\": \"2020-10-06 14:23:06\",\n \"enabled\": true,\n \"name\": \"GST\",\n \"system_taxid\": 36859,\n \"tax_authorityid\": null,\n \"taxid\": 1,\n \"updated_at\": \"2020-10-06 14:23:06\",\n \"vendorid\": 1\n },\n {\n \"amount\": \"13\",\n \"created_at\": \"2020-10-06 14:23:06\",\n \"enabled\": true,\n \"name\": \"HST\",\n \"system_taxid\": 37696,\n \"tax_authorityid\": null,\n \"taxid\": 3,\n \"updated_at\": \"2020-10-06 14:23:06\",\n \"vendorid\": 1\n }\n ],\n \"updated_at\": \"2020-10-06 14:22:49\",\n \"vendor_name\": \"Staples\",\n \"vendorid\": 1,\n \"vis_state\": 0,\n \"website\": null\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 1\n }\n }\n}"
}
]
}
