Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccount_number
String sCity
String sCountry
String sCreated_at
String sCurrency_code
Boolean iIs_1099
String sLanguage
String sPhone
String sPostal_code
String sPrimary_contact_email
String sPrimary_contact_first_name
String sPrimary_contact_last_name
String sProvince
String sStreet
String sStreet2
String sUpdated_at
String sVendor_name
Integer iVendorid
Integer iVis_state
String sWebsite
Integer j
Integer iCount_j
String sAmount
String sCode
String sAmount
Boolean iEnabled
String sName
Integer iSystem_taxid
String sTax_authorityid
Integer iTaxid
Integer iPage
Integer iPages
Integer iPer_page
Integer iTotal
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "search[date_min]" "2021-10-09" To iSuccess
Get ComUpdateString Of hoQueryParams "search[date_max]" "search[date_min]" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.freshbooks.com/accounting/account/5pyBd/bills/bills" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComIntOf Of hoJResp "response.result.page" To iPage
Get ComIntOf Of hoJResp "response.result.pages" To iPages
Get ComIntOf Of hoJResp "response.result.per_page" To iPer_page
Get ComIntOf Of hoJResp "response.result.total" To iTotal
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.bill_vendors" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].account_number" To sAccount_number
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].city" To sCity
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].country" To sCountry
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].currency_code" To sCurrency_code
Get ComBoolOf Of hoJResp "response.result.bill_vendors[i].is_1099" To iIs_1099
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].language" To sLanguage
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].phone" To sPhone
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].postal_code" To sPostal_code
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].primary_contact_email" To sPrimary_contact_email
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].primary_contact_first_name" To sPrimary_contact_first_name
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].primary_contact_last_name" To sPrimary_contact_last_name
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].province" To sProvince
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].street" To sStreet
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].street2" To sStreet2
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].vendor_name" To sVendor_name
Get ComIntOf Of hoJResp "response.result.bill_vendors[i].vendorid" To iVendorid
Get ComIntOf Of hoJResp "response.result.bill_vendors[i].vis_state" To iVis_state
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].website" To sWebsite
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.bill_vendors[i].outstanding_balance" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].outstanding_balance[j].amount.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].outstanding_balance[j].amount.code" To sCode
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.bill_vendors[i].overdue_balance" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.bill_vendors[i].tax_defaults" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].amount" To sAmount
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].created_at" To sCreated_at
Get ComBoolOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].enabled" To iEnabled
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].name" To sName
Get ComIntOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].system_taxid" To iSystem_taxid
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].tax_authorityid" To sTax_authorityid
Get ComIntOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].taxid" To iTaxid
Get ComStringOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].updated_at" To sUpdated_at
Get ComIntOf Of hoJResp "response.result.bill_vendors[i].tax_defaults[j].vendorid" To iVendorid
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
