SQL Server / New FreshBooks / Accounts Aging
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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging', @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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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": {
-- "accounts_aging": {
-- "accounts": [
-- {
-- "0-30": {
-- "amount": "3830.00",
-- "code": "USD"
-- },
-- "31-60": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "61-90": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "91+": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "email": "first@company.com",
-- "fname": "Nicolas",
-- "lname": "one",
-- "organization": "first company",
-- "total": {
-- "amount": "3830.00",
-- "code": "USD"
-- },
-- "userid": 31006
-- },
-- {
-- "0-30": {
-- "amount": "50.00",
-- "code": "USD"
-- },
-- "31-60": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "61-90": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "91+": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "email": "mwesthofer5i@imdb.com",
-- "fname": "Myrta",
-- "lname": "Westhofer",
-- "organization": "Prosacco Group",
-- "total": {
-- "amount": "50.00",
-- "code": "USD"
-- },
-- "userid": 32080
-- },
-- {
-- "0-30": {
-- "amount": "398.48",
-- "code": "USD"
-- },
-- "31-60": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "61-90": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "91+": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "email": "api.freshbooks@gmail.com",
-- "fname": "Ryan",
-- "lname": "Marr",
-- "organization": "Ryan Marr",
-- "total": {
-- "amount": "398.48",
-- "code": "USD"
-- },
-- "userid": 75162
-- }
-- ],
-- "company_name": "Postman Sandbox",
-- "currency_code": "USD",
-- "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjMxMDA0LCJjb250YWN0aWQiOi0xLCJsZXZlbCI6LTIwLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJhY2NvdW50c19hZ2luZyIsInBhcmFtcyI6eyJlbmRfZGF0ZSI6IjIwMTktMDUtMDgiLCJjdXJyZW5jeV9jb2RlIjoiVVNEIn0sImlhdCI6MTU1NzM0NjM4OCwiZXhwIjoxNTU5OTM4Mzg4fQ.Usasm7HQKxakFm5gFDAYMez__vLM5_VETtWdvdqJMeQ",
-- "end_date": "2019-05-08",
-- "totals": {
-- "0-30": {
-- "amount": "4278.48",
-- "code": "USD"
-- },
-- "31-60": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "61-90": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "91+": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "total": {
-- "amount": "4278.48",
-- "code": "USD"
-- }
-- }
-- }
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_0_30Amount nvarchar(4000)
DECLARE @v_0_30Code nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @fname nvarchar(4000)
DECLARE @lname nvarchar(4000)
DECLARE @organization nvarchar(4000)
DECLARE @totalAmount nvarchar(4000)
DECLARE @totalCode nvarchar(4000)
DECLARE @userid int
DECLARE @Company_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Company_name OUT, 'response.result.accounts_aging.company_name'
DECLARE @Currency_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Currency_code OUT, 'response.result.accounts_aging.currency_code'
DECLARE @Download_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Download_token OUT, 'response.result.accounts_aging.download_token'
DECLARE @End_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @End_date OUT, 'response.result.accounts_aging.end_date'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.accounts_aging.totals.0-30.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.accounts_aging.totals.0-30.code'
DECLARE @v_31_60Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_31_60Amount OUT, 'response.result.accounts_aging.totals.31-60.amount'
DECLARE @v_31_60Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_31_60Code OUT, 'response.result.accounts_aging.totals.31-60.code'
DECLARE @v_61_90Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_61_90Amount OUT, 'response.result.accounts_aging.totals.61-90.amount'
DECLARE @v_61_90Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_61_90Code OUT, 'response.result.accounts_aging.totals.61-90.code'
DECLARE @v_91Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_91Amount OUT, 'response.result.accounts_aging.totals.91+.amount'
DECLARE @v_91Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_91Code OUT, 'response.result.accounts_aging.totals.91+.code'
DECLARE @TotalAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TotalAmount OUT, 'response.result.accounts_aging.totals.total.amount'
DECLARE @TotalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TotalCode OUT, 'response.result.accounts_aging.totals.total.code'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.accounts_aging.accounts'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_0_30Amount OUT, 'response.result.accounts_aging.accounts[i].0-30.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @v_0_30Code OUT, 'response.result.accounts_aging.accounts[i].0-30.code'
EXEC sp_OAMethod @jResp, 'StringOf', @v_31_60Amount OUT, 'response.result.accounts_aging.accounts[i].31-60.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @v_31_60Code OUT, 'response.result.accounts_aging.accounts[i].31-60.code'
EXEC sp_OAMethod @jResp, 'StringOf', @v_61_90Amount OUT, 'response.result.accounts_aging.accounts[i].61-90.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @v_61_90Code OUT, 'response.result.accounts_aging.accounts[i].61-90.code'
EXEC sp_OAMethod @jResp, 'StringOf', @v_91Amount OUT, 'response.result.accounts_aging.accounts[i].91+.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @v_91Code OUT, 'response.result.accounts_aging.accounts[i].91+.code'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'response.result.accounts_aging.accounts[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @fname OUT, 'response.result.accounts_aging.accounts[i].fname'
EXEC sp_OAMethod @jResp, 'StringOf', @lname OUT, 'response.result.accounts_aging.accounts[i].lname'
EXEC sp_OAMethod @jResp, 'StringOf', @organization OUT, 'response.result.accounts_aging.accounts[i].organization'
EXEC sp_OAMethod @jResp, 'StringOf', @totalAmount OUT, 'response.result.accounts_aging.accounts[i].total.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @totalCode OUT, 'response.result.accounts_aging.accounts[i].total.code'
EXEC sp_OAMethod @jResp, 'IntOf', @userid OUT, 'response.result.accounts_aging.accounts[i].userid'
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>"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging
Postman Collection Item JSON
{
"name": "Accounts Aging",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"accounts_aging"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
}
]
}
},
"response": [
{
"name": "Accounts Aging",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"accounts_aging"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAghXWFEBAgJRUAgOAlReWlccTwlOGg4MU1cHCVJSUgsAAgUPBwNBFFVRCBIHag=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557346447"
},
{
"key": "Retry-After",
"value": "58"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:13:08 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, 08 May 2019 20:13:08 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17361-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 \"accounts_aging\": {\n \"accounts\": [\n {\n \"0-30\": {\n \"amount\": \"3830.00\",\n \"code\": \"USD\"\n },\n \"31-60\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"61-90\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"91+\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"email\": \"first@company.com\",\n \"fname\": \"Nicolas\",\n \"lname\": \"one\",\n \"organization\": \"first company\",\n \"total\": {\n \"amount\": \"3830.00\",\n \"code\": \"USD\"\n },\n \"userid\": 31006\n },\n {\n \"0-30\": {\n \"amount\": \"50.00\",\n \"code\": \"USD\"\n },\n \"31-60\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"61-90\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"91+\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"email\": \"mwesthofer5i@imdb.com\",\n \"fname\": \"Myrta\",\n \"lname\": \"Westhofer\",\n \"organization\": \"Prosacco Group\",\n \"total\": {\n \"amount\": \"50.00\",\n \"code\": \"USD\"\n },\n \"userid\": 32080\n },\n {\n \"0-30\": {\n \"amount\": \"398.48\",\n \"code\": \"USD\"\n },\n \"31-60\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"61-90\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"91+\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"email\": \"api.freshbooks@gmail.com\",\n \"fname\": \"Ryan\",\n \"lname\": \"Marr\",\n \"organization\": \"Ryan Marr\",\n \"total\": {\n \"amount\": \"398.48\",\n \"code\": \"USD\"\n },\n \"userid\": 75162\n }\n ],\n \"company_name\": \"Postman Sandbox\",\n \"currency_code\": \"USD\",\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjMxMDA0LCJjb250YWN0aWQiOi0xLCJsZXZlbCI6LTIwLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJhY2NvdW50c19hZ2luZyIsInBhcmFtcyI6eyJlbmRfZGF0ZSI6IjIwMTktMDUtMDgiLCJjdXJyZW5jeV9jb2RlIjoiVVNEIn0sImlhdCI6MTU1NzM0NjM4OCwiZXhwIjoxNTU5OTM4Mzg4fQ.Usasm7HQKxakFm5gFDAYMez__vLM5_VETtWdvdqJMeQ\",\n \"end_date\": \"2019-05-08\",\n \"totals\": {\n \"0-30\": {\n \"amount\": \"4278.48\",\n \"code\": \"USD\"\n },\n \"31-60\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"61-90\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"91+\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"total\": {\n \"amount\": \"4278.48\",\n \"code\": \"USD\"\n }\n }\n }\n }\n }\n}"
}
]
}
