SQL Server / New FreshBooks / Single Estimate
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>'
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}}/estimates/estimates/{{estimateId}}', @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": {
-- "estimate": {
-- "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
-- }
-- }
-- }
-- }
-- 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
EXEC sp_OAMethod @jResp, 'BoolOf', @Accepted OUT, 'response.result.estimate.accepted'
DECLARE @Accounting_systemid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accounting_systemid OUT, 'response.result.estimate.accounting_systemid'
DECLARE @Address nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Address OUT, 'response.result.estimate.address'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.estimate.amount.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.estimate.amount.code'
DECLARE @City nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @City OUT, 'response.result.estimate.city'
DECLARE @EstimateCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @EstimateCode OUT, 'response.result.estimate.code'
DECLARE @Country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Country OUT, 'response.result.estimate.country'
DECLARE @Create_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Create_date OUT, 'response.result.estimate.create_date'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'response.result.estimate.created_at'
DECLARE @Currency_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Currency_code OUT, 'response.result.estimate.currency_code'
DECLARE @Current_organization nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Current_organization OUT, 'response.result.estimate.current_organization'
DECLARE @Customerid int
EXEC sp_OAMethod @jResp, 'IntOf', @Customerid OUT, 'response.result.estimate.customerid'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'response.result.estimate.description'
DECLARE @Discount_totalAmount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_totalAmount OUT, 'response.result.estimate.discount_total.amount'
DECLARE @Discount_totalCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_totalCode OUT, 'response.result.estimate.discount_total.code'
DECLARE @Discount_value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Discount_value OUT, 'response.result.estimate.discount_value'
DECLARE @Display_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Display_status OUT, 'response.result.estimate.display_status'
DECLARE @Estimate_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Estimate_number OUT, 'response.result.estimate.estimate_number'
DECLARE @Estimateid int
EXEC sp_OAMethod @jResp, 'IntOf', @Estimateid OUT, 'response.result.estimate.estimateid'
DECLARE @Ext_archive int
EXEC sp_OAMethod @jResp, 'IntOf', @Ext_archive OUT, 'response.result.estimate.ext_archive'
DECLARE @Fname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fname OUT, 'response.result.estimate.fname'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'response.result.estimate.id'
DECLARE @Invoiced int
EXEC sp_OAMethod @jResp, 'BoolOf', @Invoiced OUT, 'response.result.estimate.invoiced'
DECLARE @Language nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Language OUT, 'response.result.estimate.language'
DECLARE @Lname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Lname OUT, 'response.result.estimate.lname'
DECLARE @Notes nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'response.result.estimate.notes'
DECLARE @Organization nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Organization OUT, 'response.result.estimate.organization'
DECLARE @Ownerid int
EXEC sp_OAMethod @jResp, 'IntOf', @Ownerid OUT, 'response.result.estimate.ownerid'
DECLARE @Po_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Po_number OUT, 'response.result.estimate.po_number'
DECLARE @Province nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Province OUT, 'response.result.estimate.province'
DECLARE @Reply_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Reply_status OUT, 'response.result.estimate.reply_status'
DECLARE @Require_client_signature int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_client_signature OUT, 'response.result.estimate.require_client_signature'
DECLARE @Rich_proposal int
EXEC sp_OAMethod @jResp, 'BoolOf', @Rich_proposal OUT, 'response.result.estimate.rich_proposal'
DECLARE @Sentid int
EXEC sp_OAMethod @jResp, 'IntOf', @Sentid OUT, 'response.result.estimate.sentid'
DECLARE @Status int
EXEC sp_OAMethod @jResp, 'IntOf', @Status OUT, 'response.result.estimate.status'
DECLARE @Street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street OUT, 'response.result.estimate.street'
DECLARE @Street2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street2 OUT, 'response.result.estimate.street2'
DECLARE @Template nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Template OUT, 'response.result.estimate.template'
DECLARE @Terms nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Terms OUT, 'response.result.estimate.terms'
DECLARE @Ui_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Ui_status OUT, 'response.result.estimate.ui_status'
DECLARE @Updated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated OUT, 'response.result.estimate.updated'
DECLARE @Vat_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_name OUT, 'response.result.estimate.vat_name'
DECLARE @Vat_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_number OUT, 'response.result.estimate.vat_number'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.estimate.vis_state'
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}}/estimates/estimates/{{estimateId}}
Postman Collection Item JSON
{
"name": "Single Estimate",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"response": [
{
"name": "Single Estimate",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBwZTVVQKCwdRU1MEBwVVSBwHH0AEBwcIUAxVCltRAwUGDFlVQx8EBVpEBDs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:57:15 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 17:57:15 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 \"estimate\": {\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 }\n}"
}
]
}
