SQL Server / New FreshBooks / List Estimates
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>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
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}}/estimates/estimates', @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": {
-- "estimates": [
-- {
-- "accepted": false,
-- "accounting_systemid": "wkMd2g",
-- "address": "",
-- "amount": {
-- "amount": "17628.00",
-- "code": "USD"
-- },
-- "city": "",
-- "code": "",
-- "country": "Canada",
-- "create_date": "2019-04-18",
-- "created_at": "2019-04-18 09:42:52",
-- "currency_code": "USD",
-- "current_organization": "first company",
-- "customerid": 31006,
-- "description": "it's a computer hardware version 1",
-- "discount_total": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "discount_value": "0",
-- "display_status": "draft",
-- "estimate_number": "0000001",
-- "estimateid": 1706,
-- "ext_archive": 0,
-- "fname": "Client",
-- "id": 1706,
-- "invoiced": false,
-- "language": "en",
-- "lname": "one",
-- "notes": "This is an estimate for the computer",
-- "organization": "first company",
-- "ownerid": 1,
-- "po_number": null,
-- "province": "",
-- "reply_status": null,
-- "require_client_signature": false,
-- "rich_proposal": false,
-- "sentid": 1,
-- "status": 1,
-- "street": "",
-- "street2": "",
-- "template": "clean-grouped",
-- "terms": "50% deposit upon acceptance, 50% on delivery of the computers.",
-- "ui_status": "draft",
-- "updated": "2019-04-18 09:42:52",
-- "vat_name": null,
-- "vat_number": "",
-- "vis_state": 0
-- }
-- ],
-- "page": 1,
-- "pages": 1,
-- "per_page": 15,
-- "total": 1
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @accepted int
DECLARE @accounting_systemid nvarchar(4000)
DECLARE @address nvarchar(4000)
DECLARE @Amount nvarchar(4000)
DECLARE @Code nvarchar(4000)
DECLARE @city nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @country nvarchar(4000)
DECLARE @create_date nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @currency_code nvarchar(4000)
DECLARE @current_organization nvarchar(4000)
DECLARE @customerid int
DECLARE @description nvarchar(4000)
DECLARE @discount_totalAmount nvarchar(4000)
DECLARE @discount_totalCode nvarchar(4000)
DECLARE @discount_value nvarchar(4000)
DECLARE @display_status nvarchar(4000)
DECLARE @estimate_number nvarchar(4000)
DECLARE @estimateid int
DECLARE @ext_archive int
DECLARE @fname nvarchar(4000)
DECLARE @id int
DECLARE @invoiced int
DECLARE @language nvarchar(4000)
DECLARE @lname nvarchar(4000)
DECLARE @notes nvarchar(4000)
DECLARE @organization nvarchar(4000)
DECLARE @ownerid int
DECLARE @po_number nvarchar(4000)
DECLARE @province nvarchar(4000)
DECLARE @reply_status nvarchar(4000)
DECLARE @require_client_signature int
DECLARE @rich_proposal int
DECLARE @sentid int
DECLARE @status int
DECLARE @street nvarchar(4000)
DECLARE @street2 nvarchar(4000)
DECLARE @template nvarchar(4000)
DECLARE @terms nvarchar(4000)
DECLARE @ui_status nvarchar(4000)
DECLARE @updated nvarchar(4000)
DECLARE @vat_name nvarchar(4000)
DECLARE @vat_number 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.estimates'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'BoolOf', @accepted OUT, 'response.result.estimates[i].accepted'
EXEC sp_OAMethod @jResp, 'StringOf', @accounting_systemid OUT, 'response.result.estimates[i].accounting_systemid'
EXEC sp_OAMethod @jResp, 'StringOf', @address OUT, 'response.result.estimates[i].address'
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.estimates[i].amount.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.estimates[i].amount.code'
EXEC sp_OAMethod @jResp, 'StringOf', @city OUT, 'response.result.estimates[i].city'
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'response.result.estimates[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @country OUT, 'response.result.estimates[i].country'
EXEC sp_OAMethod @jResp, 'StringOf', @create_date OUT, 'response.result.estimates[i].create_date'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'response.result.estimates[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @currency_code OUT, 'response.result.estimates[i].currency_code'
EXEC sp_OAMethod @jResp, 'StringOf', @current_organization OUT, 'response.result.estimates[i].current_organization'
EXEC sp_OAMethod @jResp, 'IntOf', @customerid OUT, 'response.result.estimates[i].customerid'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'response.result.estimates[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @discount_totalAmount OUT, 'response.result.estimates[i].discount_total.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @discount_totalCode OUT, 'response.result.estimates[i].discount_total.code'
EXEC sp_OAMethod @jResp, 'StringOf', @discount_value OUT, 'response.result.estimates[i].discount_value'
EXEC sp_OAMethod @jResp, 'StringOf', @display_status OUT, 'response.result.estimates[i].display_status'
EXEC sp_OAMethod @jResp, 'StringOf', @estimate_number OUT, 'response.result.estimates[i].estimate_number'
EXEC sp_OAMethod @jResp, 'IntOf', @estimateid OUT, 'response.result.estimates[i].estimateid'
EXEC sp_OAMethod @jResp, 'IntOf', @ext_archive OUT, 'response.result.estimates[i].ext_archive'
EXEC sp_OAMethod @jResp, 'StringOf', @fname OUT, 'response.result.estimates[i].fname'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'response.result.estimates[i].id'
EXEC sp_OAMethod @jResp, 'BoolOf', @invoiced OUT, 'response.result.estimates[i].invoiced'
EXEC sp_OAMethod @jResp, 'StringOf', @language OUT, 'response.result.estimates[i].language'
EXEC sp_OAMethod @jResp, 'StringOf', @lname OUT, 'response.result.estimates[i].lname'
EXEC sp_OAMethod @jResp, 'StringOf', @notes OUT, 'response.result.estimates[i].notes'
EXEC sp_OAMethod @jResp, 'StringOf', @organization OUT, 'response.result.estimates[i].organization'
EXEC sp_OAMethod @jResp, 'IntOf', @ownerid OUT, 'response.result.estimates[i].ownerid'
EXEC sp_OAMethod @jResp, 'StringOf', @po_number OUT, 'response.result.estimates[i].po_number'
EXEC sp_OAMethod @jResp, 'StringOf', @province OUT, 'response.result.estimates[i].province'
EXEC sp_OAMethod @jResp, 'StringOf', @reply_status OUT, 'response.result.estimates[i].reply_status'
EXEC sp_OAMethod @jResp, 'BoolOf', @require_client_signature OUT, 'response.result.estimates[i].require_client_signature'
EXEC sp_OAMethod @jResp, 'BoolOf', @rich_proposal OUT, 'response.result.estimates[i].rich_proposal'
EXEC sp_OAMethod @jResp, 'IntOf', @sentid OUT, 'response.result.estimates[i].sentid'
EXEC sp_OAMethod @jResp, 'IntOf', @status OUT, 'response.result.estimates[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @street OUT, 'response.result.estimates[i].street'
EXEC sp_OAMethod @jResp, 'StringOf', @street2 OUT, 'response.result.estimates[i].street2'
EXEC sp_OAMethod @jResp, 'StringOf', @template OUT, 'response.result.estimates[i].template'
EXEC sp_OAMethod @jResp, 'StringOf', @terms OUT, 'response.result.estimates[i].terms'
EXEC sp_OAMethod @jResp, 'StringOf', @ui_status OUT, 'response.result.estimates[i].ui_status'
EXEC sp_OAMethod @jResp, 'StringOf', @updated OUT, 'response.result.estimates[i].updated'
EXEC sp_OAMethod @jResp, 'StringOf', @vat_name OUT, 'response.result.estimates[i].vat_name'
EXEC sp_OAMethod @jResp, 'StringOf', @vat_number OUT, 'response.result.estimates[i].vat_number'
EXEC sp_OAMethod @jResp, 'IntOf', @vis_state OUT, 'response.result.estimates[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}}/estimates/estimates
Postman Collection Item JSON
{
"name": "List Estimates",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"estimateId\", jsonData.response.result.estimates[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}}/estimates/estimates",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates"
],
"query": [
{
"key": "include[]",
"value": "audit_logs\t",
"description": "Show estimate view/send history\n",
"disabled": true
},
{
"key": "include[]",
"value": "comments",
"description": "Comments made on estimate\n",
"disabled": true
},
{
"key": "include[]",
"value": "contacts",
"description": "List of client contacts\n",
"disabled": true
},
{
"key": "include[]",
"value": "lines",
"description": "Estimate lines\n",
"disabled": true
},
{
"key": "include[]",
"value": "owner",
"description": "Owner info\n",
"disabled": true
},
{
"key": "include[]",
"value": "presentation",
"description": "Presentation type\n",
"disabled": true
},
{
"key": "include[]",
"value": "project",
"description": "Projects",
"disabled": true
},
{
"key": "include[]",
"value": "invoices",
"description": "Invoices",
"disabled": true
},
{
"key": "include[]",
"value": "system",
"description": "Estimate owner's system\n",
"disabled": true
}
]
},
"description": "Get an entire list of estimates that exist within your account."
},
"response": [
{
"name": "List Estimates",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwBKQx1RH1JKBwRQU1sMAgZTVVoHBQFeUwQaHlNKQVoDB11RWl0HB1ADXABVVgFASFBWDRUGZQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:56:51 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 17:56:51 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 \"estimates\": [\n {\n \"accepted\": false,\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"17628.00\",\n \"code\": \"USD\"\n },\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-18\",\n \"created_at\": \"2019-04-18 09:42:52\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"description\": \"it's a computer hardware version 1\",\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"estimate_number\": \"0000001\",\n \"estimateid\": 1706,\n \"ext_archive\": 0,\n \"fname\": \"Client\",\n \"id\": 1706,\n \"invoiced\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"This is an estimate for the computer\",\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"po_number\": null,\n \"province\": \"\",\n \"reply_status\": null,\n \"require_client_signature\": false,\n \"rich_proposal\": false,\n \"sentid\": 1,\n \"status\": 1,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"50% deposit upon acceptance, 50% on delivery of the computers.\",\n \"ui_status\": \"draft\",\n \"updated\": \"2019-04-18 09:42:52\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 1\n }\n }\n}"
}
]
}
