Ramp Deal Service

Output representation of the details of a created, updated, or deleted ramp deal.

JSON Example 

This example shows the sample response for the create, update, or view ramp deal requests.

1{
2  "correlationId": "0QLDU0000002t0Z4AQ",
3  "errors": [],
4  "salesTransactionContext": {
5    "SalesTransaction": [
6      {
7        "LegalEntity": null,
8        "Account": null,
9        "HeaderDistributionType": null,
10        "BillingCity": null,
11        "AccountBusinessType": null,
12        "HeaderDiscountType": null,
13        "businessObjectType": "Quote",
14        "QuoteAccount": null,
15        "EmployeeCount": null,
16        "SalesTransactionName": "WarrantyPriceRampAR",
17        "StartDate": null,
18        "HeaderDiscountValue": null,
19        "SalesTransactionType": null,
20        "Pricebook": "01sDU000000JGf4YAG",
21        "Opportunity": null,
22        "ShippingCountry": null,
23        "ShippingCity": null,
24        "BillingPostalCode": null,
25        "id": "0Q0DU0000002f3d0AA",
26        "BillToContact": null,
27        "CalculationStatus": "CompletedWithTax",
28        "Status": "Draft",
29        "LastPricedDate": null,
30        "Subtotal": 108.47145205479453,
31        "OriginalActionType": null,
32        "TotalAmount": 99.98,
33        "CurrencyIsoCode": null,
34        "ShippingStreet": null,
35        "SalesTransactionItem": [
36          {
37            "LegalEntity": null,
38            "ProductName": "Warranty",
39            "businessObjectType": "QuoteLineItem",
40            "Product": "01tDU000000EsWSYA0",
41            "ItemIsPrimarySegment": true,
42            "ListPrice": 49.99,
43            "ValidationResult": null,
44            "StartDate": "2024-08-23T00:00:00.000Z",
45            "ContractVolumePasId": null,
46            "BillingTreatment": null,
47            "PeriodBoundaryStartMonth": null,
48            "SalesTransactionSourceAsset": null,
49            "id": "0QLDU0000002t0Z4AQ",
50            "PartnerDiscountPercent": null,
51            "PriceWaterFall": "0QLDU0000002t0Z4AQ:548201414593252",
52            "ItemProductRecipient": null,
53            "BillingFrequency": "Annual",
54            "ProductCode": "W001",
55            "DerivedPricingAttribute": null,
56            "TaxTreatment": "1ttDU0000001oGKYAY",
57            "Subtotal": 8.491452054794523,
58            "ItemRampIdentifier": "RDI5b5ce52b2db4484",
59            "ItemSegmentName": "Trial",
60            "PricebookEntry": "01uDU000000f4LSYAY",
61            "DiscountAmount": null,
62            "PricingTermCount": 0.0849315068493151,
63            "NetUnitPrice": 0,
64            "ItemEffectiveGrantDate": null,
65            "ProductCategory": null,
66            "SalesTransactionAction": null,
67            "SalesTransactionActionType": null,
68            "SalesTransactionItemGroup": null,
69            "PeriodBoundaryDay": null,
70            "LineItemDistributionType": null,
71            "ProrationPolicy": "0muDU00000029ryYAA",
72            "ContractDiscountType": null,
73            "TransactionType": null,
74            "ParentReference": null,
75            "Discount": 100,
76            "ProductSellingModel": "0jPDU00000029zb2AA",
77            "PricingTermUnit": "Annual",
78            "PricingSource": null,
79            "StockKeepingUnit": null,
80            "PartnerUnitPrice": null,
81            "ItemTotalAdjustmentAmount": -8.491452054794523,
82            "SalesTransactionItemSource": "0QLDU0000002t0Z4AQ",
83            "ContractAttributePasId": null,
84            "SubscriptionTerm": 1,
85            "SellingModelType": "TermDefined",
86            "EndQuantity": 2,
87            "NetTotalPrice": 0,
88            "TotalLineAmount": 8.491452054794523,
89            "ItemSegmentType": "FreeTrial",
90            "ProductBasedOn": null,
91            "Deleted": null,
92            "BillingReference": null,
93            "ArePartialPeriodsAllowed": true,
94            "ItemRecordedPrice": null,
95            "CustomProductName": "Warranty",
96            "ItemSegmentIdentifier": "SEG4380006a1c2b416",
97            "SalesTransactionItemParent": "0Q0DU0000002f3d0AA",
98            "Quantity": 2,
99            "PeriodBoundary": "Anniversary",
100            "ContractDiscountValue": null,
101            "LineItemDiscountValue": null,
102            "ContractId": null,
103            "EndDate": "2024-09-22T00:00:00.000Z",
104            "ItemGroupSummarySubtotal": null,
105            "IsContracted": null,
106            "UnitPrice": 49.99,
107            "StartQuantity": 0,
108            "ContractPrice": null,
109            "TotalPrice": 0,
110            "ItemPath": null,
111            "LineItemDiscountType": null
112          },
113          {
114            "LegalEntity": null,
115            "ProductName": "Warranty",
116            "businessObjectType": "QuoteLineItem",
117            "Product": "01tDU000000EsWSYA0",
118            "ItemIsPrimarySegment": false,
119            "ListPrice": 49.99,
120            "ValidationResult": null,
121            "StartDate": "2024-09-23T00:00:00.000Z",
122            "ContractVolumePasId": null,
123            "BillingTreatment": null,
124            "PeriodBoundaryStartMonth": null,
125            "SalesTransactionSourceAsset": null,
126            "id": "0QLDU0000003CZ94AM",
127            "PartnerDiscountPercent": null,
128            "PriceWaterFall": "0QLDU0000003CZ94AM:548201414593252",
129            "ItemProductRecipient": null,
130            "BillingFrequency": "Annual",
131            "ProductCode": "W001",
132            "DerivedPricingAttribute": null,
133            "TaxTreatment": "1ttDU0000001oGKYAY",
134            "Subtotal": 99.98,
135            "ItemRampIdentifier": "RDI5b5ce52b2db4484",
136            "ItemSegmentName": "Year-1",
137            "PricebookEntry": "01uDU000000f4LSYAY",
138            "DiscountAmount": null,
139            "PricingTermCount": 1,
140            "NetUnitPrice": 49.99,
141            "ItemEffectiveGrantDate": null,
142            "ProductCategory": null,
143            "SalesTransactionAction": null,
144            "SalesTransactionActionType": null,
145            "SalesTransactionItemGroup": null,
146            "PeriodBoundaryDay": null,
147            "LineItemDistributionType": null,
148            "ProrationPolicy": "0muDU00000029ryYAA",
149            "ContractDiscountType": null,
150            "TransactionType": null,
151            "ParentReference": null,
152            "Discount": null,
153            "ProductSellingModel": "0jPDU00000029zb2AA",
154            "PricingTermUnit": "Annual",
155            "PricingSource": null,
156            "StockKeepingUnit": null,
157            "PartnerUnitPrice": null,
158            "ItemTotalAdjustmentAmount": 0,
159            "SalesTransactionItemSource": "0QLDU0000003CZ94AM",
160            "ContractAttributePasId": null,
161            "SubscriptionTerm": 1,
162            "SellingModelType": "TermDefined",
163            "EndQuantity": 2,
164            "NetTotalPrice": 99.98,
165            "TotalLineAmount": 99.98,
166            "ItemSegmentType": "Yearly",
167            "ProductBasedOn": null,
168            "Deleted": null,
169            "BillingReference": null,
170            "ArePartialPeriodsAllowed": true,
171            "ItemRecordedPrice": null,
172            "CustomProductName": "Warranty",
173            "ItemSegmentIdentifier": "SEG73ad7378e1ed4c5",
174            "SalesTransactionItemParent": "0Q0DU0000002f3d0AA",
175            "Quantity": 2,
176            "PeriodBoundary": "Anniversary",
177            "ContractDiscountValue": null,
178            "LineItemDiscountValue": null,
179            "ContractId": null,
180            "EndDate": "2025-08-22T00:00:00.000Z",
181            "ItemGroupSummarySubtotal": null,
182            "IsContracted": null,
183            "UnitPrice": 49.99,
184            "StartQuantity": 0,
185            "ContractPrice": null,
186            "TotalPrice": 99.98,
187            "ItemPath": null,
188            "LineItemDiscountType": null
189          }
190        ],
191        "AppUsageAssignment": [
192          {
193            "businessObjectType": "AppUsageAssignment",
194            "ParentReference": null,
195            "Record": "0Q0DU0000002f3d0AA",
196            "id": "0j8DU0000002VKiYAM",
197            "AppUsageType": "RevenueLifecycleManagement"
198          }
199        ],
200        "BillingCountry": null,
201        "BillingStreet": null,
202        "ShippingPostalCode": null,
203        "SalesTransactionSource": "0Q0DU0000002f3d0AA",
204        "PrimaryIndustry": null,
205        "ShippingState": null,
206        "HeaderDistributionLogic": null,
207        "Contract": null,
208        "BillingState": null,
209        "AnnualRevenue": null,
210        "EffectiveDate": null
211      }
212    ]
213  },
214  "success": true,
215  "transactionContextId": "d3fd83b007418ce4980340313b40fd45665b194973486ebac3674c2b8002336f"
216}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
correlation​IdStringResource ID to correlate the API request with the response.Small, 62.062.0
errorsRamp Deal Service Error Response[]List of errors encountered during the processing of the API request.Small, 62.062.0
sales​Transaction​ContextMap<String, Object>Context object for the sales transaction with updated segment details.Small, 62.062.0
successBooleanIndicates whether the API request is successful (true) or not (false).Small, 62.062.0
transaction​ContextIdStringID of the sales transaction context record instance.Small, 62.062.0