Renewal templates

A renewal template defines a set of actions Sage Intacct will perform when a contract reaches its end date.

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 renewal templates

get/objects/order-entry/renewal-template

Returns a collection with a key, ID, and link for each order entry renewal template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
null
Create a renewal template
post/objects/order-entry/renewal-template
Creates a new order entry renewal template.


SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Order entry renewal template ID.


 
 Example:  "Sales Renewal Template"
description
string
Description.


 
 Example:  "description of an order entry renewal template"
object
 
createSalesTxn
boolean
 Default:  false
Create sales transaction.


 
 Example:  false
object
 
key
string
Sales transaction key.


 
 Example:  "1"
id
string
Sales transaction type.


 
 Example:  "Sales Invoice"
daysBeforeAfter
integer
 Default:  10
Amount of days before or after the Contract End Date for the SO transaction.


 
 Example:  10
beforeAfterContractEndDate
string
 Default:  "before"
After or before Contract End Date for SO transaction.


 Enum: "after" "before"  
 Example:  "before"
txnDateOnRenewedDocument
string
 Default:  "contractEndDate+1"
Date on renewed document.


 Enum: "calculatedDate" "contractEndDate+1"  
 Example:  "calculatedDate"
startDateOnRenewedDocument
string
 Default:  "sameAsDocumentDate"
Start date of renewed contract.


 Enum: "sameAsDocumentDate" "withInheritedOffsetFromParent"  
 Example:  "sameAsDocumentDate"
object
 
pricingType
string
 Default:  "sameAsOriginal"
Pricing type.


 Enum: "defaultPricing" "markup/markdown" "sameAsOriginal"  
 Example:  "sameAsOriginal"
markup
string
 Default:  "percentageMarkup"
Pricing markup.


 Enum: "actualDiscount" "actualMarkup" "percentageDiscount" "percentageMarkup"  
 Example:  "percentageMarkup"
markupValue
string
Pricing markup by value.


 
 Example:  "1.00"
object
 
object
 
sendToCustomer
boolean
 Default:  false
Customer email.


 
 Example:  false
contact
string
 Default:  "customerContact"
Contact.


 Enum: "customerContact" "transactionBillToContact" "transactionShipToContact"  
 Example:  "customerContact"
daysBeforeAfter
integer
 Default:  0
When to send email alert to customer.


 
 Example:  0
beforeAfterContractRenewalDate
string
 Default:  "before"
After or before for customer for contract renewal alert.


 Enum: "after" "before"  
 Example:  "before"
object
 
object
 
sendToInternal
boolean
 Default:  false
Internal email.


 
 Example:  false
daysBeforeAfter
integer
 Default:  10
When to send email notification.


 
 Example:  10
beforeAfterContractRenewalDate
string
 Default:  "before"
After or before for sales team notification.


 Enum: "after" "before"  
 Example:  "before"
object
 
latestVersion
string
Latest version key.


 
 Example:  "???"
transactionType
string
 Default:  "salesTransaction"
Transaction type.


 Enum: "contract" "evergreen" "salesTransaction"  
 Example:  "salesTransaction"
termLength
string
Default renewal term length.


 
 Example:  "5"
termPeriod
string
 Default:  "months"
Default renewal term period.


 Enum: "days" "months" "years"  
 Example:  "months"
state
string
 Default:  "inProgress"
Create renewal as.


 Enum: "draft" "inProgress"  
 Example:  "draft"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Get a renewal template
get/objects/order-entry/renewal-template/{key}
Returns detailed information for a specified order entry renewal template.


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


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
null
Update a renewal template
patch/objects/order-entry/renewal-template/{key}
Updates an existing order entry renewal template by setting field values. Any fields not provided remain unchanged.


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


 
Request Body schema: application/json
description
string
Description.


 
 Example:  "description of an order entry renewal template"
object
 
createSalesTxn
boolean
 Default:  false
Create sales transaction.


 
 Example:  false
object
 
key
string
Sales transaction key.


 
 Example:  "1"
id
string
Sales transaction type.


 
 Example:  "Sales Invoice"
daysBeforeAfter
integer
 Default:  10
Amount of days before or after the Contract End Date for the SO transaction.


 
 Example:  10
beforeAfterContractEndDate
string
 Default:  "before"
After or before Contract End Date for SO transaction.


 Enum: "after" "before"  
 Example:  "before"
txnDateOnRenewedDocument
string
 Default:  "contractEndDate+1"
Date on renewed document.


 Enum: "calculatedDate" "contractEndDate+1"  
 Example:  "calculatedDate"
startDateOnRenewedDocument
string
 Default:  "sameAsDocumentDate"
Start date of renewed contract.


 Enum: "sameAsDocumentDate" "withInheritedOffsetFromParent"  
 Example:  "sameAsDocumentDate"
object
 
pricingType
string
 Default:  "sameAsOriginal"
Pricing type.


 Enum: "defaultPricing" "markup/markdown" "sameAsOriginal"  
 Example:  "sameAsOriginal"
markup
string
 Default:  "percentageMarkup"
Pricing markup.


 Enum: "actualDiscount" "actualMarkup" "percentageDiscount" "percentageMarkup"  
 Example:  "percentageMarkup"
markupValue
string
Pricing markup by value.


 
 Example:  "1.00"
object
 
object
 
sendToCustomer
boolean
 Default:  false
Customer email.


 
 Example:  false
contact
string
 Default:  "customerContact"
Contact.


 Enum: "customerContact" "transactionBillToContact" "transactionShipToContact"  
 Example:  "customerContact"
daysBeforeAfter
integer
 Default:  0
When to send email alert to customer.


 
 Example:  0
beforeAfterContractRenewalDate
string
 Default:  "before"
After or before for customer for contract renewal alert.


 Enum: "after" "before"  
 Example:  "before"
object
 
object
 
sendToInternal
boolean
 Default:  false
Internal email.


 
 Example:  false
daysBeforeAfter
integer
 Default:  10
When to send email notification.


 
 Example:  10
beforeAfterContractRenewalDate
string
 Default:  "before"
After or before for sales team notification.


 Enum: "after" "before"  
 Example:  "before"
object
 
latestVersion
string
Latest version key.


 
 Example:  "???"
transactionType
string
 Default:  "salesTransaction"
Transaction type.


 Enum: "contract" "evergreen" "salesTransaction"  
 Example:  "salesTransaction"
termLength
string
Default renewal term length.


 
 Example:  "5"
termPeriod
string
 Default:  "months"
Default renewal term period.


 Enum: "days" "months" "years"  
 Example:  "months"
state
string
 Default:  "inProgress"
Create renewal as.


 Enum: "draft" "inProgress"  
 Example:  "draft"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Delete a renewal template
delete/objects/order-entry/renewal-template/{key}
Deletes an order entry renewal template.


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


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query renewal 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:  "order-entry/renewal-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
    }
}