Chilkat Online Tools

Python / New FreshBooks / Send Invoice by Email

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": {
#     "email_recipients": [
#       "example@freshbooks.com",
#       "example2@freshbooks.com"
#     ],
#     "invoice_customized_email": {
#       "subject": "::company name:: has sent you an invoice (::invoice number::)",
#       "body": "::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::"
#     },
#     "action_email": true
#   }
# }

json = chilkat2.JsonObject()
json.UpdateString("invoice.email_recipients[0]","example@freshbooks.com")
json.UpdateString("invoice.email_recipients[1]","example2@freshbooks.com")
json.UpdateString("invoice.invoice_customized_email.subject","::company name:: has sent you an invoice (::invoice number::)")
json.UpdateString("invoice.invoice_customized_email.body","::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::")
json.UpdateBool("invoice.action_email",True)

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "invoice": {
        
        "email_recipients": [
            "example@freshbooks.com",
            "example2@freshbooks.com"
        ],
        "invoice_customized_email": {
        "subject": "::company name:: has sent you an invoice (::invoice number::)",
                "body":"::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that\'s due on ::invoice due date::"
            },
            "action_email": true
    }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}

Postman Collection Item JSON

{
  "name": "Send Invoice by Email",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"invoice\": {\n        \n        \"email_recipients\": [\n            \"example@freshbooks.com\",\n            \"example2@freshbooks.com\"\n        ],\n        \"invoice_customized_email\": {\n        \"subject\": \"::company name:: has sent you an invoice (::invoice number::)\",\n                \"body\":\"::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::\"\n            },\n            \"action_email\": true\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "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}}"
      ]
    }
  },
  "response": [
  ]
}