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", 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
{
  • "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
 Default:  "before"
Indicates whether Sage Intacct should send the customer email before or after the source contract end date.


 Enum: "" "after" "before"  
 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
 Default:  "inProgress"
Create renewal as.


 Enum: "" "draft" "inProgress"  
 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.


 
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.


 
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
 Default:  "before"
Indicates whether Sage Intacct should send the customer email before or after the source contract end date.


 Enum: "" "after" "before"  
 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
 Default:  "inProgress"
Create renewal as.


 Enum: "" "draft" "inProgress"  
 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.


 
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
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
    }
}