SQL Server / New FreshBooks / Create Invoice with 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.
-- {
-- "invoice": {
-- "customerid": 485558,
-- "create_date": "2019-06-20",
-- "lines": [
-- {
-- "type": 0,
-- "description": "",
-- "taxName1": "",
-- "taxAmount1": 0,
-- "name": "Paperwork",
-- "qty": 1,
-- "taxName2": "",
-- "taxAmount2": 0,
-- "unit_cost": {
-- "amount": "5000.00",
-- "code": "USD"
-- }
-- },
-- {
-- "type": 1,
-- "description": "Gas",
-- "expenseid": 123,
-- "taxName1": "",
-- "taxAmount1": 0,
-- "name": "Shell Oil",
-- "qty": 1,
-- "taxName2": "",
-- "taxAmount2": 0,
-- "unit_cost": {
-- "amount": "120.00",
-- "code": "USD"
-- }
-- }
-- ]
-- }
-- }
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, 'UpdateInt', @success OUT, 'invoice.customerid', 485558
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.create_date', '2019-06-20'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[0].type', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].description', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].taxName1', ''
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[0].taxAmount1', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].name', 'Paperwork'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[0].qty', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].taxName2', ''
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[0].taxAmount2', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].unit_cost.amount', '5000.00'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[0].unit_cost.code', 'USD'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[1].type', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].description', 'Gas'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[1].expenseid', 123
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].taxName1', ''
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[1].taxAmount1', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].name', 'Shell Oil'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[1].qty', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].taxName2', ''
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'invoice.lines[1].taxAmount2', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].unit_cost.amount', '120.00'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'invoice.lines[1].unit_cost.code', 'USD'
-- 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}}/invoices/invoices', '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
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
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice": {
"customerid": 485558,
"create_date": "2019-06-20",
"lines": [
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Paperwork",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "5000.00",
"code": "USD"
}
},
{
"type": 1,
"description": "Gas",
"expenseid": {{expenseId}},
"taxName1": "",
"taxAmount1": 0,
"name": "Shell Oil",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "120.00",
"code": "USD"
}
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices
Postman Collection Item JSON
{
"name": "Create Invoice with Expense ",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice\": {\n \"customerid\": 485558,\n \"create_date\": \"2019-06-20\",\n \"lines\": [\n {\n \"type\": 0,\n \"description\": \"\",\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Paperwork\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"5000.00\",\n \"code\": \"USD\"\n }\n },\n {\n \"type\": 1,\n \"description\": \"Gas\",\n \"expenseid\": {{expenseId}},\n \"taxName1\": \"\",\n \"taxAmount1\": 0,\n \"name\": \"Shell Oil\",\n \"qty\": 1,\n \"taxName2\": \"\",\n \"taxAmount2\": 0,\n \"unit_cost\": {\n \"amount\": \"120.00\",\n \"code\": \"USD\"\n }\n }\n ]\n }\n}\n"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices"
]
},
"description": "Creating invoice with expense.\n\nFirst you will need to create an expense. Once that is created, save the expenseId and add it to the invoice. \n\nWhen adding an expense, make sure you add to the `markup_percent` parameter the amount you want to markup by and set `cogs` to `true` if it is an item you have paid for. "
},
"response": [
]
}
