Revenue Schedule Retrieval (POST)

Resource

65.0.0

POST

Input Representation: RevenueScheduleRetrievalInput

Parameter Name	Type	Description	Required or Optional	Available Version
type	Enum	Specifies the type of revenue schedules to retrieve.	Required	65.0
opportunityId	String	The ID of the opportunity for which revenue schedules to retrieve.	Required	65.0
additionalFieldList	List<String>	The developer names of the additional Opportunity Line Item Schedule Actual fields to retrieve.	Optional	65.0
calendarType	Enum	Specifies the type of calendar for which revenue schedules to retrieve.	Required	65.0
periodType	Enum	Specifies the type of period for which revenue schedules to retrieve.	Required	65.0
pageSize	Number	Specifies the number of months for which revenue schedules to retrieve.	Required	65.0
offset	Number	Specifies the number of revenue schedules that must be skipped before retrieving revenue schedules.	Required	65.0

Output Representation: RevenueScheduleRetrievalOutputRepresentation

Parameter Name	Type	Description	Required or Optional	Available Version
error	String	The details of the error due to which the revenue schedules weren't retrieved.	Required	65.0
nextOffset	Number	Specifies the number of records that are skipped in the output.	Required	65.0
hasMoreRevenueSchedules	boolean	Indicates that the opportunity has more revenue schedules that can be retrieved.	Required	65.0
revenueScheduleDetailList	List<ScheduleDetailsOutputRepresentation>	The details of the revenue schedules retrieved for the opportunity.	Required	65.0

Output Representation: ScheduleDetailsOutputRepresentation

Parameter Name	Type	Description
period	String	The period that the revenue schedule belong to.
startDate	Date	The start date of the revenue schedule.
endDate	Date	The end date of the revenue schedule.
productList	List<RevenueScheduleProductOutputRepresentation>	The list of products that are part of the revenue schedule.

Output Representation: RevenueScheduleProductOutputRepresentation

Parameter Name	Type	Description
productName	String	The name of the opportunity product that the revenue schedule is for.
startDate	Date	The start date of the product's schedule.
endDate	Date	The end date of the product's schedule.
plannedBudget	Double	The planned budget of the product's schedule.
teamList	List<TeamMemberOutputRepresentation>	The list of team members across whom the revenue of the product's schedule is split.
bookedAmount	Double	The booked amount of the product's schedule.
deliveredAmount	Double	The delivered amount of the product's schedule.
billedAmount	Double	The billed amount of the product's schedule.
adjustedAmount	Double	The adjusted amount of the product's schedule.
additionalFields	Map<String, Object>	The additional field values of the product's schedule
lastUpdatedDate	Date	The date and time on which the product's schedule was last updated.

Output Representation: TeamMemberOutputRepresentation

Parameter Name	Type	Description
teamMemberName	String	The name of the team member who is allocated a percentage of the opportunity revenue.
splitPercentage	Double	The percentage of the opportunity revenue that's allocated to the team member.