SQL Server / New FreshBooks / Update Credit Note
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.
-- {
-- "credit_note": {
-- "credit_number": "0000066",
-- "currency_code": "CAD",
-- "create_date": "2020-08-04",
-- "notes": "",
-- "credit_type": "goodwill",
-- "terms": null,
-- "language": "en",
-- "lines": [
-- {
-- "id": "20405-1",
-- "name": "Credit",
-- "description": "Free Voucher",
-- "taxName1": null,
-- "taxAmount1": 0,
-- "taxName2": null,
-- "taxAmount2": 0,
-- "compounded_tax": false,
-- "qty": 1,
-- "unit_cost": {
-- "amount": "50",
-- "code": "CAD"
-- }
-- },
-- {
-- "name": "Credit",
-- "description": "More voucher",
-- "taxName1": null,
-- "taxAmount1": null,
-- "taxName2": null,
-- "taxAmount2": null,
-- "compounded_tax": false,
-- "qty": 1,
-- "unit_cost": {
-- "amount": "100",
-- "code": "CAD"
-- }
-- }
-- ],
-- "clientid": 123
-- }
-- }
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, 'credit_note.credit_number', '0000066'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.currency_code', 'CAD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.create_date', '2020-08-04'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.notes', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.credit_type', 'goodwill'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.terms'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.language', 'en'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[0].id', '20405-1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[0].name', 'Credit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[0].description', 'Free Voucher'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[0].taxName1'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_note.lines[0].taxAmount1', 0
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[0].taxName2'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_note.lines[0].taxAmount2', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'credit_note.lines[0].compounded_tax', 0
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_note.lines[0].qty', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[0].unit_cost.amount', '50'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[0].unit_cost.code', 'CAD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[1].name', 'Credit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[1].description', 'More voucher'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[1].taxName1'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[1].taxAmount1'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[1].taxName2'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'credit_note.lines[1].taxAmount2'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'credit_note.lines[1].compounded_tax', 0
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_note.lines[1].qty', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[1].unit_cost.amount', '100'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'credit_note.lines[1].unit_cost.code', 'CAD'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'credit_note.clientid', 123
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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}}/credit_notes/credit_notes/{{creditnote}}', @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
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"credit_note": {
"credit_number": "0000066",
"currency_code": "CAD",
"create_date": "2020-08-04",
"notes": "",
"credit_type": "goodwill",
"terms": null,
"language": "en",
"lines": [
{
"id": "20405-1",
"name": "Credit",
"description": "Free Voucher",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "50",
"code": "CAD"
}
},
{
"name": "Credit",
"description": "More voucher",
"taxName1": null,
"taxAmount1": null,
"taxName2": null,
"taxAmount2": null,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "100",
"code": "CAD"
}
}
],
"clientid": {{clientId}}
}
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}
Postman Collection Item JSON
{
"name": "Update Credit Note",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"credit_number\": \"0000066\",\n \"currency_code\": \"CAD\",\n \"create_date\": \"2020-08-04\",\n \"notes\": \"\",\n \"credit_type\": \"goodwill\",\n \"terms\": null,\n \"language\": \"en\",\n \"lines\": [\n {\n \"id\": \"20405-1\",\n \"name\": \"Credit\",\n \"description\": \"Free Voucher\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"50\",\n \"code\": \"CAD\"\n }\n },\n {\n \"name\": \"Credit\",\n \"description\": \"More voucher\",\n \"taxName1\": null,\n \"taxAmount1\": null,\n \"taxName2\": null,\n \"taxAmount2\": null,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"100\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"clientid\": {{clientId}}\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountid}}",
"credit_notes",
"credit_notes",
"{{creditnote}}"
]
}
},
"response": [
]
}
