Chilkat Online Tools

Python / New FreshBooks / Single Invoice w/ Logo and styles

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# 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}}",
#       "theme_layout": "simple",
#       "theme_font_name": "modern"
#     }
#   }
# }

json = chilkat2.JsonObject()
json.UpdateInt("invoice.customerid",123)
json.UpdateString("invoice.create_date","2019-04-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","Climbing Helmet")
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","80.00")
json.UpdateString("invoice.lines[0].unit_cost.code","USD")
json.UpdateInt("invoice.lines[1].type",0)
json.UpdateString("invoice.lines[1].description","")
json.UpdateString("invoice.lines[1].taxName1","")
json.UpdateInt("invoice.lines[1].taxAmount1",0)
json.UpdateString("invoice.lines[1].name","Belay Device")
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","100.00")
json.UpdateString("invoice.lines[1].unit_cost.code","USD")
json.UpdateString("invoice.presentation.image_logo_src","{{image_logo_src}}")
json.UpdateString("invoice.presentation.theme_primary_color","{{theme_primary_color}}")
json.UpdateString("invoice.presentation.theme_layout","simple")
json.UpdateString("invoice.presentation.theme_font_name","modern")

# Adds the "Authorization: Bearer <access_token>" header.
http.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.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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": "Toronto",
#         "code": "M6P 3T1",
#         "country": "",
#         "create_date": "2019-04-20",
#         "created_at": "2019-05-09 16:00:31",
#         "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": 74880,
#         "invoice_number": "0000028",
#         "invoiceid": 74880,
#         "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:00:31",
#         "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

Date_paid = chilkat2.DtObj()

Accountid = jResp.StringOf("response.result.invoice.accountid")
Accounting_systemid = jResp.StringOf("response.result.invoice.accounting_systemid")
Address = jResp.StringOf("response.result.invoice.address")
Amount = jResp.StringOf("response.result.invoice.amount.amount")
Code = jResp.StringOf("response.result.invoice.amount.code")
Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill")
Autobill_status = jResp.StringOf("response.result.invoice.autobill_status")
Basecampid = jResp.IntOf("response.result.invoice.basecampid")
City = jResp.StringOf("response.result.invoice.city")
InvoiceCode = jResp.StringOf("response.result.invoice.code")
Country = jResp.StringOf("response.result.invoice.country")
Create_date = jResp.StringOf("response.result.invoice.create_date")
Created_at = jResp.StringOf("response.result.invoice.created_at")
Currency_code = jResp.StringOf("response.result.invoice.currency_code")
Current_organization = jResp.StringOf("response.result.invoice.current_organization")
Customerid = jResp.IntOf("response.result.invoice.customerid")
jResp.DtOf("response.result.invoice.date_paid",False,Date_paid)
Deposit_amount = jResp.StringOf("response.result.invoice.deposit_amount")
Deposit_percentage = jResp.StringOf("response.result.invoice.deposit_percentage")
Deposit_status = jResp.StringOf("response.result.invoice.deposit_status")
Description = jResp.StringOf("response.result.invoice.description")
Discount_description = jResp.StringOf("response.result.invoice.discount_description")
Discount_totalAmount = jResp.StringOf("response.result.invoice.discount_total.amount")
Discount_totalCode = jResp.StringOf("response.result.invoice.discount_total.code")
Discount_value = jResp.StringOf("response.result.invoice.discount_value")
Display_status = jResp.StringOf("response.result.invoice.display_status")
Dispute_status = jResp.StringOf("response.result.invoice.dispute_status")
Due_date = jResp.StringOf("response.result.invoice.due_date")
Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days")
Estimateid = jResp.IntOf("response.result.invoice.estimateid")
Ext_archive = jResp.IntOf("response.result.invoice.ext_archive")
Fname = jResp.StringOf("response.result.invoice.fname")
Fulfillment_date = jResp.StringOf("response.result.invoice.fulfillment_date")
Generation_date = jResp.StringOf("response.result.invoice.generation_date")
Gmail = jResp.BoolOf("response.result.invoice.gmail")
Id = jResp.IntOf("response.result.invoice.id")
Invoice_number = jResp.StringOf("response.result.invoice.invoice_number")
Invoiceid = jResp.IntOf("response.result.invoice.invoiceid")
Language = jResp.StringOf("response.result.invoice.language")
Last_order_status = jResp.StringOf("response.result.invoice.last_order_status")
Lname = jResp.StringOf("response.result.invoice.lname")
Notes = jResp.StringOf("response.result.invoice.notes")
Organization = jResp.StringOf("response.result.invoice.organization")
OutstandingAmount = jResp.StringOf("response.result.invoice.outstanding.amount")
OutstandingCode = jResp.StringOf("response.result.invoice.outstanding.code")
Ownerid = jResp.IntOf("response.result.invoice.ownerid")
PaidAmount = jResp.StringOf("response.result.invoice.paid.amount")
PaidCode = jResp.StringOf("response.result.invoice.paid.code")
Parent = jResp.IntOf("response.result.invoice.parent")
Payment_details = jResp.StringOf("response.result.invoice.payment_details")
Payment_status = jResp.StringOf("response.result.invoice.payment_status")
Po_number = jResp.StringOf("response.result.invoice.po_number")
Province = jResp.StringOf("response.result.invoice.province")
Return_uri = jResp.StringOf("response.result.invoice.return_uri")
Sentid = jResp.IntOf("response.result.invoice.sentid")
Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments")
Status = jResp.IntOf("response.result.invoice.status")
Street = jResp.StringOf("response.result.invoice.street")
Street2 = jResp.StringOf("response.result.invoice.street2")
Template = jResp.StringOf("response.result.invoice.template")
Terms = jResp.StringOf("response.result.invoice.terms")
Updated = jResp.StringOf("response.result.invoice.updated")
V3_status = jResp.StringOf("response.result.invoice.v3_status")
Vat_name = jResp.StringOf("response.result.invoice.vat_name")
Vat_number = jResp.StringOf("response.result.invoice.vat_number")
Vis_state = jResp.IntOf("response.result.invoice.vis_state")

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}},
			 "theme_layout": "simple",
			 "theme_font_name": "modern"
		}
	}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices

Postman Collection Item JSON

{
  "name": "Single Invoice w/ Logo and styles",
  "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\t\t{\n\t\t\t\t\"type\": 0,\n\t\t\t\t\"description\": \"\",\n\t\t\t\t\"taxName1\": \"\",\n\t\t\t\t\"taxAmount1\": 0,\n\t\t\t\t\"name\": \"Climbing Helmet\",\n\t\t\t\t\"qty\": 1,\n\t\t\t\t\"taxName2\": \"\",\n\t\t\t\t\"taxAmount2\": 0,\n\t\t\t\t\"unit_cost\": {\n\t\t\t\t\t\"amount\": \"80.00\",\n\t\t\t\t\t\"code\": \"USD\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": 0,\n\t\t\t\t\"description\": \"\",\n\t\t\t\t\"taxName1\": \"\",\n\t\t\t\t\"taxAmount1\": 0,\n\t\t\t\t\"name\": \"Belay Device\",\n\t\t\t\t\"qty\": 1,\n\t\t\t\t\"taxName2\": \"\",\n\t\t\t\t\"taxAmount2\": 0,\n\t\t\t\t\"unit_cost\": {\n\t\t\t\t\t\"amount\": \"100.00\",\n\t\t\t\t\t\"code\": \"USD\"\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}},\n\t\t\t \"theme_layout\": \"simple\",\n\t\t\t \"theme_font_name\": \"modern\"\n\t\t}\n\t}\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoices",
        "invoices"
      ],
      "query": [
        {
          "key": "include%5B%5D",
          "value": "presentation",
          "disabled": true
        }
      ]
    },
    "description": "Define invoice logo and styles by passing in `presentation` object with the fields below:\n\n| Field name | Acceptable values |\n|------------|-------------------|\n| `image_logo_src`| Relative URL of a logo uploaded to FreshBooks - See Upload Logo |\n| `theme_primary_color`| Valid color code |\n| `theme_layout` | \"simple\" or \"modern\" |\n| `theme_font_name` | \"modern\" or \"classic\" |\n\nBy default, if no `presentation` specified in new invoice request payload, it will be assigned a default presentation.\nTo override this default behaviour, specify `\"use_default_presentation\": false`"
  },
  "response": [
    {
      "name": "Single Invoice w/ Logo and styles",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "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\t \"theme_layout\": \"simple\",\n\t\t\t \"theme_font_name\": \"modern\"\n\t\t}\n\t}\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "invoices",
            "invoices"
          ],
          "query": [
            {
              "key": "include%5B%5D",
              "value": "presentation",
              "disabled": true
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXQEcVUR1RHVBWDw5WXlYOAgRUUFEBBgVKVQMDBk5EWlsJBwkDCwoGAAtQDwcCBBFOAldbEgM+"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557432079"
        },
        {
          "key": "Retry-After",
          "value": "47"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 09 May 2018 20:00:31 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:00:31 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                \"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:00:31\",\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\": 74880,\n                \"invoice_number\": \"0000028\",\n                \"invoiceid\": 74880,\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:00:31\",\n                \"v3_status\": \"draft\",\n                \"vat_name\": \"\",\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}