SQL Server / New FreshBooks / List Expense Categories
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "response": {
-- "result": {
-- "categories": [
-- {
-- "category": "Accident Insurance",
-- "categoryid": 2003192,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003192,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003186,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Accounting",
-- "categoryid": 2003198,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003198,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003194,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Advertising",
-- "categoryid": 2003168,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003168,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": null,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Airfare",
-- "categoryid": 2003242,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003242,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003238,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Bank Fees",
-- "categoryid": 2003148,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003148,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003142,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Business Insurance",
-- "categoryid": 2003146,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003146,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003142,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Car & Truck Expenses",
-- "categoryid": 2003170,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003170,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": null,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Commissions",
-- "categoryid": 2003164,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003164,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003142,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Computer Parts",
-- "categoryid": 2005674,
-- "created_at": "2019-04-18 09:40:57",
-- "id": 2005674,
-- "is_cogs": false,
-- "is_editable": true,
-- "parentid": 2003142,
-- "updated_at": "2019-04-18 09:40:57",
-- "vis_state": 0
-- },
-- {
-- "category": "Contractors",
-- "categoryid": 2003182,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003182,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": null,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Depreciation",
-- "categoryid": 2003160,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003160,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003142,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Education and Training",
-- "categoryid": 2003184,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003184,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": null,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Employee Benefits",
-- "categoryid": 2003186,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003186,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": null,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Entertainment",
-- "categoryid": 2003204,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003204,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003200,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- },
-- {
-- "category": "Equipment",
-- "categoryid": 2003232,
-- "created_at": "2019-04-18 09:14:52",
-- "id": 2003232,
-- "is_cogs": false,
-- "is_editable": false,
-- "parentid": 2003226,
-- "updated_at": "2019-04-18 09:14:52",
-- "vis_state": 0
-- }
-- ],
-- "page": 1,
-- "pages": 4,
-- "per_page": 15,
-- "total": 56
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @category nvarchar(4000)
DECLARE @categoryid int
DECLARE @created_at nvarchar(4000)
DECLARE @id int
DECLARE @is_cogs int
DECLARE @is_editable int
DECLARE @parentid int
DECLARE @updated_at nvarchar(4000)
DECLARE @vis_state int
DECLARE @Page int
EXEC sp_OAMethod @jResp, 'IntOf', @Page OUT, 'response.result.page'
DECLARE @Pages int
EXEC sp_OAMethod @jResp, 'IntOf', @Pages OUT, 'response.result.pages'
DECLARE @Per_page int
EXEC sp_OAMethod @jResp, 'IntOf', @Per_page OUT, 'response.result.per_page'
DECLARE @Total int
EXEC sp_OAMethod @jResp, 'IntOf', @Total OUT, 'response.result.total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.categories'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @category OUT, 'response.result.categories[i].category'
EXEC sp_OAMethod @jResp, 'IntOf', @categoryid OUT, 'response.result.categories[i].categoryid'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'response.result.categories[i].created_at'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'response.result.categories[i].id'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_cogs OUT, 'response.result.categories[i].is_cogs'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_editable OUT, 'response.result.categories[i].is_editable'
EXEC sp_OAMethod @jResp, 'IntOf', @parentid OUT, 'response.result.categories[i].parentid'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'response.result.categories[i].updated_at'
EXEC sp_OAMethod @jResp, 'IntOf', @vis_state OUT, 'response.result.categories[i].vis_state'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories
Postman Collection Item JSON
{
"name": "List Expense Categories",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"categoryId\", jsonData.response.result.categories[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}}/expenses/categories",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"categories"
]
}
},
"response": [
{
"name": "List Expense Categories",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"categories"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoBWRZdX1tAWgBKQx1RH1JKBwZVV1YJBwdTWVMEBgVWUx0bAk5EAVpSVghRWwBXUwEDDlIDAhFOAldbEgM+"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:03:50 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:03:50 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 \"categories\": [\n {\n \"category\": \"Accident Insurance\",\n \"categoryid\": 2003192,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003192,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003186,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Accounting\",\n \"categoryid\": 2003198,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003198,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003194,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Advertising\",\n \"categoryid\": 2003168,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003168,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Airfare\",\n \"categoryid\": 2003242,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003242,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003238,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Bank Fees\",\n \"categoryid\": 2003148,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003148,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003142,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Business Insurance\",\n \"categoryid\": 2003146,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003146,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003142,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Car & Truck Expenses\",\n \"categoryid\": 2003170,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003170,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Commissions\",\n \"categoryid\": 2003164,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003164,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003142,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Computer Parts\",\n \"categoryid\": 2005674,\n \"created_at\": \"2019-04-18 09:40:57\",\n \"id\": 2005674,\n \"is_cogs\": false,\n \"is_editable\": true,\n \"parentid\": 2003142,\n \"updated_at\": \"2019-04-18 09:40:57\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Contractors\",\n \"categoryid\": 2003182,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003182,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Depreciation\",\n \"categoryid\": 2003160,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003160,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003142,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Education and Training\",\n \"categoryid\": 2003184,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003184,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Employee Benefits\",\n \"categoryid\": 2003186,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003186,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": null,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Entertainment\",\n \"categoryid\": 2003204,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003204,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003200,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n },\n {\n \"category\": \"Equipment\",\n \"categoryid\": 2003232,\n \"created_at\": \"2019-04-18 09:14:52\",\n \"id\": 2003232,\n \"is_cogs\": false,\n \"is_editable\": false,\n \"parentid\": 2003226,\n \"updated_at\": \"2019-04-18 09:14:52\",\n \"vis_state\": 0\n }\n ],\n \"page\": 1,\n \"pages\": 4,\n \"per_page\": 15,\n \"total\": 56\n }\n }\n}"
}
]
}
