Ruby / New FreshBooks / Create Single Invoice Profile w/ Time Entry Holder
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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_profile": {
# "customerid": 123,
# "frequency": "m",
# "profileid": null,
# "disable": false,
# "due_offset_days": 30,
# "numberRecurring": 0,
# "send_email": true,
# "include_unbilled_time": true,
# "project_format": {
# "group_by": "service",
# "method": "detailed",
# "show_tname": true,
# "show_pname": true,
# "show_staff": true,
# "show_date": true,
# "show_notes": true,
# "show_total_hours": false
# },
# "skip_generation": false,
# "retainer_id": null,
# "require_auto_bill": false,
# "create_date": "2019-07-15",
# "currency_code": "CAD",
# "discount_value": 0,
# "template": "clean-grouped",
# "terms": "Show me the money",
# "allowed_gatewayids": [
# 26
# ],
# "late_fee": {
# "compounded_taxes": false,
# "days": 30,
# "enabled": false,
# "first_tax_name": "HST",
# "first_tax_percent": 13,
# "repeat": false,
# "second_tax_name": null,
# "second_tax_percent": null,
# "type": "percent",
# "value": 10
# },
# "late_reminders": [
# ],
# "lines": [
# {
# "amount": {
# "amount": "0",
# "code": "CAD"
# },
# "description": null,
# "expenseid": null,
# "taxName1": null,
# "taxAmount1": 0,
# "name": null,
# "qty": 1,
# "taxName2": null,
# "taxAmount2": 0,
# "type": 5,
# "unit_cost": {
# "amount": "0",
# "code": "CAD"
# },
# "profileid": null
# }
# ]
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateInt("invoice_profile.customerid",123)
json.UpdateString("invoice_profile.frequency","m")
json.UpdateNull("invoice_profile.profileid")
json.UpdateBool("invoice_profile.disable",false)
json.UpdateInt("invoice_profile.due_offset_days",30)
json.UpdateInt("invoice_profile.numberRecurring",0)
json.UpdateBool("invoice_profile.send_email",true)
json.UpdateBool("invoice_profile.include_unbilled_time",true)
json.UpdateString("invoice_profile.project_format.group_by","service")
json.UpdateString("invoice_profile.project_format.method","detailed")
json.UpdateBool("invoice_profile.project_format.show_tname",true)
json.UpdateBool("invoice_profile.project_format.show_pname",true)
json.UpdateBool("invoice_profile.project_format.show_staff",true)
json.UpdateBool("invoice_profile.project_format.show_date",true)
json.UpdateBool("invoice_profile.project_format.show_notes",true)
json.UpdateBool("invoice_profile.project_format.show_total_hours",false)
json.UpdateBool("invoice_profile.skip_generation",false)
json.UpdateNull("invoice_profile.retainer_id")
json.UpdateBool("invoice_profile.require_auto_bill",false)
json.UpdateString("invoice_profile.create_date","2019-07-15")
json.UpdateString("invoice_profile.currency_code","CAD")
json.UpdateInt("invoice_profile.discount_value",0)
json.UpdateString("invoice_profile.template","clean-grouped")
json.UpdateString("invoice_profile.terms","Show me the money")
json.UpdateInt("invoice_profile.allowed_gatewayids[0]",26)
json.UpdateBool("invoice_profile.late_fee.compounded_taxes",false)
json.UpdateInt("invoice_profile.late_fee.days",30)
json.UpdateBool("invoice_profile.late_fee.enabled",false)
json.UpdateString("invoice_profile.late_fee.first_tax_name","HST")
json.UpdateInt("invoice_profile.late_fee.first_tax_percent",13)
json.UpdateBool("invoice_profile.late_fee.repeat",false)
json.UpdateNull("invoice_profile.late_fee.second_tax_name")
json.UpdateNull("invoice_profile.late_fee.second_tax_percent")
json.UpdateString("invoice_profile.late_fee.type","percent")
json.UpdateInt("invoice_profile.late_fee.value",10)
json.UpdateNewArray("invoice_profile.late_reminders")
json.UpdateString("invoice_profile.lines[0].amount.amount","0")
json.UpdateString("invoice_profile.lines[0].amount.code","CAD")
json.UpdateNull("invoice_profile.lines[0].description")
json.UpdateNull("invoice_profile.lines[0].expenseid")
json.UpdateNull("invoice_profile.lines[0].taxName1")
json.UpdateInt("invoice_profile.lines[0].taxAmount1",0)
json.UpdateNull("invoice_profile.lines[0].name")
json.UpdateInt("invoice_profile.lines[0].qty",1)
json.UpdateNull("invoice_profile.lines[0].taxName2")
json.UpdateInt("invoice_profile.lines[0].taxAmount2",0)
json.UpdateInt("invoice_profile.lines[0].type",5)
json.UpdateString("invoice_profile.lines[0].unit_cost.amount","0")
json.UpdateString("invoice_profile.lines[0].unit_cost.code","CAD")
json.UpdateNull("invoice_profile.lines[0].profileid")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice_profile":
{
"customerid": {{customerid}},
"frequency":"m",
"profileid":null,
"disable":false,
"due_offset_days":30,
"numberRecurring":0,
"send_email":true,
"include_unbilled_time":true,
"project_format":
{
"group_by":"service",
"method":"detailed",
"show_tname":true,
"show_pname":true,
"show_staff":true,
"show_date":true,
"show_notes":true,
"show_total_hours":false
},
"skip_generation":false,
"retainer_id":null,
"require_auto_bill":false,
"create_date":"2019-07-15",
"currency_code":"CAD",
"discount_value":0,
"template":"clean-grouped",
"terms": "Show me the money",
"allowed_gatewayids":[26],
"late_fee":
{
"compounded_taxes":false,
"days":30,
"enabled":false,
"first_tax_name": "HST",
"first_tax_percent": 13,
"repeat":false,
"second_tax_name":null,
"second_tax_percent":null,
"type":"percent",
"value":10}
,"late_reminders":[],
"lines":
[{
"amount":
{
"amount":"0",
"code":"CAD"
},
"description":null,
"expenseid":null,
"taxName1":null,
"taxAmount1":0,
"name":null,
"qty":1,
"taxName2":null,
"taxAmount2":0,
"type":5,
"unit_cost":
{
"amount":"0",
"code":"CAD"
},
"profileid":null
}]
}
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue
Postman Collection Item JSON
{
"name": "Create Single Invoice Profile w/ Time Entry Holder ",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_profile\":\n {\n \"customerid\": {{customerid}},\n \"frequency\":\"m\",\n \"profileid\":null,\n \"disable\":false,\n \"due_offset_days\":30,\n \"numberRecurring\":0,\n \"send_email\":true,\n \"include_unbilled_time\":true,\n \"project_format\":\n {\n \"group_by\":\"service\",\n \"method\":\"detailed\",\n \"show_tname\":true,\n \"show_pname\":true,\n \"show_staff\":true,\n \"show_date\":true,\n \"show_notes\":true,\n \"show_total_hours\":false\n },\n \"skip_generation\":false,\n \"retainer_id\":null,\n \"require_auto_bill\":false,\n \"create_date\":\"2019-07-15\",\n \"currency_code\":\"CAD\",\n \"discount_value\":0,\n \"template\":\"clean-grouped\",\n \"terms\": \"Show me the money\",\n \"allowed_gatewayids\":[26],\n \"late_fee\":\n {\n \"compounded_taxes\":false,\n \"days\":30,\n \"enabled\":false,\n \"first_tax_name\": \"HST\",\n \"first_tax_percent\": 13,\n \"repeat\":false,\n \"second_tax_name\":null,\n \"second_tax_percent\":null,\n \"type\":\"percent\",\n \"value\":10}\n ,\"late_reminders\":[],\n \"lines\":\n [{\n \"amount\":\n {\n \"amount\":\"0\",\n \"code\":\"CAD\"\n },\n \"description\":null,\n \"expenseid\":null,\n \"taxName1\":null,\n \"taxAmount1\":0,\n \"name\":null,\n \"qty\":1,\n \"taxName2\":null,\n \"taxAmount2\":0,\n \"type\":5,\n \"unit_cost\":\n {\n \"amount\":\"0\",\n \"code\":\"CAD\"\n },\n \"profileid\":null\n }]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/invoice_profiles/invoice_profiles?include[]=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue&include%5B%5D=allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountid}}",
"invoice_profiles",
"invoice_profiles"
],
"query": [
{
"key": "include[]",
"value": "allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue"
},
{
"key": "include%5B%5D",
"value": "allowed_gateways,contacts,late_fee,late_reminders,lines,presentation,system,tracking,project_format,total_accrued_revenue"
}
]
},
"description": "This will create an invoice profile that will pull unbilled time entries for your client on to the invoice that is generated"
},
"response": [
]
}
