DataFlex / New FreshBooks / List Invoice Profiles
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccounting_systemid
String sAddress
String sAmount
String sCode
Boolean iAuto_bill
String sBill_gateway
String sCity
String sCode
String sCountry
String sCreate_date
String sCurrency_code
Integer iCustomerid
String sDescription
Boolean iDisable
String sDiscount_totalAmount
String sDiscount_totalCode
String sDiscount_value
Integer iDue_offset_days
String sExt_archive
String sFname
String sFrequency
Integer iId
Boolean iInclude_unbilled_time
String sLanguage
String sLname
String sNotes
Integer iNumberRecurring
Integer iOccurrences_to_date
String sOrganization
Integer iOwnerid
String sPayment_details
String sPo_number
Integer iProfileid
String sProvince
Boolean iRequire_auto_bill
String sRetainer_id
Boolean iSend_email
Boolean iSend_gmail
String sStreet
String sStreet2
String sTerms
String sTotal_accrued_revenue
String sUpdated
String sVat_name
String sVat_number
Integer iVis_state
Integer iPage
Integer iPages
Integer iPer_page
Integer iTotal
Integer i
Integer iCount_i
String sTemp1
// 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
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
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 ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
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.invoice_profiles" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].accounting_systemid" To sAccounting_systemid
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].address" To sAddress
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].amount.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].amount.code" To sCode
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].auto_bill" To iAuto_bill
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].bill_gateway" To sBill_gateway
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].city" To sCity
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].code" To sCode
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].country" To sCountry
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].create_date" To sCreate_date
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].currency_code" To sCurrency_code
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].customerid" To iCustomerid
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].description" To sDescription
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].disable" To iDisable
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].discount_total.amount" To sDiscount_totalAmount
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].discount_total.code" To sDiscount_totalCode
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].discount_value" To sDiscount_value
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].due_offset_days" To iDue_offset_days
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].ext_archive" To sExt_archive
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].fname" To sFname
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].frequency" To sFrequency
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].id" To iId
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].include_unbilled_time" To iInclude_unbilled_time
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].language" To sLanguage
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].lname" To sLname
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].notes" To sNotes
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].numberRecurring" To iNumberRecurring
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].occurrences_to_date" To iOccurrences_to_date
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].organization" To sOrganization
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].ownerid" To iOwnerid
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].payment_details" To sPayment_details
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].po_number" To sPo_number
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].profileid" To iProfileid
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].province" To sProvince
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].require_auto_bill" To iRequire_auto_bill
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].retainer_id" To sRetainer_id
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].send_email" To iSend_email
Get ComBoolOf Of hoJResp "response.result.invoice_profiles[i].send_gmail" To iSend_gmail
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].street" To sStreet
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].street2" To sStreet2
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].terms" To sTerms
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].total_accrued_revenue" To sTotal_accrued_revenue
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].updated" To sUpdated
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].vat_name" To sVat_name
Get ComStringOf Of hoJResp "response.result.invoice_profiles[i].vat_number" To sVat_number
Get ComIntOf Of hoJResp "response.result.invoice_profiles[i].vis_state" To iVis_state
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
