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.
Returns a collection with a key, ID, and link for each email template.
OK
Bad Request
{- "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
}
}
Creates a new email template.
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 Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||
description | string Description Example: "Test for New Email Template" | ||||||||
object | |||||||||
| |||||||||
object | |||||||||
| |||||||||
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 Example: "arInvoice" | ||||||||
useSendersPreferredDateFormat | boolean Default: false Display dates in the user preference setting Example: true |
Created
Bad Request
{- "name": "New Customer Email Template",
- "description": "Email template for new customers",
- "templateType": "purchasingTxn",
- "subject": "Welcome!",
- "body": "New customers receive a 10% discount on their first subscription order."
}
{- "ia::result": {
- "id": "12",
- "key": "12",
- "href": "/objects/company-config/email-template/12"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified email template.
key required | string System-assigned key for the email-template. |
OK
Bad Request
{- "id": 12,
- "key": 12,
- "audit": {
- "createdDateTime": "2023-10-20T11:31:45Z",
- "modifiedDateTime": "2023-10-20T11:31:45Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "status": "active",
- "name": "New Customer Email Template",
- "description": "Test for New Email Template",
- "templateType": "purchasingTxn",
- "subject": "Welcome!",
- "body": "New customers receive a 10% discount on their first subscription order.",
- "logo": {
- "isLogoIncluded": true,
- "verticalPosition": "bottom",
- "horizontalPosition": "left"
}, - "includeTxnAttachments": false,
- "includeProjectInvoiceTxnAttachments": false,
- "useSendersPreferredDateFormat": true,
- "href": "/objects/company-config/email-template/12"
}
Updates an existing email template by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the email-template. |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||||||
name | string name for the email template. Example: "New Email Template" | ||||||||
description | string Description Example: "Test for New Email Template" | ||||||||
object | |||||||||
| |||||||||
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 | |||||||||
| |||||||||
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 Example: "arInvoice" | ||||||||
useSendersPreferredDateFormat | boolean Default: false Display dates in the user preference setting Example: true |
OK
Bad Request
{- "name": "New Customer Email SW",
- "includeTxnAttachments": true
}
{- "ia::result": {
- "id": "6",
- "key": "6",
- "href": "/objects/company-config/email-template/6"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an email template.
key required | string System-assigned key for the email-template. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "company-config/email-template" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}