SQL Server / New FreshBooks / Create Single Other Income
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
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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "other_income": {
-- "amount": {
-- "amount": "113.00",
-- "code": "USD"
-- },
-- "category_name": "online_sales",
-- "date": "2019-04-20",
-- "note": "Han Solo portrait",
-- "payment_type": "Visa",
-- "source": "Etsy",
-- "taxes": [
-- {
-- "amount": "3",
-- "name": "HST"
-- }
-- ]
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.amount.amount', '113.00'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.amount.code', 'USD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.category_name', 'online_sales'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.date', '2019-04-20'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.note', 'Han Solo portrait'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.payment_type', 'Visa'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.source', 'Etsy'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.taxes[0].amount', '3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'other_income.taxes[0].name', 'HST'
-- 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 @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes', 'application/json', @json
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
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @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 @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": {
-- "other_income": {
-- "amount": {
-- "amount": "113.00",
-- "code": "USD"
-- },
-- "category_name": "online_sales",
-- "created_at": "2019-04-24 14:20:41",
-- "date": "2019-04-20",
-- "incomeid": 2852,
-- "note": "Han Solo portrait",
-- "payment_type": "VISA",
-- "source": "Etsy",
-- "taxes": [
-- {
-- "amount": "3",
-- "name": "HST"
-- }
-- ],
-- "updated_at": "2019-04-24 14:20:41",
-- "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 @amount nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.other_income.amount.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.other_income.amount.code'
DECLARE @Category_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Category_name OUT, 'response.result.other_income.category_name'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'response.result.other_income.created_at'
DECLARE @Date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Date OUT, 'response.result.other_income.date'
DECLARE @Incomeid int
EXEC sp_OAMethod @jResp, 'IntOf', @Incomeid OUT, 'response.result.other_income.incomeid'
DECLARE @Note nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Note OUT, 'response.result.other_income.note'
DECLARE @Payment_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Payment_type OUT, 'response.result.other_income.payment_type'
DECLARE @Source nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Source OUT, 'response.result.other_income.source'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'response.result.other_income.updated_at'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.other_income.vis_state'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.other_income.taxes'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'response.result.other_income.taxes[i].amount'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'response.result.other_income.taxes[i].name'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"other_income": {
"amount": {
"amount": "113.00",
"code": "USD"
},
"category_name": "online_sales",
"date": "2019-04-20",
"note": "Han Solo portrait",
"payment_type": "Visa",
"source": "Etsy",
"taxes": [
{
"amount": "3",
"name": "HST"
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes
Postman Collection Item JSON
{
"name": "Create Single Other Income",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"date\": \"2019-04-20\",\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"Visa\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
},
"description": "This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks."
},
"response": [
{
"name": "Create Single Other Income",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"date\": \"2019-04-20\",\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"Visa\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BRRVNVk8IHQFRUVoHBgZSVgMDBFRfU1YDTgtQDBQWAANXCVMHVwdUBVQFAl5bXBEcAgAORFRq"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:20:41 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:20:41 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 \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"created_at\": \"2019-04-24 14:20:41\",\n \"date\": \"2019-04-20\",\n \"incomeid\": 2852,\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"VISA\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ],\n \"updated_at\": \"2019-04-24 14:20:41\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
