Foxpro / New FreshBooks / List Invoice Profiles
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAccounting_systemid
LOCAL lcAddress
LOCAL lcAmount
LOCAL lcCode
LOCAL lnAuto_bill
LOCAL lcBill_gateway
LOCAL lcCity
LOCAL lcCode
LOCAL lcCountry
LOCAL lcCreate_date
LOCAL lcCurrency_code
LOCAL lnCustomerid
LOCAL lcDescription
LOCAL lnDisable
LOCAL lcDiscount_totalAmount
LOCAL lcDiscount_totalCode
LOCAL lcDiscount_value
LOCAL lnDue_offset_days
LOCAL lcExt_archive
LOCAL lcFname
LOCAL lcFrequency
LOCAL lnId
LOCAL lnInclude_unbilled_time
LOCAL lcLanguage
LOCAL lcLname
LOCAL lcNotes
LOCAL lnNumberRecurring
LOCAL lnOccurrences_to_date
LOCAL lcOrganization
LOCAL lnOwnerid
LOCAL lcPayment_details
LOCAL lcPo_number
LOCAL lnProfileid
LOCAL lcProvince
LOCAL lnRequire_auto_bill
LOCAL lcRetainer_id
LOCAL lnSend_email
LOCAL lnSend_gmail
LOCAL lcStreet
LOCAL lcStreet2
LOCAL lcTerms
LOCAL lcTotal_accrued_revenue
LOCAL lcUpdated
LOCAL lcVat_name
LOCAL lcVat_number
LOCAL lnVis_state
LOCAL lnPage
LOCAL lnPages
LOCAL lnPer_page
LOCAL lnTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lnPage = loJResp.IntOf("response.result.page")
lnPages = loJResp.IntOf("response.result.pages")
lnPer_page = loJResp.IntOf("response.result.per_page")
lnTotal = loJResp.IntOf("response.result.total")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.invoice_profiles")
DO WHILE i < lnCount_i
loJResp.I = i
lcAccounting_systemid = loJResp.StringOf("response.result.invoice_profiles[i].accounting_systemid")
lcAddress = loJResp.StringOf("response.result.invoice_profiles[i].address")
lcAmount = loJResp.StringOf("response.result.invoice_profiles[i].amount.amount")
lcCode = loJResp.StringOf("response.result.invoice_profiles[i].amount.code")
lnAuto_bill = loJResp.BoolOf("response.result.invoice_profiles[i].auto_bill")
lcBill_gateway = loJResp.StringOf("response.result.invoice_profiles[i].bill_gateway")
lcCity = loJResp.StringOf("response.result.invoice_profiles[i].city")
lcCode = loJResp.StringOf("response.result.invoice_profiles[i].code")
lcCountry = loJResp.StringOf("response.result.invoice_profiles[i].country")
lcCreate_date = loJResp.StringOf("response.result.invoice_profiles[i].create_date")
lcCurrency_code = loJResp.StringOf("response.result.invoice_profiles[i].currency_code")
lnCustomerid = loJResp.IntOf("response.result.invoice_profiles[i].customerid")
lcDescription = loJResp.StringOf("response.result.invoice_profiles[i].description")
lnDisable = loJResp.BoolOf("response.result.invoice_profiles[i].disable")
lcDiscount_totalAmount = loJResp.StringOf("response.result.invoice_profiles[i].discount_total.amount")
lcDiscount_totalCode = loJResp.StringOf("response.result.invoice_profiles[i].discount_total.code")
lcDiscount_value = loJResp.StringOf("response.result.invoice_profiles[i].discount_value")
lnDue_offset_days = loJResp.IntOf("response.result.invoice_profiles[i].due_offset_days")
lcExt_archive = loJResp.StringOf("response.result.invoice_profiles[i].ext_archive")
lcFname = loJResp.StringOf("response.result.invoice_profiles[i].fname")
lcFrequency = loJResp.StringOf("response.result.invoice_profiles[i].frequency")
lnId = loJResp.IntOf("response.result.invoice_profiles[i].id")
lnInclude_unbilled_time = loJResp.BoolOf("response.result.invoice_profiles[i].include_unbilled_time")
lcLanguage = loJResp.StringOf("response.result.invoice_profiles[i].language")
lcLname = loJResp.StringOf("response.result.invoice_profiles[i].lname")
lcNotes = loJResp.StringOf("response.result.invoice_profiles[i].notes")
lnNumberRecurring = loJResp.IntOf("response.result.invoice_profiles[i].numberRecurring")
lnOccurrences_to_date = loJResp.IntOf("response.result.invoice_profiles[i].occurrences_to_date")
lcOrganization = loJResp.StringOf("response.result.invoice_profiles[i].organization")
lnOwnerid = loJResp.IntOf("response.result.invoice_profiles[i].ownerid")
lcPayment_details = loJResp.StringOf("response.result.invoice_profiles[i].payment_details")
lcPo_number = loJResp.StringOf("response.result.invoice_profiles[i].po_number")
lnProfileid = loJResp.IntOf("response.result.invoice_profiles[i].profileid")
lcProvince = loJResp.StringOf("response.result.invoice_profiles[i].province")
lnRequire_auto_bill = loJResp.BoolOf("response.result.invoice_profiles[i].require_auto_bill")
lcRetainer_id = loJResp.StringOf("response.result.invoice_profiles[i].retainer_id")
lnSend_email = loJResp.BoolOf("response.result.invoice_profiles[i].send_email")
lnSend_gmail = loJResp.BoolOf("response.result.invoice_profiles[i].send_gmail")
lcStreet = loJResp.StringOf("response.result.invoice_profiles[i].street")
lcStreet2 = loJResp.StringOf("response.result.invoice_profiles[i].street2")
lcTerms = loJResp.StringOf("response.result.invoice_profiles[i].terms")
lcTotal_accrued_revenue = loJResp.StringOf("response.result.invoice_profiles[i].total_accrued_revenue")
lcUpdated = loJResp.StringOf("response.result.invoice_profiles[i].updated")
lcVat_name = loJResp.StringOf("response.result.invoice_profiles[i].vat_name")
lcVat_number = loJResp.StringOf("response.result.invoice_profiles[i].vat_number")
lnVis_state = loJResp.IntOf("response.result.invoice_profiles[i].vis_state")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
