PureBasic / New FreshBooks / Get Single Invoice Profile
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"content","app")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "response": {
; "result": {
; "invoice_profile": {
; "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
; }
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Accounting_systemid.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.accounting_systemid")
Address.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.address")
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.amount.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.amount.code")
Auto_bill.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.auto_bill")
Bill_gateway.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.bill_gateway")
City.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.city")
Invoice_profileCode.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.code")
Country.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.country")
Create_date.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.create_date")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.currency_code")
Customerid.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.customerid")
Description.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.description")
Disable.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.disable")
Discount_totalAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.discount_total.amount")
Discount_totalCode.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.discount_total.code")
Discount_value.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.discount_value")
Due_offset_days.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.due_offset_days")
Ext_archive.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.ext_archive")
Fname.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.fname")
Frequency.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.frequency")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.id")
Include_unbilled_time.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.include_unbilled_time")
Language.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.language")
Lname.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.lname")
Notes.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.notes")
NumberRecurring.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.numberRecurring")
Occurrences_to_date.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.occurrences_to_date")
Organization.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.organization")
Ownerid.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.ownerid")
Payment_details.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.payment_details")
Po_number.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.po_number")
Profileid.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.profileid")
Province.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.province")
Require_auto_bill.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.require_auto_bill")
Retainer_id.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.retainer_id")
Send_email.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.send_email")
Send_gmail.i = CkJsonObject::ckBoolOf(jResp,"response.result.invoice_profile.send_gmail")
Street.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.street")
Street2.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.street2")
Terms.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.terms")
Total_accrued_revenue.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.total_accrued_revenue")
Updated.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.updated")
Vat_name.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.vat_name")
Vat_number.s = CkJsonObject::ckStringOf(jResp,"response.result.invoice_profile.vat_number")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.invoice_profile.vis_state")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "content: app"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}
Postman Collection Item JSON
{
"name": "Get Single Invoice Profile",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"invoiceProfileId\", jsonData.response.result.invoice_profile.id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "content",
"value": "app",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
},
"description": "\t"
},
"response": [
{
"name": "Get Single Invoice Profile",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "content",
"value": "app",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoice_profiles/invoice_profiles/{{invoiceProfileId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoice_profiles",
"invoice_profiles",
"{{invoiceProfileId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGPUAQVwRRVFFBCQxXF14IUAcURFgHDw9dERxUTVIZAQ9VUwQGA1JfVlEGVQxRCQ4YHwJJGwUEAAFQXA8GAFBVXAIIXAJAG1dWChdUaw=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:16:06 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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:16:06 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_profile\": {\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 }\n}"
}
]
}
