Bulk Revenue Schedule Generation (POST)

Create revenue schedules for a collection of opportunity line items.

Resource

1connect/media/asm/actions/generate-revenue-schedules

Example URI

1https://yourInstance.salesforce.com/services/data/65.0/connect/media/asm/actions/generate-revenue-schedules

Available version

65.0

HTTP methods

POST

Request parameters for POST

Input Representation: RevenueScheduleGenerationBulkInput

Parameter Name	Type	Description	Required or Optional	Available Version
endDate	String	The end date of the opportunity line items for which revenue schedules must be generated.	Optional	65.0
opportunityId	String	The ID of the opportunity that consists of the line items for which revenue schedules must be generated.	Optional	65.0
opportunityLineItemList	List<String>	The IDs of the opportunity line items for which revenue schedules must be generated.	Optional	65.0
calendarType	Enum	Specifies the type of calendar based on which revenue schedules are generated for the opportunity line items. Possible values are Broadcast and Gregorian.	Required	65.0
revenueSchedulePeriodType	Enum	Specifies the type of period for which revenue schedules must be generated.	Required	65.0
revenueDistributionType	Enum	Specifies the method in which the opportunity line item revenue is distributed across the schedules that must be generated.	Required	65.0

Request body for POST

1{
2    "endDate":"", //format dd-mm-yyyy
3    "opportunityLineItemIds":[],
4    "oppId": "53534534",
5    "calendarType": "broadcast",
6    "period":"monthly",
7    "revenueDistributionType": "prorated"
8}

Response parameters for POST

Output Representation: RevenueScheduleGenerationBulk

Parameter Name	Type	Description	Required or Optional	Available Version
status	String	The status of the asynchronous job that was executed to generate opportunity line item revenue schedules.	Required	65
message	String	The message that indicates the status of the revenue schedule generation request.	Optional	65
error	String	The details of the error due to which the asynchronous job that generates revenue schedules wasn't executed.	Optional	65
jobUrl	String	The URL of the asynchronous job that was executed to generate opportunity line item revenue schedules.	Required	65

Async Output Details

Parameter Name	Type	Description	Required or Optional	Available Version
status	String	The status of the asynchronous job that was executed to generate opportunity line item revenue schedules.	Required	65.0
message	String	The message that indicates the status of the revenue schedule generation request.	Optional	65.0
error	String	The details of the error due to which the asynchronous job that generates revenue schedules wasn't executed.	Optional	65.0

Response body for POST

1{
2"status": "SUCCESS",
3"message": "Sent request for async schedule generation successfully",
4"jobId":"Id"
5}

In error scenario (when end date is missing for one or more Opportunity Products):

1{
2   "status":"FAILED",
3   "error": "Bad Request",
4   "message": "End date must be populated for all Opp Products"
5}

Media Cloud Developer Guide

Bulk Revenue Schedule Generation (POST)