Customer email templates can be used to standardize messages sent to multiple customers.
Returns a collection with a key, ID, and link for each customer email template. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-receivable/customer-email-template/1"
}, - {
- "key": "6",
- "id": "6",
- "href": "/objects/accounts-receivable/customer-email-template/6"
}, - {
- "key": "8",
- "id": "8",
- "href": "/objects/accounts-receivable/customer-email-template/8"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new customer email template.
| |||||
object Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction. | |||||
| |||||
object Associated email template. Example: "1" | |||||
|
Created
Bad Request
{- "customer": {
- "key": "127"
}, - "emailTemplate": {
- "key": "4"
}
}
{- "ia::result": {
- "key": "10",
- "id": "10",
- "href": "/objects/accounts-receivable/customer-email-template/10"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified customer email template.
key required | string System-assigned key for the customer email template. Example: 2 |
OK
Bad Request
{- "ia::result": {
- "key": "10",
- "id": "10",
- "customer": {
- "key": "127",
- "id": "Cust_Dif_Con_PnEtmp",
- "href": "/objects/accounts-receivable/customer/127"
}, - "txnDefinition": {
- "key": "12",
- "id": "Customer Sales Invoice"
}, - "emailTemplate": {
- "id": "4",
- "key": "4",
- "name": "SimpleARInvTemp",
- "templateType": "arInvoice",
- "href": "/objects/company-config/email-template/4"
}, - "href": "/objects/accounts-receivable/customer-email-template/2"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing customer email template by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the customer email template. Example: 2 |
object Customer associated with the email template. | |||||
| |||||
object Transaction definition, which is the template that contains accounting settings, workflow rules, and other configuration settings for a transaction. | |||||
| |||||
object Associated email template. | |||||
|
OK
Bad Request
{- "emailTemplate": {
- "key": "10"
}
}
{- "ia::result": {
- "key": "10",
- "id": "10",
- "href": "/objects/accounts-receivable/customer-email-template/10"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a customer email template.
key required | string System-assigned key for the customer email template. Example: 2 |
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: "accounts-receivable/customer-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-receivable/customer-email-template",
- "filters": [
- {
- "$eq": {
- "emailTemplate.id": "11"
}
}
], - "fields": [
- "id",
- "key",
- "customer.id",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "6",
- "key": "6",
- "customer.id": "C-00003",
- "href": "/objects/accounts-receivable/customer-email-template/6"
}, - {
- "id": "8",
- "key": "8",
- "customer.id": "C-00025",
- "href": "/objects/accounts-receivable/customer-email-template/8"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}