SQL Server / New FreshBooks / Update Expense
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
DECLARE @iTmp0 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "expense": {
-- "vendor": "WestJet"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'expense.vendor', 'WestJet'
-- 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 @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
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 @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "response": {
-- "result": {
-- "expense": {
-- "account_name": "",
-- "accountid": null,
-- "accounting_systemid": "wkMd2g",
-- "amount": {
-- "amount": "79.73",
-- "code": "USD"
-- },
-- "background_jobid": null,
-- "bank_name": "",
-- "categoryid": 2003174,
-- "clientid": 0,
-- "compounded_tax": false,
-- "date": "2019-04-24",
-- "expenseid": 1825568,
-- "ext_invoiceid": 0,
-- "ext_systemid": 0,
-- "from_bulk_import": false,
-- "has_receipt": true,
-- "id": 1825568,
-- "include_receipt": false,
-- "invoiceid": null,
-- "is_cogs": false,
-- "isduplicate": true,
-- "markup_percent": "0",
-- "notes": "Purchased Gasoline for deliveries",
-- "profileid": null,
-- "projectid": 0,
-- "staffid": 1,
-- "status": 0,
-- "taxAmount1": {
-- "amount": "9.17",
-- "code": "USD"
-- },
-- "taxAmount2": null,
-- "taxName1": "other tax",
-- "taxName2": null,
-- "taxPercent1": "13",
-- "taxPercent2": null,
-- "transactionid": null,
-- "updated": "2019-05-08 16:03:24",
-- "vendor": "WestJet",
-- "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 @Account_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Account_name OUT, 'response.result.expense.account_name'
DECLARE @Accountid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accountid OUT, 'response.result.expense.accountid'
DECLARE @Accounting_systemid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accounting_systemid OUT, 'response.result.expense.accounting_systemid'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.expense.amount.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.expense.amount.code'
DECLARE @Background_jobid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Background_jobid OUT, 'response.result.expense.background_jobid'
DECLARE @Bank_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Bank_name OUT, 'response.result.expense.bank_name'
DECLARE @Categoryid int
EXEC sp_OAMethod @jResp, 'IntOf', @Categoryid OUT, 'response.result.expense.categoryid'
DECLARE @Clientid int
EXEC sp_OAMethod @jResp, 'IntOf', @Clientid OUT, 'response.result.expense.clientid'
DECLARE @Compounded_tax int
EXEC sp_OAMethod @jResp, 'BoolOf', @Compounded_tax OUT, 'response.result.expense.compounded_tax'
DECLARE @Date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Date OUT, 'response.result.expense.date'
DECLARE @Expenseid int
EXEC sp_OAMethod @jResp, 'IntOf', @Expenseid OUT, 'response.result.expense.expenseid'
DECLARE @Ext_invoiceid int
EXEC sp_OAMethod @jResp, 'IntOf', @Ext_invoiceid OUT, 'response.result.expense.ext_invoiceid'
DECLARE @Ext_systemid int
EXEC sp_OAMethod @jResp, 'IntOf', @Ext_systemid OUT, 'response.result.expense.ext_systemid'
DECLARE @From_bulk_import int
EXEC sp_OAMethod @jResp, 'BoolOf', @From_bulk_import OUT, 'response.result.expense.from_bulk_import'
DECLARE @Has_receipt int
EXEC sp_OAMethod @jResp, 'BoolOf', @Has_receipt OUT, 'response.result.expense.has_receipt'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'response.result.expense.id'
DECLARE @Include_receipt int
EXEC sp_OAMethod @jResp, 'BoolOf', @Include_receipt OUT, 'response.result.expense.include_receipt'
DECLARE @Invoiceid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Invoiceid OUT, 'response.result.expense.invoiceid'
DECLARE @Is_cogs int
EXEC sp_OAMethod @jResp, 'BoolOf', @Is_cogs OUT, 'response.result.expense.is_cogs'
DECLARE @Isduplicate int
EXEC sp_OAMethod @jResp, 'BoolOf', @Isduplicate OUT, 'response.result.expense.isduplicate'
DECLARE @Markup_percent nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Markup_percent OUT, 'response.result.expense.markup_percent'
DECLARE @Notes nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Notes OUT, 'response.result.expense.notes'
DECLARE @Profileid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Profileid OUT, 'response.result.expense.profileid'
DECLARE @Projectid int
EXEC sp_OAMethod @jResp, 'IntOf', @Projectid OUT, 'response.result.expense.projectid'
DECLARE @Staffid int
EXEC sp_OAMethod @jResp, 'IntOf', @Staffid OUT, 'response.result.expense.staffid'
DECLARE @Status int
EXEC sp_OAMethod @jResp, 'IntOf', @Status OUT, 'response.result.expense.status'
DECLARE @TaxAmount1Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxAmount1Amount OUT, 'response.result.expense.taxAmount1.amount'
DECLARE @TaxAmount1Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxAmount1Code OUT, 'response.result.expense.taxAmount1.code'
DECLARE @TaxAmount2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxAmount2 OUT, 'response.result.expense.taxAmount2'
DECLARE @TaxName1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxName1 OUT, 'response.result.expense.taxName1'
DECLARE @TaxName2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxName2 OUT, 'response.result.expense.taxName2'
DECLARE @TaxPercent1 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxPercent1 OUT, 'response.result.expense.taxPercent1'
DECLARE @TaxPercent2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TaxPercent2 OUT, 'response.result.expense.taxPercent2'
DECLARE @Transactionid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Transactionid OUT, 'response.result.expense.transactionid'
DECLARE @Updated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated OUT, 'response.result.expense.updated'
DECLARE @Vendor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vendor OUT, 'response.result.expense.vendor'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.expense.vis_state'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"expense": {
"vendor": "WestJet"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}
Postman Collection Item JSON
{
"name": "Update Expense",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"vendor\": \"WestJet\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses",
"{{expenseId}}"
]
}
},
"response": [
{
"name": "Update Expense",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"vendor\": \"WestJet\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses",
"{{expenseId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoHQBJdVkdXEUkJTQFPAVRRDwZYUFsNAAZXVlQOBARKUAcaEVJWUAEHUwtUXl0GUAdSCAcTTVUDCEVSPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557345847"
},
{
"key": "Retry-After",
"value": "42"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:03:24 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, 08 May 2019 20:03:24 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 \"expense\": {\n \"account_name\": \"\",\n \"accountid\": null,\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"background_jobid\": null,\n \"bank_name\": \"\",\n \"categoryid\": 2003174,\n \"clientid\": 0,\n \"compounded_tax\": false,\n \"date\": \"2019-04-24\",\n \"expenseid\": 1825568,\n \"ext_invoiceid\": 0,\n \"ext_systemid\": 0,\n \"from_bulk_import\": false,\n \"has_receipt\": true,\n \"id\": 1825568,\n \"include_receipt\": false,\n \"invoiceid\": null,\n \"is_cogs\": false,\n \"isduplicate\": true,\n \"markup_percent\": \"0\",\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"profileid\": null,\n \"projectid\": 0,\n \"staffid\": 1,\n \"status\": 0,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxAmount2\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxPercent1\": \"13\",\n \"taxPercent2\": null,\n \"transactionid\": null,\n \"updated\": \"2019-05-08 16:03:24\",\n \"vendor\": \"WestJet\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
