Chilkat Online Tools

Ruby / New FreshBooks / Create Invoice with Expense

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": {
#     "customerid": 485558,
#     "create_date": "2019-06-20",
#     "lines": [
#       {
#         "type": 0,
#         "description": "",
#         "taxName1": "",
#         "taxAmount1": 0,
#         "name": "Paperwork",
#         "qty": 1,
#         "taxName2": "",
#         "taxAmount2": 0,
#         "unit_cost": {
#           "amount": "5000.00",
#           "code": "USD"
#         }
#       },
#       {
#         "type": 1,
#         "description": "Gas",
#         "expenseid": 123,
#         "taxName1": "",
#         "taxAmount1": 0,
#         "name": "Shell Oil",
#         "qty": 1,
#         "taxName2": "",
#         "taxAmount2": 0,
#         "unit_cost": {
#           "amount": "120.00",
#           "code": "USD"
#         }
#       }
#     ]
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("invoice.customerid",485558)
json.UpdateString("invoice.create_date","2019-06-20")
json.UpdateInt("invoice.lines[0].type",0)
json.UpdateString("invoice.lines[0].description","")
json.UpdateString("invoice.lines[0].taxName1","")
json.UpdateInt("invoice.lines[0].taxAmount1",0)
json.UpdateString("invoice.lines[0].name","Paperwork")
json.UpdateInt("invoice.lines[0].qty",1)
json.UpdateString("invoice.lines[0].taxName2","")
json.UpdateInt("invoice.lines[0].taxAmount2",0)
json.UpdateString("invoice.lines[0].unit_cost.amount","5000.00")
json.UpdateString("invoice.lines[0].unit_cost.code","USD")
json.UpdateInt("invoice.lines[1].type",1)
json.UpdateString("invoice.lines[1].description","Gas")
json.UpdateInt("invoice.lines[1].expenseid",123)
json.UpdateString("invoice.lines[1].taxName1","")
json.UpdateInt("invoice.lines[1].taxAmount1",0)
json.UpdateString("invoice.lines[1].name","Shell Oil")
json.UpdateInt("invoice.lines[1].qty",1)
json.UpdateString("invoice.lines[1].taxName2","")
json.UpdateInt("invoice.lines[1].taxAmount2",0)
json.UpdateString("invoice.lines[1].unit_cost.amount","120.00")
json.UpdateString("invoice.lines[1].unit_cost.code","USD")

# 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}}/invoices/invoices","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": {
    "customerid": 485558,
    "create_date": "2019-06-20",
    "lines": [
      {
        "type": 0,
        "description": "",
        "taxName1": "",
        "taxAmount1": 0,
        "name": "Paperwork",
        "qty": 1,
        "taxName2": "",
        "taxAmount2": 0,
        "unit_cost": {
            "amount": "5000.00",
            "code": "USD"
        }
      },
      {
        "type": 1,
        "description": "Gas",
        "expenseid": {{expenseId}},
        "taxName1": "",
        "taxAmount1": 0,
        "name": "Shell Oil",
        "qty": 1,
        "taxName2": "",
        "taxAmount2": 0,
        "unit_cost": {
            "amount": "120.00",
            "code": "USD"
        }
      }
    ]
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices

Postman Collection Item JSON

{
  "name": "Create Invoice with Expense ",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice\": {\n    \"customerid\": 485558,\n    \"create_date\": \"2019-06-20\",\n    \"lines\": [\n      {\n        \"type\": 0,\n        \"description\": \"\",\n        \"taxName1\": \"\",\n        \"taxAmount1\": 0,\n        \"name\": \"Paperwork\",\n        \"qty\": 1,\n        \"taxName2\": \"\",\n        \"taxAmount2\": 0,\n        \"unit_cost\": {\n            \"amount\": \"5000.00\",\n            \"code\": \"USD\"\n        }\n      },\n      {\n        \"type\": 1,\n        \"description\": \"Gas\",\n        \"expenseid\": {{expenseId}},\n        \"taxName1\": \"\",\n        \"taxAmount1\": 0,\n        \"name\": \"Shell Oil\",\n        \"qty\": 1,\n        \"taxName2\": \"\",\n        \"taxAmount2\": 0,\n        \"unit_cost\": {\n            \"amount\": \"120.00\",\n            \"code\": \"USD\"\n        }\n      }\n    ]\n  }\n}\n"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoices",
        "invoices"
      ]
    },
    "description": "Creating invoice with expense.\n\nFirst you will need to create an expense. Once that is created, save the expenseId and add it to the invoice. \n\nWhen adding an expense, make sure you add to the `markup_percent` parameter the amount you want to markup by and set `cogs` to `true` if it is an item you have paid for. "
  },
  "response": [
  ]
}