Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccount_name
String sAccountid
String sAccounting_systemid
String sAmount
String sCode
String sBackground_jobid
String sBank_name
Integer iCategoryid
Integer iClientid
Boolean iCompounded_tax
String sDate
Integer iExpenseid
Integer iExt_invoiceid
Integer iExt_systemid
Boolean iFrom_bulk_import
Boolean iHas_receipt
Integer iId
Boolean iInclude_receipt
String sInvoiceid
Boolean iIs_cogs
Boolean iIsduplicate
String sMarkup_percent
String sNotes
String sProfileid
Integer iProjectid
Integer iStaffid
Integer iStatus
String sTaxAmount1Amount
String sTaxAmount1Code
String sTaxAmount2
String sTaxName1
String sTaxName2
String sTaxPercent1
String sTaxPercent2
String sTransactionid
String sUpdated
String sVendor
Integer iVis_state
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "expense.vendor" "WestJet" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "response.result.expense.account_name" To sAccount_name
Get ComStringOf Of hoJResp "response.result.expense.accountid" To sAccountid
Get ComStringOf Of hoJResp "response.result.expense.accounting_systemid" To sAccounting_systemid
Get ComStringOf Of hoJResp "response.result.expense.amount.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.expense.amount.code" To sCode
Get ComStringOf Of hoJResp "response.result.expense.background_jobid" To sBackground_jobid
Get ComStringOf Of hoJResp "response.result.expense.bank_name" To sBank_name
Get ComIntOf Of hoJResp "response.result.expense.categoryid" To iCategoryid
Get ComIntOf Of hoJResp "response.result.expense.clientid" To iClientid
Get ComBoolOf Of hoJResp "response.result.expense.compounded_tax" To iCompounded_tax
Get ComStringOf Of hoJResp "response.result.expense.date" To sDate
Get ComIntOf Of hoJResp "response.result.expense.expenseid" To iExpenseid
Get ComIntOf Of hoJResp "response.result.expense.ext_invoiceid" To iExt_invoiceid
Get ComIntOf Of hoJResp "response.result.expense.ext_systemid" To iExt_systemid
Get ComBoolOf Of hoJResp "response.result.expense.from_bulk_import" To iFrom_bulk_import
Get ComBoolOf Of hoJResp "response.result.expense.has_receipt" To iHas_receipt
Get ComIntOf Of hoJResp "response.result.expense.id" To iId
Get ComBoolOf Of hoJResp "response.result.expense.include_receipt" To iInclude_receipt
Get ComStringOf Of hoJResp "response.result.expense.invoiceid" To sInvoiceid
Get ComBoolOf Of hoJResp "response.result.expense.is_cogs" To iIs_cogs
Get ComBoolOf Of hoJResp "response.result.expense.isduplicate" To iIsduplicate
Get ComStringOf Of hoJResp "response.result.expense.markup_percent" To sMarkup_percent
Get ComStringOf Of hoJResp "response.result.expense.notes" To sNotes
Get ComStringOf Of hoJResp "response.result.expense.profileid" To sProfileid
Get ComIntOf Of hoJResp "response.result.expense.projectid" To iProjectid
Get ComIntOf Of hoJResp "response.result.expense.staffid" To iStaffid
Get ComIntOf Of hoJResp "response.result.expense.status" To iStatus
Get ComStringOf Of hoJResp "response.result.expense.taxAmount1.amount" To sTaxAmount1Amount
Get ComStringOf Of hoJResp "response.result.expense.taxAmount1.code" To sTaxAmount1Code
Get ComStringOf Of hoJResp "response.result.expense.taxAmount2" To sTaxAmount2
Get ComStringOf Of hoJResp "response.result.expense.taxName1" To sTaxName1
Get ComStringOf Of hoJResp "response.result.expense.taxName2" To sTaxName2
Get ComStringOf Of hoJResp "response.result.expense.taxPercent1" To sTaxPercent1
Get ComStringOf Of hoJResp "response.result.expense.taxPercent2" To sTaxPercent2
Get ComStringOf Of hoJResp "response.result.expense.transactionid" To sTransactionid
Get ComStringOf Of hoJResp "response.result.expense.updated" To sUpdated
Get ComStringOf Of hoJResp "response.result.expense.vendor" To sVendor
Get ComIntOf Of hoJResp "response.result.expense.vis_state" To iVis_state
End_Procedure
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}"
}
]
}
