TCL / New FreshBooks / Single Invoice w/ Payment Gateway
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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": 123,
# "create_date": "2019-04-20",
# "lines": [
# {
# "type": 0,
# "description": "",
# "taxName1": "",
# "taxAmount1": 0,
# "name": "Climbing Helmet",
# "qty": 1,
# "taxName2": "",
# "taxAmount2": 0,
# "unit_cost": {
# "amount": "80.00",
# "code": "USD"
# }
# },
# {
# "type": 0,
# "description": "",
# "taxName1": "",
# "taxAmount1": 0,
# "name": "Belay Device",
# "qty": 1,
# "taxName2": "",
# "taxAmount2": 0,
# "unit_cost": {
# "amount": "100.00",
# "code": "USD"
# }
# }
# ],
# "presentation": {
# "image_logo_src": "{{image_logo_src}}",
# "theme_primary_color": "{{theme_primary_color}}"
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateInt $json "invoice.customerid" 123
CkJsonObject_UpdateString $json "invoice.create_date" "2019-04-20"
CkJsonObject_UpdateInt $json "invoice.lines[0].type" 0
CkJsonObject_UpdateString $json "invoice.lines[0].description" ""
CkJsonObject_UpdateString $json "invoice.lines[0].taxName1" ""
CkJsonObject_UpdateInt $json "invoice.lines[0].taxAmount1" 0
CkJsonObject_UpdateString $json "invoice.lines[0].name" "Climbing Helmet"
CkJsonObject_UpdateInt $json "invoice.lines[0].qty" 1
CkJsonObject_UpdateString $json "invoice.lines[0].taxName2" ""
CkJsonObject_UpdateInt $json "invoice.lines[0].taxAmount2" 0
CkJsonObject_UpdateString $json "invoice.lines[0].unit_cost.amount" "80.00"
CkJsonObject_UpdateString $json "invoice.lines[0].unit_cost.code" "USD"
CkJsonObject_UpdateInt $json "invoice.lines[1].type" 0
CkJsonObject_UpdateString $json "invoice.lines[1].description" ""
CkJsonObject_UpdateString $json "invoice.lines[1].taxName1" ""
CkJsonObject_UpdateInt $json "invoice.lines[1].taxAmount1" 0
CkJsonObject_UpdateString $json "invoice.lines[1].name" "Belay Device"
CkJsonObject_UpdateInt $json "invoice.lines[1].qty" 1
CkJsonObject_UpdateString $json "invoice.lines[1].taxName2" ""
CkJsonObject_UpdateInt $json "invoice.lines[1].taxAmount2" 0
CkJsonObject_UpdateString $json "invoice.lines[1].unit_cost.amount" "100.00"
CkJsonObject_UpdateString $json "invoice.lines[1].unit_cost.code" "USD"
CkJsonObject_UpdateString $json "invoice.presentation.image_logo_src" "{{image_logo_src}}"
CkJsonObject_UpdateString $json "invoice.presentation.theme_primary_color" "{{theme_primary_color}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceid}}?include%5B%5D=allowed_gateways" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "invoice": {
# "accountid": "wkMd2g",
# "accounting_systemid": "wkMd2g",
# "address": "",
# "allowed_gateways": [
# ],
# "amount": {
# "amount": "180.00",
# "code": "USD"
# },
# "auto_bill": false,
# "autobill_status": null,
# "basecampid": 0,
# "city": "Toronto",
# "code": "M6P 3T1",
# "country": "",
# "create_date": "2019-04-20",
# "created_at": "2019-05-09 16:02:40",
# "currency_code": "USD",
# "current_organization": "Space Is Only Noise",
# "customerid": 92402,
# "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": "Nicholas",
# "fulfillment_date": null,
# "generation_date": null,
# "gmail": false,
# "id": 74888,
# "invoice_number": "0000029",
# "invoiceid": 74888,
# "language": "en",
# "last_order_status": null,
# "lname": "Jaar",
# "notes": "",
# "organization": "Space Is Only Noise",
# "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": "Ontario",
# "return_uri": null,
# "sentid": 1,
# "show_attachments": true,
# "status": 1,
# "street": "1655 Dupont St. W.",
# "street2": "",
# "template": "clean-grouped",
# "terms": "",
# "updated": "2019-05-09 16:02:41",
# "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
set Date_paid [new_CkDtObj]
set Accountid [CkJsonObject_stringOf $jResp "response.result.invoice.accountid"]
set Accounting_systemid [CkJsonObject_stringOf $jResp "response.result.invoice.accounting_systemid"]
set Address [CkJsonObject_stringOf $jResp "response.result.invoice.address"]
set Amount [CkJsonObject_stringOf $jResp "response.result.invoice.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.invoice.amount.code"]
set Auto_bill [CkJsonObject_BoolOf $jResp "response.result.invoice.auto_bill"]
set Autobill_status [CkJsonObject_stringOf $jResp "response.result.invoice.autobill_status"]
set Basecampid [CkJsonObject_IntOf $jResp "response.result.invoice.basecampid"]
set City [CkJsonObject_stringOf $jResp "response.result.invoice.city"]
set InvoiceCode [CkJsonObject_stringOf $jResp "response.result.invoice.code"]
set Country [CkJsonObject_stringOf $jResp "response.result.invoice.country"]
set Create_date [CkJsonObject_stringOf $jResp "response.result.invoice.create_date"]
set Created_at [CkJsonObject_stringOf $jResp "response.result.invoice.created_at"]
set Currency_code [CkJsonObject_stringOf $jResp "response.result.invoice.currency_code"]
set Current_organization [CkJsonObject_stringOf $jResp "response.result.invoice.current_organization"]
set Customerid [CkJsonObject_IntOf $jResp "response.result.invoice.customerid"]
CkJsonObject_DtOf $jResp "response.result.invoice.date_paid" 0 $Date_paid
set Deposit_amount [CkJsonObject_stringOf $jResp "response.result.invoice.deposit_amount"]
set Deposit_percentage [CkJsonObject_stringOf $jResp "response.result.invoice.deposit_percentage"]
set Deposit_status [CkJsonObject_stringOf $jResp "response.result.invoice.deposit_status"]
set Description [CkJsonObject_stringOf $jResp "response.result.invoice.description"]
set Discount_description [CkJsonObject_stringOf $jResp "response.result.invoice.discount_description"]
set Discount_totalAmount [CkJsonObject_stringOf $jResp "response.result.invoice.discount_total.amount"]
set Discount_totalCode [CkJsonObject_stringOf $jResp "response.result.invoice.discount_total.code"]
set Discount_value [CkJsonObject_stringOf $jResp "response.result.invoice.discount_value"]
set Display_status [CkJsonObject_stringOf $jResp "response.result.invoice.display_status"]
set Dispute_status [CkJsonObject_stringOf $jResp "response.result.invoice.dispute_status"]
set Due_date [CkJsonObject_stringOf $jResp "response.result.invoice.due_date"]
set Due_offset_days [CkJsonObject_IntOf $jResp "response.result.invoice.due_offset_days"]
set Estimateid [CkJsonObject_IntOf $jResp "response.result.invoice.estimateid"]
set Ext_archive [CkJsonObject_IntOf $jResp "response.result.invoice.ext_archive"]
set Fname [CkJsonObject_stringOf $jResp "response.result.invoice.fname"]
set Fulfillment_date [CkJsonObject_stringOf $jResp "response.result.invoice.fulfillment_date"]
set Generation_date [CkJsonObject_stringOf $jResp "response.result.invoice.generation_date"]
set Gmail [CkJsonObject_BoolOf $jResp "response.result.invoice.gmail"]
set Id [CkJsonObject_IntOf $jResp "response.result.invoice.id"]
set Invoice_number [CkJsonObject_stringOf $jResp "response.result.invoice.invoice_number"]
set Invoiceid [CkJsonObject_IntOf $jResp "response.result.invoice.invoiceid"]
set Language [CkJsonObject_stringOf $jResp "response.result.invoice.language"]
set Last_order_status [CkJsonObject_stringOf $jResp "response.result.invoice.last_order_status"]
set Lname [CkJsonObject_stringOf $jResp "response.result.invoice.lname"]
set Notes [CkJsonObject_stringOf $jResp "response.result.invoice.notes"]
set Organization [CkJsonObject_stringOf $jResp "response.result.invoice.organization"]
set OutstandingAmount [CkJsonObject_stringOf $jResp "response.result.invoice.outstanding.amount"]
set OutstandingCode [CkJsonObject_stringOf $jResp "response.result.invoice.outstanding.code"]
set Ownerid [CkJsonObject_IntOf $jResp "response.result.invoice.ownerid"]
set PaidAmount [CkJsonObject_stringOf $jResp "response.result.invoice.paid.amount"]
set PaidCode [CkJsonObject_stringOf $jResp "response.result.invoice.paid.code"]
set Parent [CkJsonObject_IntOf $jResp "response.result.invoice.parent"]
set Payment_details [CkJsonObject_stringOf $jResp "response.result.invoice.payment_details"]
set Payment_status [CkJsonObject_stringOf $jResp "response.result.invoice.payment_status"]
set Po_number [CkJsonObject_stringOf $jResp "response.result.invoice.po_number"]
set Province [CkJsonObject_stringOf $jResp "response.result.invoice.province"]
set Return_uri [CkJsonObject_stringOf $jResp "response.result.invoice.return_uri"]
set Sentid [CkJsonObject_IntOf $jResp "response.result.invoice.sentid"]
set Show_attachments [CkJsonObject_BoolOf $jResp "response.result.invoice.show_attachments"]
set Status [CkJsonObject_IntOf $jResp "response.result.invoice.status"]
set Street [CkJsonObject_stringOf $jResp "response.result.invoice.street"]
set Street2 [CkJsonObject_stringOf $jResp "response.result.invoice.street2"]
set Template [CkJsonObject_stringOf $jResp "response.result.invoice.template"]
set Terms [CkJsonObject_stringOf $jResp "response.result.invoice.terms"]
set Updated [CkJsonObject_stringOf $jResp "response.result.invoice.updated"]
set V3_status [CkJsonObject_stringOf $jResp "response.result.invoice.v3_status"]
set Vat_name [CkJsonObject_stringOf $jResp "response.result.invoice.vat_name"]
set Vat_number [CkJsonObject_stringOf $jResp "response.result.invoice.vat_number"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.invoice.vis_state"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.result.invoice.allowed_gateways"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
delete_CkDtObj $Date_paid
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice": {
"customerid": {{customerId}},
"create_date": "2019-04-20",
"lines": [
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Climbing Helmet",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "80.00",
"code": "USD"
}
},
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Belay Device",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "100.00",
"code": "USD"
}
}
],
"presentation": {
"image_logo_src": {{imgSrc}},
"theme_primary_color": {{themeColor}}
}
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceid}}?include%5B%5D=allowed_gateways
Postman Collection Item JSON
{
"name": "Single Invoice w/ Payment Gateway",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"invoiceId\", jsonData.response.result.invoice.id)",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"customerid\": {{customerId}},\n\t\t\"create_date\": \"2019-04-20\",\n\t\t\"lines\": [\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Climbing Helmet\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"80.00\",\n\t \"code\": \"USD\"\n\t }\n\t },\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Belay Device\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"100.00\",\n\t \"code\": \"USD\"\n\t }\n\t }\n\t ],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}}\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceid}}?include%5B%5D=allowed_gateways",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceid}}"
],
"query": [
{
"key": "include%5B%5D",
"value": "allowed_gateways"
}
]
},
"description": "Call an invoice and display the enabled gateway on that invoice.\n\nStripe = id: 26 |\nFBpay = id: 30 |\nPayPal = id: 7"
},
"response": [
{
"name": "Single Invoice w/ Payment Gateway",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"customerid\": {{customerId}},\n\t\t\"create_date\": \"2019-04-20\",\n\t\t\"lines\": [\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Climbing Helmet\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"80.00\",\n\t \"code\": \"USD\"\n\t }\n\t },\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Belay Device\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"100.00\",\n\t \"code\": \"USD\"\n\t }\n\t }\n\t ],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}}\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices?include%5B%5D=allowed_gateways",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices"
],
"query": [
{
"key": "include%5B%5D",
"value": "allowed_gateways"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXQEcVUR1RHVBWDgRRUVQKAAldWFIFAgNSSAAEBldKQVoHUApVDglQUwcGCVJXBAJASFBWDRUGZQ=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557432219"
},
{
"key": "Retry-After",
"value": "57"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 09 May 2018 20:02:41 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": "Thu, 09 May 2019 20:02:41 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17357-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 \"allowed_gateways\": [],\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"Toronto\",\n \"code\": \"M6P 3T1\",\n \"country\": \"\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-05-09 16:02:40\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"Space Is Only Noise\",\n \"customerid\": 92402,\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\": \"Nicholas\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 74888,\n \"invoice_number\": \"0000029\",\n \"invoiceid\": 74888,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"Jaar\",\n \"notes\": \"\",\n \"organization\": \"Space Is Only Noise\",\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\": \"Ontario\",\n \"return_uri\": null,\n \"sentid\": 1,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"1655 Dupont St. W.\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-05-09 16:02:41\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
