Revenue schedules

A contract line specifies dates, pricing, and a revenue template. The revenue template defines the rules for how to schedule the revenue. Sage Intacct then generates a revenue schedule for the contract line based on the defined criteria.

A revenue schedule for a term contract shows when a contract line's deferred revenue is expected to be recognized during the contract line term. It shows the scheduled posting date and amount to be posted for each potential journal entry. For periods that have been posted, it shows the actual posting date, the exchange rate used (if applicable), and the amount posted.

A revenue schedule for an evergreen contract line shows when the revenue associated with the corresponding recurring billing period is scheduled to be posted or was posted.

List contract revenue schedules

get/objects/contracts/revenue-schedule

Returns up to 100 object references from the collection with a key, ID, and link for each revenue schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "84",
      • "href": "/objects/contracts/revenue-schedule/84"
      },
    • {
      • "key": "85",
      • "id": "85",
      • "href": "/objects/contracts/revenue-schedule/85"
      },
    • {
      • "key": "60",
      • "id": "60",
      • "href": "/objects/contracts/revenue-schedule/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a contract revenue schedule
get/objects/contracts/revenue-schedule/{key}
Returns detailed information for a specified contract revenue schedule.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the contract revenue schedule.


 
 Example:  1287
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1578",
    • "id": "1578",
    • "journal": "J1",
    • "status": "inProgress",
    • "estimateRevaluationDate": null,
    • "revenueScheduleLines": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/contract-revenue-schedule/1578"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a contract revenue schedule
patch/objects/contracts/revenue-schedule/{key}
Updates an existing contract revenue schedule by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the contract revenue schedule.


 
 Example:  1287
Request Body schema: application/json
Array of objects
Contract revenue schedule lines


 
 Array 
scheduledExchangeRate
string <decimal-precision-12> 
The exchange rate in effect on the contract line start date.


 
 Example:  "1.345"
sourceHours
string
Schedule line source hours from project or task. Used with 'approvedHours' to determine the percentage to be recognized.


 
 Example:  "118"
approvedHours
string
Schedule line approved hours. Used with 'sourceHours' to determine the percentage to be recognized.


 
 Example:  "16"
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "145",
  • "revenueScheduleLines": [
    • {
      • "key": "12",
      • "computationMemo": "Memo",
      • "scheduledAmount": "125.34"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "145",
    • "id": "145",
    • "href": "/objects/contracts/revenue-schedule/145"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query revenue schedules
post/services/core/query
Use the query service to find revenue schedules that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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