Revenue Schedule Retrieval (POST)

Get the details of a list of revenue schedules for a media opportunity.

Resource 

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

Resource Example 

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

Where YOUR_INSTANCE is a variable.

Available Version 

65.0.0

HTTP Methods 

POST

Request Body for POST 

JSON Example 

1{
2  "type": "periodic",
3  "opportunityId": "006xx000001a2ogAAA",
4  "additionalFieldList": [
5    "AdOpportunityLineItem.EndDate",
6    "AdOpportunityLineItem.CalendarType",
7    "OpportunityLineItemSchedule.ScheduleDate",
8    "OpportunityLineItemSchdActual.StartDate",
9    "OpportunityLineItem.Name",
10    "OpportunityLineItem.Product2Id",
11    "Product2.Id"
12  ],
13  "periodType": "monthly",
14  "calendarType": "gregorian",
15  "pageSize": 2,
16  "offset": 0
17}

Properties 

Input Representation: RevenueScheduleRetrievalInput

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
typeEnumSpecifies the type of revenue schedules to retrieve.Required65.0
opportunityIdStringThe ID of the opportunity for which revenue schedules to retrieve.Required65.0
additionalFieldListList<String>The developer names of the additional Opportunity Line Item Schedule Actual fields to retrieve.Optional65.0
calendarTypeEnumSpecifies the type of calendar for which revenue schedules to retrieve.Required65.0
periodTypeEnumSpecifies the type of period for which revenue schedules to retrieve.Required65.0
pageSizeNumberSpecifies the number of months for which revenue schedules to retrieve.Required65.0
offsetNumberSpecifies the number of revenue schedules that must be skipped before retrieving revenue schedules.Required65.0

Response Body for POST 

JSON Example 

1{
2  "nextOffset": 3,
3  "hasMore": true,
4  "revenueScheduleDetailList": [
5    {
6      "period": "Jan 25",
7      "startDate": "2024-12-30T00:00:00.000Z",
8      "endDate": "2025-01-26T00:00:00.000Z",
9      "products": [
10        {
11          "productName": "WTVR",
12          "startDate": "2025-01-13T00:00:00.000Z",
13          "endDate": "2025-01-26T00:00:00.000Z",
14          "plannedBudget": 229.51,
15          "team": [
16            {
17              "name": "Alex",
18              "splitPerc": 50
19            },
20            {
21              "name": "Other Team Member",
22              "splitPerc": 50
23            }
24          ],
25          "bookedAmount": null,
26          "deliveredAmount": null,
27          "billedAmount": null,
28          "adjustedAmount": null,
29          "additionalFields": {
30            "Product2.Id": "01txx0000006i7hAAA",
31            "AdOpportunityLineItem.EndDate": "2025-09-30",
32            "OpportunityLineItemSchedule.ScheduleDate": "2025-06-03",
33            "OpportunityLineItem.Name": "Acme - 1,200 Widgets Admin Certification",
34            "OpportunityLineItemSchdActual.StartDate": "2025-06-03",
35            "OpportunityLineItem.Product2Id": "01txx0000006i7hAAA",
36            "AdOpportunityLineItem.CalendarType": "gregorian"
37          },
38          "lastUpdated": "2025-06-30T14:47:30.000Z"
39        },
40        {
41          "productName": "KASW",
42          "startDate": "2025-01-13T00:00:00.000Z",
43          "endDate": "2025-01-26T00:00:00.000Z",
44          "plannedBudget": 269.23,
45          "team": [
46            {
47              "name": "Eva",
48              "splitPerc": 50
49              
50            },
51            {
52              "name": "Other Team Member",
53              "splitPerc": 50
54            }
55          ],
56          "bookedAmount": null,
57          "deliveredAmount": null,
58          "billedAmount": null,
59          "adjustedAmount": null,
60          "additionalFields": {
61            "Product2.Id": "01txx0000006i7hAAA",
62            "AdOpportunityLineItem.EndDate": "2025-09-30",
63            "OpportunityLineItemSchedule.ScheduleDate": "2025-06-03",
64            "OpportunityLineItem.Name": "Acme - 1,200 Widgets Admin Certification",
65            "OpportunityLineItemSchdActual.StartDate": "2025-06-03",
66            "OpportunityLineItem.Product2Id": "01txx0000006i7hAAA",
67            "AdOpportunityLineItem.CalendarType": "gregorian"
68          },
69          "lastUpdated": "2025-06-30T14:47:30.000Z"
70        }
71      ]
72    },
73    {
74      "period": "Feb 25",
75      "startDate": "2025-02-27T00:00:00.000Z",
76      "endDate": "2025-03-23T00:00:00.000Z",
77      "products": [
78        {
79          "productName": "WTVR",
80          "startDate": "2025-02-27T00:00:00.000Z",
81          "endDate": "2025-03-23T00:00:00.000Z",
82          "plannedBudget": 459.02,
83          "team": [
84            {
85              "name": "Alex",
86              "splitPerc": 50
87            },
88            {
89              "name": "Other Team Member",
90              "splitPerc": 50
91            }
92          ],
93          "bookedAmount": null,
94          "deliveredAmount": null,
95          "billedAmount": null,
96          "adjustedAmount": null,
97          "additionalFields": {
98            "Product2.Id": "01txx0000006i7hAAA",
99            "AdOpportunityLineItem.EndDate": "2025-09-30",
100            "OpportunityLineItemSchedule.ScheduleDate": "2025-06-03",
101            "OpportunityLineItem.Name": "Acme - 1,200 Widgets Admin Certification",
102            "OpportunityLineItemSchdActual.StartDate": "2025-06-03",
103            "OpportunityLineItem.Product2Id": "01txx0000006i7hAAA",
104            "AdOpportunityLineItem.CalendarType": "gregorian"
105          },
106          "lastUpdated": "2025-06-30T14:47:30.000Z"
107        },
108        {
109          "productName": "KASW",
110          "startDate": "2025-02-27T00:00:00.000Z",
111          "endDate": "2025-03-23T00:00:00.000Z",
112          "plannedBudget": 538.46,
113          "team": [
114            {
115              "name": "Eva",
116              "splitPerc": 50
117            },
118            {
119              "name": "Other Team Member",
120              "splitPerc": 50
121            }
122          ],
123          "bookedAmount": null,
124          "deliveredAmount": null,
125          "billedAmount": null,
126          "adjustedAmount": null,
127          "additionalFields": {
128            "Product2.Id": "01txx0000006i7hAAA",
129            "AdOpportunityLineItem.EndDate": "2025-09-30",
130            "OpportunityLineItemSchedule.ScheduleDate": "2025-06-03",
131            "OpportunityLineItem.Name": "Acme - 1,200 Widgets Admin Certification",
132            "OpportunityLineItemSchdActual.StartDate": "2025-06-03",
133            "OpportunityLineItem.Product2Id": "01txx0000006i7hAAA",
134            "AdOpportunityLineItem.CalendarType": "gregorian"
135          },
136          "lastUpdated": "2025-06-30T14:47:30.000Z"
137        }
138      ]
139    }
140  ]
141  
142}

Properties 

Output Representation: RevenueScheduleRetrievalOutputRepresentation

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
errorStringThe details of the error due to which the revenue schedules weren’t retrieved.Required65.0
nextOffsetNumberSpecifies the number of records that are skipped in the output.Required65.0
hasMoreRevenueSchedulesbooleanIndicates that the opportunity has more revenue schedules that can be retrieved.Required65.0
revenueScheduleDetailListList<ScheduleDetailsOutputRepresentation>The details of the revenue schedules retrieved for the opportunity.Required65.0

Output Representation: ScheduleDetailsOutputRepresentation

Parameter NameTypeDescription
periodStringThe period that the revenue schedule belong to.
startDateDateThe start date of the revenue schedule.
endDateDateThe end date of the revenue schedule.
productListList<RevenueScheduleProductOutputRepresentation>The list of products that are part of the revenue schedule.

Output Representation: RevenueScheduleProductOutputRepresentation

Parameter NameTypeDescription
productNameStringThe name of the opportunity product that the revenue schedule is for.
startDateDateThe start date of the product’s schedule.
endDateDateThe end date of the product’s schedule.
plannedBudgetDoubleThe planned budget of the product’s schedule.
teamListList<TeamMemberOutputRepresentation>The list of team members across whom the revenue of the product’s schedule is split.
bookedAmountDoubleThe booked amount of the product’s schedule.
deliveredAmountDoubleThe delivered amount of the product’s schedule.
billedAmountDoubleThe billed amount of the product’s schedule.
adjustedAmountDoubleThe adjusted amount of the product’s schedule.
additionalFieldsMap<String, Object>The additional field values of the product’s schedule
lastUpdatedDateDateThe date and time on which the product’s schedule was last updated.

Output Representation: TeamMemberOutputRepresentation

Parameter NameTypeDescription
teamMemberNameStringThe name of the team member who is allocated a percentage of the opportunity revenue.
splitPercentageDoubleThe percentage of the opportunity revenue that’s allocated to the team member.