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.
; {
; "invoice": {
; "status": 2
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateInt("invoice.status",2)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",$oSbRequestBody,"utf-8","application/json",False,False)
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": {
; "invoice": {
; "accountid": "wkMd2g",
; "accounting_systemid": "wkMd2g",
; "address": "",
; "amount": {
; "amount": "180.00",
; "code": "USD"
; },
; "auto_bill": false,
; "autobill_status": null,
; "basecampid": 0,
; "city": "",
; "code": "",
; "country": "Canada",
; "create_date": "2019-04-20",
; "created_at": "2021-04-04 14:06:53",
; "currency_code": "USD",
; "current_organization": "first company",
; "customerid": 31006,
; "date_paid": null,
; "deposit_amount": null,
; "deposit_percentage": null,
; "deposit_status": "none",
; "description": "",
; "discount_description": null,
; "discount_total": {
; "amount": "0.00",
; "code": "USD"
; },
; "discount_value": "0",
; "display_status": "draft",
; "dispute_status": null,
; "due_date": "2019-04-20",
; "due_offset_days": 0,
; "estimateid": 0,
; "ext_archive": 0,
; "fname": "Nicolas",
; "fulfillment_date": null,
; "generation_date": null,
; "gmail": false,
; "id": 34420,
; "invoice_number": "0000013",
; "invoiceid": 34420,
; "language": "en",
; "last_order_status": null,
; "lname": "one",
; "notes": "",
; "organization": "first company",
; "outstanding": {
; "amount": "180.00",
; "code": "USD"
; },
; "ownerid": 1,
; "paid": {
; "amount": "0.00",
; "code": "USD"
; },
; "parent": 0,
; "payment_details": "",
; "payment_status": "unpaid",
; "po_number": null,
; "province": "",
; "return_uri": null,
; "sentid": 1,
; "show_attachments": true,
; "status": 1,
; "street": "",
; "street2": "",
; "template": "clean-grouped",
; "terms": "",
; "updated": "2019-04-24 14:06:53",
; "v3_status": "draft",
; "vat_name": "",
; "vat_number": "",
; "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
$oDate_paid = ObjCreate("Chilkat.DtObj")
Local $sAccountid = $oJResp.StringOf("response.result.invoice.accountid")
Local $sAccounting_systemid = $oJResp.StringOf("response.result.invoice.accounting_systemid")
Local $sAddress = $oJResp.StringOf("response.result.invoice.address")
Local $sAmount = $oJResp.StringOf("response.result.invoice.amount.amount")
Local $sCode = $oJResp.StringOf("response.result.invoice.amount.code")
Local $bAuto_bill = $oJResp.BoolOf("response.result.invoice.auto_bill")
Local $sAutobill_status = $oJResp.StringOf("response.result.invoice.autobill_status")
Local $iBasecampid = $oJResp.IntOf("response.result.invoice.basecampid")
Local $sCity = $oJResp.StringOf("response.result.invoice.city")
Local $sInvoiceCode = $oJResp.StringOf("response.result.invoice.code")
Local $sCountry = $oJResp.StringOf("response.result.invoice.country")
Local $sCreate_date = $oJResp.StringOf("response.result.invoice.create_date")
Local $sCreated_at = $oJResp.StringOf("response.result.invoice.created_at")
Local $sCurrency_code = $oJResp.StringOf("response.result.invoice.currency_code")
Local $sCurrent_organization = $oJResp.StringOf("response.result.invoice.current_organization")
Local $iCustomerid = $oJResp.IntOf("response.result.invoice.customerid")
$oJResp.DtOf("response.result.invoice.date_paid",False,$oDate_paid)
Local $sDeposit_amount = $oJResp.StringOf("response.result.invoice.deposit_amount")
Local $sDeposit_percentage = $oJResp.StringOf("response.result.invoice.deposit_percentage")
Local $sDeposit_status = $oJResp.StringOf("response.result.invoice.deposit_status")
Local $sDescription = $oJResp.StringOf("response.result.invoice.description")
Local $sDiscount_description = $oJResp.StringOf("response.result.invoice.discount_description")
Local $sDiscount_totalAmount = $oJResp.StringOf("response.result.invoice.discount_total.amount")
Local $sDiscount_totalCode = $oJResp.StringOf("response.result.invoice.discount_total.code")
Local $sDiscount_value = $oJResp.StringOf("response.result.invoice.discount_value")
Local $sDisplay_status = $oJResp.StringOf("response.result.invoice.display_status")
Local $sDispute_status = $oJResp.StringOf("response.result.invoice.dispute_status")
Local $sDue_date = $oJResp.StringOf("response.result.invoice.due_date")
Local $iDue_offset_days = $oJResp.IntOf("response.result.invoice.due_offset_days")
Local $iEstimateid = $oJResp.IntOf("response.result.invoice.estimateid")
Local $iExt_archive = $oJResp.IntOf("response.result.invoice.ext_archive")
Local $sFname = $oJResp.StringOf("response.result.invoice.fname")
Local $sFulfillment_date = $oJResp.StringOf("response.result.invoice.fulfillment_date")
Local $sGeneration_date = $oJResp.StringOf("response.result.invoice.generation_date")
Local $bGmail = $oJResp.BoolOf("response.result.invoice.gmail")
Local $iId = $oJResp.IntOf("response.result.invoice.id")
Local $sInvoice_number = $oJResp.StringOf("response.result.invoice.invoice_number")
Local $iInvoiceid = $oJResp.IntOf("response.result.invoice.invoiceid")
Local $sLanguage = $oJResp.StringOf("response.result.invoice.language")
Local $sLast_order_status = $oJResp.StringOf("response.result.invoice.last_order_status")
Local $sLname = $oJResp.StringOf("response.result.invoice.lname")
Local $sNotes = $oJResp.StringOf("response.result.invoice.notes")
Local $sOrganization = $oJResp.StringOf("response.result.invoice.organization")
Local $sOutstandingAmount = $oJResp.StringOf("response.result.invoice.outstanding.amount")
Local $sOutstandingCode = $oJResp.StringOf("response.result.invoice.outstanding.code")
Local $iOwnerid = $oJResp.IntOf("response.result.invoice.ownerid")
Local $sPaidAmount = $oJResp.StringOf("response.result.invoice.paid.amount")
Local $sPaidCode = $oJResp.StringOf("response.result.invoice.paid.code")
Local $iParent = $oJResp.IntOf("response.result.invoice.parent")
Local $sPayment_details = $oJResp.StringOf("response.result.invoice.payment_details")
Local $sPayment_status = $oJResp.StringOf("response.result.invoice.payment_status")
Local $sPo_number = $oJResp.StringOf("response.result.invoice.po_number")
Local $sProvince = $oJResp.StringOf("response.result.invoice.province")
Local $sReturn_uri = $oJResp.StringOf("response.result.invoice.return_uri")
Local $iSentid = $oJResp.IntOf("response.result.invoice.sentid")
Local $bShow_attachments = $oJResp.BoolOf("response.result.invoice.show_attachments")
Local $iStatus = $oJResp.IntOf("response.result.invoice.status")
Local $sStreet = $oJResp.StringOf("response.result.invoice.street")
Local $sStreet2 = $oJResp.StringOf("response.result.invoice.street2")
Local $sTemplate = $oJResp.StringOf("response.result.invoice.template")
Local $sTerms = $oJResp.StringOf("response.result.invoice.terms")
Local $sUpdated = $oJResp.StringOf("response.result.invoice.updated")
Local $sV3_status = $oJResp.StringOf("response.result.invoice.v3_status")
Local $sVat_name = $oJResp.StringOf("response.result.invoice.vat_name")
Local $sVat_number = $oJResp.StringOf("response.result.invoice.vat_number")
Local $iVis_state = $oJResp.IntOf("response.result.invoice.vis_state")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice": {
"status": 2
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}
Postman Collection Item JSON
{
"name": "Update Invoice",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"status\": 2\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
},
"description": "- If the invoice line items have inventory tracking enabled (See Items and Services > Create Item), the relevant inventory amount will be adjusted accordingly when the invoice is updated:\n\t\titem new inventory = item current inventory + delta of invoice line item old quantity and new quantity"
},
"response": [
{
"name": "Update Invoice",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"create_date\": \"2021-04-04\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"status": "BAD REQUEST",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPA1tXBQ9UUlYPCglWVFcEBgZKUQgaEQBSAABWA1sAWg0ECgtRDgQTTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "253"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:09:48 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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 1005,\n \"field\": null,\n \"message\": \"Expecting property name enclosed in double quotes: line 4 column 2 (char 56)\",\n \"object\": null,\n \"value\": null\n }\n ]\n }\n}"
},
{
"name": "Update Invoice",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"create_date\": \"2021-04-04\"\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPAlNWAAVTUloBBwZRWFYFAg9KUQkaEQFTU1sHAAAGWw4FCwZQXVcTTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:10:19 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:10:19 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 \"invoice\": {\n \"accountid\": \"wkMd2g\",\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2021-04-04 14:06:53\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"\",\n \"discount_description\": null,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Nicolas\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 34420,\n \"invoice_number\": \"0000013\",\n \"invoiceid\": 34420,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"one\",\n \"notes\": \"\",\n \"organization\": \"first company\",\n \"outstanding\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 1,\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"parent\": 0,\n \"payment_details\": \"\",\n \"payment_status\": \"unpaid\",\n \"po_number\": null,\n \"province\": \"\",\n \"return_uri\": null,\n \"sentid\": 1,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-04-24 14:06:53\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
},
{
"name": "Update Invoice - Status",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"status\": 2\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPAFRRAgVSVFMKBgFQV1YPBQNKVwUaEVIHVgECBAsGXQoGVgcACVYTTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Sun, 29 Apr 2018 20:45:54 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": "Mon, 29 Apr 2019 20:45:54 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17322-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 \"invoice\": {\n \"accountid\": \"wkMd2g\",\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-04-29 16:27:57\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"\",\n \"discount_description\": null,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"sent\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Nicolas\",\n \"fulfillment_date\": \"2019-04-20\",\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 45232,\n \"invoice_number\": \"0000020\",\n \"invoiceid\": 45232,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"one\",\n \"notes\": \"\",\n \"organization\": \"first company\",\n \"outstanding\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 1,\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"parent\": 0,\n \"payment_details\": \"\",\n \"payment_status\": \"unpaid\",\n \"po_number\": null,\n \"province\": \"\",\n \"return_uri\": null,\n \"sentid\": 1,\n \"show_attachments\": true,\n \"status\": 2,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-04-29 16:45:54\",\n \"v3_status\": \"overdue\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
