Revenue recognition templates

Revenue recognition templates define how to amortize deferred revenue. Each template is associated with an Accounts Receivable label or Order Entry Item GL group.

List revenue recognition templates

get/objects/accounts-receivable/revenue-recognition-template

Returns a collection with a key, ID, and link for each revenue recognition template.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "299",
      • "id": "299",
      • "href": "/objects/accounts-receivable/revenue-recognition-template/299"
      },
    • {
      • "key": "294",
      • "id": "294",
      • "href": "/objects/accounts-receivable/revenue-recognition-template/294"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a revenue recognition template
post/objects/accounts-receivable/revenue-recognition-template
Creates a new revenue recognition template.


SecurityOAuth2 
Request 
Request Body schema: application/json
Revenue recognition template creation.


id
required
string
Unique identifier for the revenue recognition template.


 
 Example:  "1001"
description
required
string
Description of the revenue recognition template.


 
 Example:  null
useStandard
boolean
 Default:  false
Indicates whether to use standard calendar amortization.


 
 Example:  null
schedulePeriod
string
The intervals at which Sage Intacct should schedule the journal entries to post.


 Enum: "annually" "daily" "monthly" "quarterly" "semiAnnually"  
 Example:  "daily"
postingDay
string
The day of the month the revenue should post.


 Enum: "1" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "2" "20" "21" "22" "23" "24" "25" "26" "27" "28" "29" "3" "30" "31" "4" "5" "6" "7" "8" "9" "daily" "endOfPeriod"  
 Example:  "endOfPeriod"
recognitionTerm
string
 Default:  "fixedPeriod"
Recognition term.


 Enum: "contractTerm" "fixedPeriod" "project"  
 Example:  "fixedPeriod"
resumeOption
string
 Default:  "walkforward"
System resume option.


 Enum: "catchUp" "walkforward"  
 Example:  "catchUp"
totalPeriods
string
Number of periods. If fixedPeriod is set for recognitionTerm Sage Intacct uses this value to generate the schedule.


 
 Example:  null
recognitionMethod
string
Recognition method.


 Enum: "custom" "exactDaysPerPeriod,prorateDays" "exactDaysPerPeriod,prorateDays,endOfPeriod" "milestone" "percentCompleted" "straightLine" "straightLine,percentAllocation" "straightLine,percentAllocation,endOfPeriod" "straightLine,prorateExactDays"  
 Example:  "straightLine"
recognitionStartDate
string
 Default:  "transactionDate"
Recognition start date.


 Enum: "transactionDate" "userSpecified"  
 Example:  "transactionDate"
postingMethod
string
 Default:  "manual"
Posting method.


 Enum: "automatic" "manual"  
 Example:  "manual"
latestVersion
string
Latest version key.


 
 Example:  null
milestoneSource
string
 Default:  "manual"
Percent or milestone source.


 Enum: "manual" "project"  
 Example:  "manual"
object
 
source
string or null
 Default:  null
For a Percent completed template, select whether to calculate at the project or task level.


 Enum: null "project" "task"  
 Example:  "project"
basedOn
string or null
 Default:  null
Method to use to calculate the completion percentage.


 Enum: "budgetedCostFromGL" "budgetedCostFromSummary" "budgetedHours" "estimatedHours" null "observed%Completed" "plannedHours"  
 Example:  "estimatedHours"
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
{
  • "id": "ProjectTaskEstimatedHours",
  • "description": "Project-Task Rev Rec based on Estimated Hours",
  • "useStandard": false,
  • "schedulePeriod": "monthly",
  • "postingDay": "endOfPeriod",
  • "totalPeriods": null,
  • "recognitionMethod": "percentCompleted",
  • "recognitionStartDate": "transactionDate",
  • "postingMethod": "manual",
  • "status": "active",
  • "recognitionTerm": "project",
  • "resumeOption": "walkforward",
  • "milestoneSource": "project",
  • "calculation": {
    • "source": "task",
    • "basedOn": "estimatedHours"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "19",
    • "href": "/objects/accounts-receivable/revenue-recognition-template/19"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a revenue recognition templates
get/objects/accounts-receivable/revenue-recognition-template{key}
Returns detailed information for a specified  revenue recognition template.


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


 
 Example:  103
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "14",
    • "id": "MilestoneObservedPercentComp",
    • "description": "Milestone Rev Rec based on Observed % Completed",
    • "useStandard": false,
    • "schedulePeriod": "monthly",
    • "postingDay": "endOfPeriod",
    • "totalPeriods": null,
    • "recognitionMethod": "milestone",
    • "recognitionStartDate": "transactionDate",
    • "postingMethod": "manual",
    • "status": "active",
    • "latestVersion": null,
    • "recognitionTerm": "project",
    • "resumeOption": "walkforward",
    • "milestoneSource": "project",
    • "calculation": {
      • "source": "task",
      • "basedOn": "observed%Completed"
      },
    • "audit": {
      • "createdDateTime": "2016-05-04T19:23:33Z",
      • "modifiedDateTime": "2016-05-04T19:23:33Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "href": "/objects/accounts-receivable/revenue-recognition-template/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a revenue recognition template
patch/objects/accounts-receivable/revenue-recognition-template{key}
Updates an existing revenue recognition template by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  103
Request Body schema: application/json
description
string
Description of the revenue recognition template.


 
 Example:  null
useStandard
boolean
 Default:  false
Indicates whether to use standard calendar amortization.


 
 Example:  null
schedulePeriod
string
The intervals at which Sage Intacct should schedule the journal entries to post.


 Enum: "annually" "daily" "monthly" "quarterly" "semiAnnually"  
 Example:  "daily"
postingDay
string
The day of the month the revenue should post.


 Enum: "1" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "2" "20" "21" "22" "23" "24" "25" "26" "27" "28" "29" "3" "30" "31" "4" "5" "6" "7" "8" "9" "daily" "endOfPeriod"  
 Example:  "endOfPeriod"
recognitionTerm
string
 Default:  "fixedPeriod"
Recognition term.


 Enum: "contractTerm" "fixedPeriod" "project"  
 Example:  "fixedPeriod"
resumeOption
string
 Default:  "walkforward"
System resume option.


 Enum: "catchUp" "walkforward"  
 Example:  "catchUp"
totalPeriods
string
Number of periods. If fixedPeriod is set for recognitionTerm Sage Intacct uses this value to generate the schedule.


 
 Example:  null
recognitionMethod
string
Recognition method.


 Enum: "custom" "exactDaysPerPeriod,prorateDays" "exactDaysPerPeriod,prorateDays,endOfPeriod" "milestone" "percentCompleted" "straightLine" "straightLine,percentAllocation" "straightLine,percentAllocation,endOfPeriod" "straightLine,prorateExactDays"  
 Example:  "straightLine"
recognitionStartDate
string
 Default:  "transactionDate"
Recognition start date.


 Enum: "transactionDate" "userSpecified"  
 Example:  "transactionDate"
postingMethod
string
 Default:  "manual"
Posting method.


 Enum: "automatic" "manual"  
 Example:  "manual"
latestVersion
string
Latest version key.


 
 Example:  null
milestoneSource
string
 Default:  "manual"
Percent or milestone source.


 Enum: "manual" "project"  
 Example:  "manual"
object
 
source
string or null
 Default:  null
For a Percent completed template, select whether to calculate at the project or task level.


 Enum: null "project" "task"  
 Example:  "project"
basedOn
string or null
 Default:  null
Method to use to calculate the completion percentage.


 Enum: "budgetedCostFromGL" "budgetedCostFromSummary" "budgetedHours" "estimatedHours" null "observed%Completed" "plannedHours"  
 Example:  "estimatedHours"
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
{
  • "key": "6",
  • "id": "MilestoneObservedPercentComp",
  • "description": "Milestone Rev Rec based on Observed percent completed",
  • "postingMethod": "manual"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "OETEMPLATE",
    • "href": "/objects/accounts-receivable/revenue-recognition-template/19"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a revenue recognition template
delete/objects/accounts-receivable/revenue-recognition-template{key}
Deletes a revenue recognition template. Only templates that are not tied to a transaction can be deleted.


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


 
 Example:  103
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 revenue recognition templates
post/services/core/query
Use the query service to find revenue recognition templates that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples