autoit / New FreshBooks / Create Expense with Receipt
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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": {
; "transactionid": null,
; "status": null,
; "has_receipt": false,
; "always_remember": false,
; "is_cogs": false,
; "account_name": null,
; "include_receipt": false,
; "amount": {
; "amount": "79.73",
; "code": "USD"
; },
; "notes": "Purchased Gasoline for deliveries",
; "vendor": "Shell Gas Station",
; "date": "2019-04-24",
; "staffid": 1,
; "author_name": null,
; "taxName1": "other tax",
; "taxName2": null,
; "taxAmount1": {
; "amount": "9.17",
; "code": "USD"
; },
; "taxPercent1": 13,
; "taxPercent2": null,
; "markup_percent": null,
; "invoiceid": null,
; "attachment": {
; "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
; "media_type": "image/png",
; "expenseid": null
; },
; "categoryid": "2003174",
; "clientid": null
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateNull("expense.transactionid")
$oJson.UpdateNull("expense.status")
$oJson.UpdateBool("expense.has_receipt",False)
$oJson.UpdateBool("expense.always_remember",False)
$oJson.UpdateBool("expense.is_cogs",False)
$oJson.UpdateNull("expense.account_name")
$oJson.UpdateBool("expense.include_receipt",False)
$oJson.UpdateString("expense.amount.amount","79.73")
$oJson.UpdateString("expense.amount.code","USD")
$oJson.UpdateString("expense.notes","Purchased Gasoline for deliveries")
$oJson.UpdateString("expense.vendor","Shell Gas Station")
$oJson.UpdateString("expense.date","2019-04-24")
$oJson.UpdateInt("expense.staffid",1)
$oJson.UpdateNull("expense.author_name")
$oJson.UpdateString("expense.taxName1","other tax")
$oJson.UpdateNull("expense.taxName2")
$oJson.UpdateString("expense.taxAmount1.amount","9.17")
$oJson.UpdateString("expense.taxAmount1.code","USD")
$oJson.UpdateInt("expense.taxPercent1",13)
$oJson.UpdateNull("expense.taxPercent2")
$oJson.UpdateNull("expense.markup_percent")
$oJson.UpdateNull("expense.invoiceid")
$oJson.UpdateString("expense.attachment.jwt","eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA")
$oJson.UpdateString("expense.attachment.media_type","image/png")
$oJson.UpdateNull("expense.attachment.expenseid")
$oJson.UpdateString("expense.categoryid","2003174")
$oJson.UpdateNull("expense.clientid")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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"
; },
; "attachment": {
; "attachmentid": 8670,
; "id": 8670,
; "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
; "media_type": "image/png"
; },
; "background_jobid": null,
; "bank_name": "",
; "categoryid": 2003174,
; "clientid": 0,
; "compounded_tax": false,
; "date": "2019-04-24",
; "expenseid": 1825574,
; "ext_invoiceid": 0,
; "ext_systemid": 0,
; "from_bulk_import": false,
; "has_receipt": true,
; "id": 1825574,
; "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-04-24 11:33:35",
; "vendor": "Shell Gas Station",
; "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
Local $sAccount_name = $oJResp.StringOf("response.result.expense.account_name")
Local $sAccountid = $oJResp.StringOf("response.result.expense.accountid")
Local $sAccounting_systemid = $oJResp.StringOf("response.result.expense.accounting_systemid")
Local $sAmount = $oJResp.StringOf("response.result.expense.amount.amount")
Local $sCode = $oJResp.StringOf("response.result.expense.amount.code")
Local $iAttachmentid = $oJResp.IntOf("response.result.expense.attachment.attachmentid")
Local $iId = $oJResp.IntOf("response.result.expense.attachment.id")
Local $sV_Jwt = $oJResp.StringOf("response.result.expense.attachment.jwt")
Local $sMedia_type = $oJResp.StringOf("response.result.expense.attachment.media_type")
Local $sBackground_jobid = $oJResp.StringOf("response.result.expense.background_jobid")
Local $sBank_name = $oJResp.StringOf("response.result.expense.bank_name")
Local $iCategoryid = $oJResp.IntOf("response.result.expense.categoryid")
Local $iClientid = $oJResp.IntOf("response.result.expense.clientid")
Local $bCompounded_tax = $oJResp.BoolOf("response.result.expense.compounded_tax")
Local $sDate = $oJResp.StringOf("response.result.expense.date")
Local $iExpenseid = $oJResp.IntOf("response.result.expense.expenseid")
Local $iExt_invoiceid = $oJResp.IntOf("response.result.expense.ext_invoiceid")
Local $iExt_systemid = $oJResp.IntOf("response.result.expense.ext_systemid")
Local $bFrom_bulk_import = $oJResp.BoolOf("response.result.expense.from_bulk_import")
Local $bHas_receipt = $oJResp.BoolOf("response.result.expense.has_receipt")
Local $iExpenseId = $oJResp.IntOf("response.result.expense.id")
Local $bInclude_receipt = $oJResp.BoolOf("response.result.expense.include_receipt")
Local $sInvoiceid = $oJResp.StringOf("response.result.expense.invoiceid")
Local $bIs_cogs = $oJResp.BoolOf("response.result.expense.is_cogs")
Local $bIsduplicate = $oJResp.BoolOf("response.result.expense.isduplicate")
Local $sMarkup_percent = $oJResp.StringOf("response.result.expense.markup_percent")
Local $sNotes = $oJResp.StringOf("response.result.expense.notes")
Local $sProfileid = $oJResp.StringOf("response.result.expense.profileid")
Local $iProjectid = $oJResp.IntOf("response.result.expense.projectid")
Local $iStaffid = $oJResp.IntOf("response.result.expense.staffid")
Local $iStatus = $oJResp.IntOf("response.result.expense.status")
Local $sTaxAmount1Amount = $oJResp.StringOf("response.result.expense.taxAmount1.amount")
Local $sTaxAmount1Code = $oJResp.StringOf("response.result.expense.taxAmount1.code")
Local $sTaxAmount2 = $oJResp.StringOf("response.result.expense.taxAmount2")
Local $sTaxName1 = $oJResp.StringOf("response.result.expense.taxName1")
Local $sTaxName2 = $oJResp.StringOf("response.result.expense.taxName2")
Local $sTaxPercent1 = $oJResp.StringOf("response.result.expense.taxPercent1")
Local $sTaxPercent2 = $oJResp.StringOf("response.result.expense.taxPercent2")
Local $sTransactionid = $oJResp.StringOf("response.result.expense.transactionid")
Local $sUpdated = $oJResp.StringOf("response.result.expense.updated")
Local $sVendor = $oJResp.StringOf("response.result.expense.vendor")
Local $iVis_state = $oJResp.IntOf("response.result.expense.vis_state")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"expense": {
"transactionid": null,
"status": null,
"has_receipt": false,
"always_remember": false,
"is_cogs": false,
"account_name": null,
"include_receipt": false,
"amount": {
"amount": "79.73",
"code": "USD"
},
"notes": "Purchased Gasoline for deliveries",
"vendor": "Shell Gas Station",
"date": "2019-04-24",
"staffid": 1,
"author_name": null,
"taxName1": "other tax",
"taxName2": null,
"taxAmount1": {
"amount": "9.17",
"code": "USD"
},
"taxPercent1": 13,
"taxPercent2": null,
"markup_percent": null,
"invoiceid": null,
"attachment": {
"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
"media_type": "image/png",
"expenseid": null
},
"categoryid": "2003174",
"clientid": null
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment
Postman Collection Item JSON
{
"name": "Create Expense with Receipt",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"transactionid\": null,\n \"status\": null,\n \"has_receipt\": false,\n \"always_remember\": false,\n \"is_cogs\": false,\n \"account_name\": null,\n \"include_receipt\": false,\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"vendor\": \"Shell Gas Station\",\n \"date\": \"2019-04-24\",\n \"staffid\": 1,\n \"author_name\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxPercent1\": 13,\n \"taxPercent2\": null,\n \"markup_percent\": null,\n \"invoiceid\": null,\n \"attachment\": {\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\",\n \"expenseid\": null\n },\n \"categoryid\": \"2003174\",\n \"clientid\": null\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses"
],
"query": [
{
"key": "include%5B%5D",
"value": "attachment"
}
]
},
"description": "In order to create an expense with a receipt, you will first need to upload your image via the uploader endpoint. Once you receive a response, you can apply that `jwt` token to your expense under the nested `attachment` object. Look at the example on the right. "
},
"response": [
{
"name": "Create Expense",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"transactionid\": null,\n \"status\": null,\n \"has_receipt\": false,\n \"always_remember\": false,\n \"is_cogs\": false,\n \"account_name\": null,\n \"include_receipt\": false,\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"vendor\": \"Shell Gas Station\",\n \"date\": \"2019-04-24\",\n \"staffid\": 1,\n \"author_name\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxPercent1\": 13,\n \"taxPercent2\": null,\n \"markup_percent\": null,\n \"invoiceid\": null,\n \"attachment\": {\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\",\n \"expenseid\": null\n },\n \"categoryid\": \"2003174\",\n \"clientid\": null\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses"
],
"query": [
{
"key": "include%5B%5D",
"value": "attachment"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoHQBJdVkdXQEcVUR1RHVBVBQBZU1UMCwNQVFsDBgVRSAAFBVBKQVFWUwEACAkBCgJcCFQBAAtASFBWDRUGZQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 15:33:35 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 15:33:35 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-jfk8129-JFK"
},
{
"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 \"attachment\": {\n \"attachmentid\": 8670,\n \"id\": 8670,\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\"\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\": 1825574,\n \"ext_invoiceid\": 0,\n \"ext_systemid\": 0,\n \"from_bulk_import\": false,\n \"has_receipt\": true,\n \"id\": 1825574,\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-04-24 11:33:35\",\n \"vendor\": \"Shell Gas Station\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
