Chilkat Online Tools

delphiDll / New FreshBooks / Send Invoice by Email

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'invoice.email_recipients[0]','example@freshbooks.com');
CkJsonObject_UpdateString(json,'invoice.email_recipients[1]','example2@freshbooks.com');
CkJsonObject_UpdateString(json,'invoice.invoice_customized_email.subject','::company name:: has sent you an invoice (::invoice number::)');
CkJsonObject_UpdateString(json,'invoice.invoice_customized_email.body','::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that''s due on ::invoice due date::');
CkJsonObject_UpdateBool(json,'invoice.action_email',True);

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

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