Email templates

Use email templates to organize email content and add style to make emails stand out to your customers and vendors. Create a variety of email templates to use for different types of transactions, different vendors, or different customers. You can add merge fields to populate emails with dynamic data from Sage Intacct, such as the vendor name, contact information, and so on.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List email templates

get/objects/company-config/email-template

Returns a collection with a key, ID, and link for each email template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/email-template/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/company-config/email-template/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an email template
post/objects/company-config/email-template
Creates a new email template.


SecurityOAuth2 
Request 
Request Body schema: application/json
Email template to create


name
required
string
name for the email template.


 
 Example:  "New Email Template"
subject
required
string
Subject  Enter a combination of text and merge fields as desired to create an informative subject line. This field is required


 
 Example:  "Testing New Email Template"
body
required
string
Message  Enter a combination of text, merge fields, and HTML markup as desired to create and customize your message. This field is required.


 
 Example:  "test message for all to see"
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
description
string
Description


 
 Example:  "Test for New Email Template"
object
 
replyTo
required
string
Enter an email address you want the recipient to reply to. This corresponds to the From email address the user sees in the Print/Email dialog box when they send an email from a transaction.


 
 Example:  "[email protected]"
to
string
To The recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
cc
string
Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
bcc
string
Blind Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
object
 
isLogoIncluded
boolean
 Default:  false
Include logo Select this checkbox to include the logo image file identified on the Company Information page in the email template.


 
 Example:  true
verticalPosition
string
 Default:  "bottom"
Vertical logo position  Select whether the logo should appear at the top or bottom of the email.


 Enum: "bottom" "top"  
 Example:  "bottom"
horizontalPosition
string
 Default:  "left"
Horizontal logo position  Select whether the logo should appear on the left or right side of the email.


 Enum: "left" "right"  
 Example:  "left"
includeTxnAttachments
boolean
 Default:  false
Select this checkbox to include documents attached to the transaction, such as receipts, in the email you send from a transaction. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
includeProjectInvoiceTxnAttachments
boolean
 Default:  false
Select this checkbox to include all source document attachments linked to a project invoice when emailing the invoice. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
templateType
string
 Default:  "arInvoice"
Application


 Enum: "Contract" "arInvoice" "arStatement" "orderEntryTxn" "purchasingTxn"  
 Example:  "arInvoice"
useSendersPreferredDateFormat
boolean
 Default:  false
Display dates in the user preference setting


 
 Example:  true
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "New Email Template",
  • "description": "Test for New Email Template",
  • "templateType": "purchasingTxn",
  • "email": {},
  • "subject": "test subject",
  • "body": "test message for all to see"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "12",
    • "key": "12",
    • "href": "/objects/company-config/email-template/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an email template
get/objects/company-config/email-template/{key}
Returns detailed information for a specified email-template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "id": 23,
  • "key": 23,
  • "audit": {
    • "createdDateTime": "2023-10-20T11:31:45Z",
    • "modifiedDateTime": "2023-10-20T11:31:45Z",
    • "createdBy": "1",
    • "modifiedBy": "1"
    },
  • "status": "active",
  • "name": "New Email Template",
  • "description": "Test for New Email Template",
  • "templateType": "purchasingTxn",
  • "email": {},
  • "subject": "test subject",
  • "body": "test message for all to see",
  • "logo": {
    • "isLogoIncluded": true,
    • "verticalPosition": "bottom",
    • "horizontalPosition": "left"
    },
  • "includeTxnAttachments": false,
  • "includeProjectInvoiceTxnAttachments": false,
  • "useSendersPreferredDateFormat": true,
  • "href": "/objects/company-config/email-template/6"
}
Delete an email template
delete/objects/company-config/email-template/{key}
Deletes an email template.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "Payload contains errors",
      • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
      • "errorId": "REST-1064",
      • "additionalInfo": {
        },
      • "details": [
        ]
      },
    • "ia::meta": {
      • "totalCount": 3,
      • "totalSuccess": 2,
      • "totalError": 1
      }
    },
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Update an email template
patch/objects/company-config/email-template/{key}
Updates an existing email-template by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the email-template.


 
Request Body schema: application/json
status
string
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
name
string
name for the email template.


 
 Example:  "New Email Template"
description
string
Description


 
 Example:  "Test for New Email Template"
object
 
replyTo
string
Enter an email address you want the recipient to reply to. This corresponds to the From email address the user sees in the Print/Email dialog box when they send an email from a transaction.


 
 Example:  "[email protected]"
to
string
To The recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
cc
string
Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
bcc
string
Blind Carbon Copy the recipients of the email. You can enter one or more merge fields in each field.


 
 Example:  "[email protected]"
subject
string
Subject  Enter a combination of text and merge fields as desired to create an informative subject line. This field is required


 
 Example:  "Testing New Email Template"
body
string
Message  Enter a combination of text, merge fields, and HTML markup as desired to create and customize your message. This field is required.


 
 Example:  "test message for all to see"
object
 
isLogoIncluded
boolean
 Default:  false
Include logo Select this checkbox to include the logo image file identified on the Company Information page in the email template.


 
 Example:  true
verticalPosition
string
 Default:  "bottom"
Vertical logo position  Select whether the logo should appear at the top or bottom of the email.


 Enum: "bottom" "top"  
 Example:  "bottom"
horizontalPosition
string
 Default:  "left"
Horizontal logo position  Select whether the logo should appear on the left or right side of the email.


 Enum: "left" "right"  
 Example:  "left"
includeTxnAttachments
boolean
 Default:  false
Select this checkbox to include documents attached to the transaction, such as receipts, in the email you send from a transaction. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
includeProjectInvoiceTxnAttachments
boolean
 Default:  false
Select this checkbox to include all source document attachments linked to a project invoice when emailing the invoice. Attachments are emailed in the format in which they were attached to the transaction. For example, if you attached a TXT file, the file is sent as a TXT file.


 
 Example:  true
templateType
string
 Default:  "arInvoice"
Application


 Enum: "Contract" "arInvoice" "arStatement" "orderEntryTxn" "purchasingTxn"  
 Example:  "arInvoice"
useSendersPreferredDateFormat
boolean
 Default:  false
Display dates in the user preference setting


 
 Example:  true
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "New Email Template patched",
  • "email": {},
  • "includeTxnAttachments": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "6",
    • "key": "6",
    • "href": "/objects/company-config/email-template/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query email templates
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "company-config/email-template"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}