Chilkat Online Tools

Swift3 / New FreshBooks / Send Invoice by Email

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("invoice.email_recipients[0]", value: "example@freshbooks.com")
    json.update("invoice.email_recipients[1]", value: "example2@freshbooks.com")
    json.update("invoice.invoice_customized_email.subject", value: "::company name:: has sent you an invoice (::invoice number::)")
    json.update("invoice.invoice_customized_email.body", value: "::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::")
    json.updateBool("invoice.action_email", value: true)

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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": [
  ]
}