Renewal templates

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

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
{
  • "ia::result": [
    • {
      • "key": "15",
      • "id": "15",
      • "href": "/objects/order-entry/renewal-template/19"
      },
    • {
      • "key": "16",
      • "id": "16",
      • "href": "/objects/order-entry/renewal-template/20"
      },
    • {
      • "key": "17",
      • "id": "17",
      • "href": "/objects/order-entry/renewal-template/21"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a renewal template
post/objects/order-entry/renewal-template
Creates a new order entry renewal template.


SecurityOAuth2 
Request 
Request Body schema: application/json
name
string
Id for the order entry renewal template.


 
 Example:  "Sales Renewal Template Id"
description
string  <= 100 characters 
Description about the renewal template.


 
 Example:  "Template for subscription renewals."
object
 
enableTxnCreation
boolean
 Default:  false
Indicates whether Sage Intacct should create a new sales transaction as part of the renewal.


 
 Example:  false
object
It is a reference for list of existing transaction definitions.


 
key
string
Order entry transaction definition key.


 
 Example:  "1"
id
string
Order entry transaction definition id.


 
 Example:  "Sales Invoice"
daysBeforeAfter
integer  <= 4 characters 
 Default:  10
The number of days before or after the source contract end date that Sage Intacct should create the sales transaction.


 
 Example:  10
beforeOrAfterContractEnd
string
 Default:  "before"
Indicates whether Sage Intacct should create the transaction before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
txnDateOnRenewedDocument
string
 Default:  "contractEndDatePlusOneDay"
Establishes how the date on the sales transaction created by the renewal is determined.
** Valid Options: ** 
calculatedDate: Sage Intacct uses the transaction line item end date and adds or subtracts days based on the values of the beforeOrAfterContractEnd and daysBeforeAfter fields. 
contractEndDatePlusOneDay: the system adds one day to the transaction line item end date.


 Enum: "calculatedDate" "contractEndDatePlusOneDay"  
 Example:  "calculatedDate"
txnLineItemStartDate
string
 Default:  "sameAsDocumentDate"
Establishes how the line item start date on the sales transaction created by the renewal is determined:
 ** Valid Options: ** 


    

  • sameAsDocumentDate: Sage Intacct uses the transaction date on the new sales transaction as the line item start date.
    • 

  • inheritOffsetFromParent - Sage Intacct keeps the number of days between the transaction date and the line item start date the same as exists in the source sales transaction.
    • 



 Enum: "sameAsDocumentDate" "withInheritedOffsetFromParent"  
 Example:  "sameAsDocumentDate"
object
Select the desired Pricing option for contract renewal.


 
pricingType
string
 Default:  "sameAsOriginal"
Contract Pricing for the sales line item type
 Options are, 
   ** Valid Options: *
    - Same as original- the renewed contract will use the same price for the line item as in the original sales transaction.
    - Suggested price (Default pricing) - Intacct will use the suggested price for the renewed lines, if applicable. 
    - Markup or markdown - Intacct will either discount or mark up the line item by the indicated percentage or actual amount. 
     Choose one of the following for markup or markdown:
       -Percentage markup
       -Percentage markdown
       -Actual markup
       -Actual markdown


 Enum: "defaultPricing" "markupOrMarkdown" "sameAsOriginal"  
 Example:  "sameAsOriginal"
markup
string
 Default:  "percentageMarkup"
Pricing markup. Markup or markdown: Intacct will either discount or mark up the line item by the indicated percentage or actual amount. 


** Valid Options: **
 Choose one of the following for markup:
     -Percentage markup
     -Percentage markdown
     -Actual markup
     -Actual markdown
 For percentages, indicate the percentage as a whole number (for example, 5). For amounts, indicate the amount value (for example, 500.00).


 Enum: "actualDiscount" "actualMarkup" "percentageDiscount" "percentageMarkup"  
 Example:  "percentageMarkup"
markupValue
string  <= 6 characters 
Pricing markup by value.


 
 Example:  "1.00"
object
renewalNotifications group specifies the properties about customer and internal Email group. More details are mentioned in properties.


 
object
The customerEmail group specifies whether Sage Intacct sends an email to the customer as part of the renewal process when the customer email Notifications are enabled.
If yes, select an Email template, add from and to.
From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template.


 
enableNotification
boolean
 Default:  false
Flag to enable notification.


 
 Example:  false
from
string  <= 30 characters 
Enter an email address you want the recipient to reply to.


 
 Example:  "[email protected]"
to
string
 Default:  "customerContact"
Customer contact email id.
** Valid Options: **


    

  • customerContact: The email id from customer contact.
    • 

  • customerBillToContact: The contact from the bill to email id of the customer’s bill to contact. 
    • 

  • customerShipToContact: The contact from the ship to email id of the customer’s ship to contact..
    • 



 Enum: "customerBillToContact" "customerContact" "customerShipToContact"  
 Example:  "customerContact"
daysBeforeAfter
integer  <= 4 characters 
 Default:  0
The number of days before or after the source contract end date that Sage Intacct should send the customer email.


 
 Example:  1
beforeOrAfterContractRenewal
string or null
 Default:  "before"
Indicates whether Sage Intacct should send the customer email before or after the source contract end date.


 Enum: "after" "before" null  
 Example:  "before"
object
Intacct recommends that you use an email template for renewal templates for sending email to customer. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text.


 
object
The internalEmail group specifies if the Sage Intacct sends an email to the customer as part of the renewal process when the internal email Notifications are enabled., they want to keep the draft or reply internal contact as well. If yes, select an Email template, add from and to.


From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template.


 
enableNotification
boolean
 Default:  false
Enable / disable Internal email.


 
 Example:  false
from
string
From email id.


 
 Example:  "[email protected]"
to
string
To email address.


 
 Example:  "[email protected]"
beforeOrAfterContractRenewal
string
 Default:  "before"
Indicates whether Sage Intacct should send the internal email before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
daysBeforeAfter
integer  <= 4 characters 
 Default:  10
The number of days before or after the source contract end date that Sage Intacct should send the internal email.


 
 Example:  10
object
Intacct recommends that you use an email template for renewal templates for sending email internally. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text.


 
object
The salesforceOpportunity Group indicates whether a new opportunity should be created in Salesforce when the renewal occurs,specifying daysBeforeAfter,renewalName,beforeOrAfterContractRenewal,inheritProductsFromParent & stage.


 
enableSalesforceOpportunity
boolean
 Default:  false
Enable Salesforce opportunity in salesforce when the renewal occurs.


 
 Example:  false
beforeOrAfterContractRenewal
string
 Default:  "before"
Indicates whether Sage Intacct should create the Salesforce opportunity before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
daysBeforeAfter
string  <= 4 characters 
 Default:  "10"
The number of days before or after the source contract end date that the opportunity should be created in Salesforce.


 
 Example:  "10"
renewalName
string
Renewal name, If you do not want to use a naming convention but rather want a specific name for the new opportunity, enter the name in this field.


 
 Example:  "SOrderRevRecActAlertSalesTeam"
inheritProductsFromParent
boolean
 Default:  false
Indicates whether Sage Intacct should populate the new opportunity with the same products (items) that existed in the original opportunity.


 
 Example:  false
stage
string
 Default:  "closedLost"
Set the Salesforce opportunity stage for the new opportunity.
 ** Valid Options: **


    

  • Prospecting 
    • 

  • Qualification
    • 

  • Needs Analysis
    • 

  • Value Proposition
    • 

  • Id. Decision Makers
    • 

  • Perception Analysis
    • 

  • Proposal/Price Quote
    • 

  • Negotiation/Review
    • 

  • Closed Won
    • 

  • Closed Lost
    • 

  • null
    • 



 Enum: "closedLost" "closedWon" "idDecisionMakers" "needsAnalysis" "negotiationReview" null "proposalPriceQuote" "prospecting" "qualification" "valueProposition"  
 Example:  "prospecting"
transactionType
string
 Default:  "salesTransaction"
Transaction type is the module for which the renewal template transaction type can be created. Sales Transaction(order entry) or Contract or Evergreen


 Enum: "contract" "evergreen" "salesTransaction"  
 Example:  "salesTransaction"
renewalState
string or null
 Default:  "inProgress"
Create renewal as.


 Enum: "draft" "inProgress" null  
 Example:  "inProgress"
object
The defaultTerm group is specifically for contract module, the default term legnth & default period for which the renewal template is created.


 
period
string
 Default:  "months"
Default renewal term period unit, in years, months and days.


 Enum: "days" "months" "years"  
 Example:  "months"
length
string  <= 2 characters 
Default renewal term length in numbers.


 
 Example:  "5"
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
{
  • "name": "Testing1212qw1",
  • "description": "kk",
  • "salesTxnCreation": {
    • "enableTxnCreation": true,
    • "transactionDefinition": {
      • "id": null,
      • "key": null
      },
    • "daysBeforeAfter": 9,
    • "beforeOrAfterContractEnd": "after",
    • "txnDateOnRenewedDocument": "contractEndDatePlusOneDay",
    • "txnLineItemStartDate": "sameAsDocumentDate"
    },
  • "contractPricing": {
    • "pricingType": "defaultPricing",
    • "markup": "percentageMarkup",
    • "markupValue": null
    },
  • "renewalNotifications": {
    • "customerEmail": {
      • "enableNotification": false,
      • "from": null,
      • "to": "customerContact",
      • "daysBeforeAfter": 0,
      • "beforeOrAfterContractRenewal": "before",
      • "emailTemplate": {
        }
      },
    • "internalEmail": {
      • "enableNotification": false,
      • "from": null,
      • "to": null,
      • "daysBeforeAfter": 10,
      • "beforeOrAfterContractRenewal": "before",
      • "emailTemplate": {
        }
      }
    },
  • "salesforceOpportunity": {
    • "enableSalesforceOpportunity": false,
    • "daysBeforeAfter": 10,
    • "beforeOrAfterContractRenewal": "before"
    },
  • "status": "active",
  • "transactionType": "contract",
  • "defaultTerm": {
    • "length": 2,
    • "period": "months"
    },
  • "renewalState": "inProgress"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30",
    • "id": "30",
    • "href": "/objects/order-entry/renewal-template/30"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  19
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": 24,
    • "key": 24,
    • "name": "Testing1212qw",
    • "description": "kk",
    • "salesTxnCreation": {
      • "enableTxnCreation": "true",
      • "transactionDefinition": {
        },
      • "daysBeforeAfter": 9,
      • "beforeOrAfterContractEnd": "after",
      • "txnDateOnRenewedDocument": "contractEndDatePlusOneDay",
      • "txnLineItemStartDate": "sameAsDocumentDate"
      },
    • "contractPricing": {
      • "pricingType": "defaultPricing",
      • "markup": "percentageMarkup",
      • "markupValue": null
      },
    • "renewalNotifications": {
      • "customerEmail": {
        },
      • "internalEmail": {
        }
      },
    • "salesforceOpportunity": {
      • "enableSalesforceOpportunity": "false",
      • "daysBeforeAfter": 10,
      • "beforeOrAfterContractRenewal": "before",
      • "renewalName": null,
      • "inheritProductsFromParent": "false",
      • "stage": null
      },
    • "latestVersion": null,
    • "status": "active",
    • "transactionType": "contract",
    • "defaultTerm": {
      • "length": 2,
      • "period": "months"
      },
    • "renewalState": "inProgress",
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "href": "/objects/order-entry/renewal-template/24"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  19
Request Body schema: application/json
name
string
Id for the order entry renewal template.


 
 Example:  "Sales Renewal Template Id"
description
string  <= 100 characters 
Description about the renewal template.


 
 Example:  "Template for subscription renewals."
object
 
enableTxnCreation
boolean
 Default:  false
Indicates whether Sage Intacct should create a new sales transaction as part of the renewal.


 
 Example:  false
object
It is a reference for list of existing transaction definitions.


 
key
string
Order entry transaction definition key.


 
 Example:  "1"
id
string
Order entry transaction definition id.


 
 Example:  "Sales Invoice"
daysBeforeAfter
integer  <= 4 characters 
 Default:  10
The number of days before or after the source contract end date that Sage Intacct should create the sales transaction.


 
 Example:  10
beforeOrAfterContractEnd
string
 Default:  "before"
Indicates whether Sage Intacct should create the transaction before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
txnDateOnRenewedDocument
string
 Default:  "contractEndDatePlusOneDay"
Establishes how the date on the sales transaction created by the renewal is determined.
** Valid Options: ** 
calculatedDate: Sage Intacct uses the transaction line item end date and adds or subtracts days based on the values of the beforeOrAfterContractEnd and daysBeforeAfter fields. 
contractEndDatePlusOneDay: the system adds one day to the transaction line item end date.


 Enum: "calculatedDate" "contractEndDatePlusOneDay"  
 Example:  "calculatedDate"
txnLineItemStartDate
string
 Default:  "sameAsDocumentDate"
Establishes how the line item start date on the sales transaction created by the renewal is determined:
 ** Valid Options: ** 


    

  • sameAsDocumentDate: Sage Intacct uses the transaction date on the new sales transaction as the line item start date.
    • 

  • inheritOffsetFromParent - Sage Intacct keeps the number of days between the transaction date and the line item start date the same as exists in the source sales transaction.
    • 



 Enum: "sameAsDocumentDate" "withInheritedOffsetFromParent"  
 Example:  "sameAsDocumentDate"
object
Select the desired Pricing option for contract renewal.


 
pricingType
string
 Default:  "sameAsOriginal"
Contract Pricing for the sales line item type
 Options are, 
   ** Valid Options: *
    - Same as original- the renewed contract will use the same price for the line item as in the original sales transaction.
    - Suggested price (Default pricing) - Intacct will use the suggested price for the renewed lines, if applicable. 
    - Markup or markdown - Intacct will either discount or mark up the line item by the indicated percentage or actual amount. 
     Choose one of the following for markup or markdown:
       -Percentage markup
       -Percentage markdown
       -Actual markup
       -Actual markdown


 Enum: "defaultPricing" "markupOrMarkdown" "sameAsOriginal"  
 Example:  "sameAsOriginal"
markup
string
 Default:  "percentageMarkup"
Pricing markup. Markup or markdown: Intacct will either discount or mark up the line item by the indicated percentage or actual amount. 


** Valid Options: **
 Choose one of the following for markup:
     -Percentage markup
     -Percentage markdown
     -Actual markup
     -Actual markdown
 For percentages, indicate the percentage as a whole number (for example, 5). For amounts, indicate the amount value (for example, 500.00).


 Enum: "actualDiscount" "actualMarkup" "percentageDiscount" "percentageMarkup"  
 Example:  "percentageMarkup"
markupValue
string  <= 6 characters 
Pricing markup by value.


 
 Example:  "1.00"
object
renewalNotifications group specifies the properties about customer and internal Email group. More details are mentioned in properties.


 
object
The customerEmail group specifies whether Sage Intacct sends an email to the customer as part of the renewal process when the customer email Notifications are enabled.
If yes, select an Email template, add from and to.
From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template.


 
enableNotification
boolean
 Default:  false
Flag to enable notification.


 
 Example:  false
from
string  <= 30 characters 
Enter an email address you want the recipient to reply to.


 
 Example:  "[email protected]"
to
string
 Default:  "customerContact"
Customer contact email id.
** Valid Options: **


    

  • customerContact: The email id from customer contact.
    • 

  • customerBillToContact: The contact from the bill to email id of the customer’s bill to contact. 
    • 

  • customerShipToContact: The contact from the ship to email id of the customer’s ship to contact..
    • 



 Enum: "customerBillToContact" "customerContact" "customerShipToContact"  
 Example:  "customerContact"
daysBeforeAfter
integer  <= 4 characters 
 Default:  0
The number of days before or after the source contract end date that Sage Intacct should send the customer email.


 
 Example:  1
beforeOrAfterContractRenewal
string or null
 Default:  "before"
Indicates whether Sage Intacct should send the customer email before or after the source contract end date.


 Enum: "after" "before" null  
 Example:  "before"
object
Intacct recommends that you use an email template for renewal templates for sending email to customer. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text.


 
object
The internalEmail group specifies if the Sage Intacct sends an email to the customer as part of the renewal process when the internal email Notifications are enabled., they want to keep the draft or reply internal contact as well. If yes, select an Email template, add from and to.


From, to, Email text are the fields only applicable to legacy renewal templates. For new renewal templates, select an Email template.


 
enableNotification
boolean
 Default:  false
Enable / disable Internal email.


 
 Example:  false
from
string
From email id.


 
 Example:  "[email protected]"
to
string
To email address.


 
 Example:  "[email protected]"
beforeOrAfterContractRenewal
string
 Default:  "before"
Indicates whether Sage Intacct should send the internal email before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
daysBeforeAfter
integer  <= 4 characters 
 Default:  10
The number of days before or after the source contract end date that Sage Intacct should send the internal email.


 
 Example:  10
object
Intacct recommends that you use an email template for renewal templates for sending email internally. If a pertinent email address is updated in Intacct, the email template can automatically pick up the new email address. The email template can contain the appropriate From/To email address parameters and customized text.


 
object
The salesforceOpportunity Group indicates whether a new opportunity should be created in Salesforce when the renewal occurs,specifying daysBeforeAfter,renewalName,beforeOrAfterContractRenewal,inheritProductsFromParent & stage.


 
enableSalesforceOpportunity
boolean
 Default:  false
Enable Salesforce opportunity in salesforce when the renewal occurs.


 
 Example:  false
beforeOrAfterContractRenewal
string
 Default:  "before"
Indicates whether Sage Intacct should create the Salesforce opportunity before or after the source contract end date.


 Enum: "after" "before"  
 Example:  "before"
daysBeforeAfter
string  <= 4 characters 
 Default:  "10"
The number of days before or after the source contract end date that the opportunity should be created in Salesforce.


 
 Example:  "10"
renewalName
string
Renewal name, If you do not want to use a naming convention but rather want a specific name for the new opportunity, enter the name in this field.


 
 Example:  "SOrderRevRecActAlertSalesTeam"
inheritProductsFromParent
boolean
 Default:  false
Indicates whether Sage Intacct should populate the new opportunity with the same products (items) that existed in the original opportunity.


 
 Example:  false
stage
string
 Default:  "closedLost"
Set the Salesforce opportunity stage for the new opportunity.
 ** Valid Options: **


    

  • Prospecting 
    • 

  • Qualification
    • 

  • Needs Analysis
    • 

  • Value Proposition
    • 

  • Id. Decision Makers
    • 

  • Perception Analysis
    • 

  • Proposal/Price Quote
    • 

  • Negotiation/Review
    • 

  • Closed Won
    • 

  • Closed Lost
    • 

  • null
    • 



 Enum: "closedLost" "closedWon" "idDecisionMakers" "needsAnalysis" "negotiationReview" null "proposalPriceQuote" "prospecting" "qualification" "valueProposition"  
 Example:  "prospecting"
transactionType
string
 Default:  "salesTransaction"
Transaction type is the module for which the renewal template transaction type can be created. Sales Transaction(order entry) or Contract or Evergreen


 Enum: "contract" "evergreen" "salesTransaction"  
 Example:  "salesTransaction"
renewalState
string or null
 Default:  "inProgress"
Create renewal as.


 Enum: "draft" "inProgress" null  
 Example:  "inProgress"
object
The defaultTerm group is specifically for contract module, the default term legnth & default period for which the renewal template is created.


 
period
string
 Default:  "months"
Default renewal term period unit, in years, months and days.


 Enum: "days" "months" "years"  
 Example:  "months"
length
string  <= 2 characters 
Default renewal term length in numbers.


 
 Example:  "5"
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
{
  • "description": "Subscription Invoice RevRec Creation Markup price.-New"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "30",
    • "id": "30",
    • "href": "/objects/order-entry/renewal-template/30"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  19
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query renewal templates
post/services/core/query
Use the query service to find renewal templates that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples