Documentation Changelog
Extensibility for TMF APIs
Use Cases
Resource Mappings
TMFTMForumTransformQuoteRequest
TMFTMForumTransformQuoteResponse
TMFTMForumTransformCreateQuoteRequest
Custom Metadata
Known Issues
FAQ
Data Mapper which is responsible for transforming the Vlocity Data Model to TMForum data model for Quote Management.
1{
2 "Status": true,
3 "Type": "DataRaptor Transform Action",
4 "ElapsedTime": 248,
5 "ElapsedTimeCPU": 233,
6 "Input": [
7 {
8 "version": "V1",
9 "requestUrl": "/services/apexrest/vlocity_cmt/tmforum/quote",
10 "relatedParties": [
11 {
12 "type": "Account",
13 "relatedPartyHref": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/1234",
14 "referredType": "Account",
15 "name": "Common Org Account",
16 "id": "1234"
17 },
18 {
19 "type": "Contact",
20 "relatedPartyHref": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contact/003Do00000PSgbhIAD",
21 "referredType": "Contact",
22 "name": "common",
23 "id": "003Do00000PSgbhIAD"
24 }
25 ],
26 "quotePrices": [
27 {
28 "value": 1,
29 "unit": "$",
30 "recurringChargePeriod": null,
31 "priceType": "Recurring",
32 "priceAlteration": null
33 },
34 {
35 "value": 0,
36 "unit": "$",
37 "recurringChargePeriod": null,
38 "priceType": "One-time",
39 "priceAlteration": null
40 }
41 ],
42 "quoteLineItems": [
43 {
44 "status": null,
45 "quoteItemRelationships": [],
46 "quoteItemRelatedParties": [
47 {
48 "type": "Service Account",
49 "relatedPartyHref": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/001Do00000MfpkgIAB",
50 "referredType": "Account",
51 "name": "Common Org Account",
52 "id": "001Do00000MfpkgIAB"
53 }
54 ],
55 "quoteItemPrices": [
56 {
57 "value": 10,
58 "unit": "$",
59 "recurringChargePeriod": null,
60 "priceType": "Recurring",
61 "priceAlteration": null
62 },
63 {
64 "value": 20,
65 "unit": "$",
66 "recurringChargePeriod": null,
67 "priceType": "One-time",
68 "priceAlteration": null
69 }
70 ],
71 "quantity": 1,
72 "productOfferings": [
73 {
74 "type": "Product2",
75 "name": "TMF648 Product",
76 "id": "198fbc33-9cf4-ac60-e44d-f1682c741179",
77 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Product2/198fbc33-9cf4-ac60-e44d-f1682c741179"
78 }
79 ],
80 "product": null,
81 "id": "00000653",
82 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/QuoteLineItem/00000653",
83 "action": "Add"
84 }
85 ],
86 "quote": {
87 "attributes": {
88 "type": "Quote",
89 "url": "/services/data/v59.0/sobjects/Quote/0Q0Do000000t2F3KAI"
90 },
91 "QuoteNumber": "00001204",
92 "Description": "TMF648 Quote",
93 "vlocity_cmt__Type__c": "Existing Customer - Upgrade",
94 "CreatedDate": "2023-09-13T03:46:02.000+0000",
95 "Status": "Draft",
96 "ContractId": "800Do000000HiJtIAK",
97 "vlocity_cmt__DefaultBillingAccountId__c": "001Do00000NS6S9IAL",
98 "AccountId": "001Do00000MfpkgIAB",
99 "ContactId": "003Do00000PSgbhIAD",
100 "Email": "abc@salesforce.com",
101 "Fax": "abc",
102 "Phone": "(990) 099-7788",
103 "vlocity_cmt__EffectiveOneTimeTotal__c": 0,
104 "vlocity_cmt__EffectiveRecurringTotal__c": 1,
105 "Id": "0Q0Do000000t2F3KAI",
106 "Contract": {
107 "attributes": {
108 "type": "Contract",
109 "url": "/services/data/v59.0/sobjects/Contract/800Do000000HiJtIAK"
110 },
111 "ContractNumber": "00000945",
112 "Id": "800Do000000HiJtIAK"
113 },
114 "vlocity_cmt__DefaultBillingAccountId__r": {
115 "attributes": {
116 "type": "Account",
117 "url": "/services/data/v59.0/sobjects/Account/001Do00000NS6S9IAL"
118 },
119 "AccountNumber": "CD123",
120 "Name": "Acme",
121 "Id": "001Do00000NS6S9IAL"
122 },
123 "Account": {
124 "attributes": {
125 "type": "Account",
126 "url": "/services/data/v59.0/sobjects/Account/001Do00000MfpkgIAB"
127 },
128 "Name": "Common Org Account",
129 "AccountNumber": "1234",
130 "Id": "001Do00000MfpkgIAB"
131 },
132 "Contact": {
133 "attributes": {
134 "type": "Contact",
135 "url": "/services/data/v59.0/sobjects/Contact/003Do00000PSgbhIAD"
136 },
137 "Name": "common",
138 "Id": "003Do00000PSgbhIAD"
139 }
140 },
141 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/quote/00001204",
142 "effectiveQuoteCompletionDate": null,
143 "contactMedium": [
144 {
145 "mediumType": "Email",
146 "mediumCharacteristics": {
147 "phoneNumber": null,
148 "faxNumber": null,
149 "emailAddress": "abc@salesforce.com",
150 "contactType": "Email"
151 }
152 },
153 {
154 "mediumType": "Phone",
155 "mediumCharacteristics": {
156 "phoneNumber": "(990) 099-7788",
157 "faxNumber": null,
158 "emailAddress": null,
159 "contactType": "Phone"
160 }
161 },
162 {
163 "mediumType": "Fax",
164 "mediumCharacteristics": {
165 "phoneNumber": null,
166 "faxNumber": "abc",
167 "emailAddress": null,
168 "contactType": "Fax"
169 }
170 }
171 ],
172 "billingAccountHref": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/CD123",
173 "apiVersion": "v57.0",
174 "agreementHref": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contract/00000945"
175 }
176 ]
177}1{
2 "contactMedium": [
3 {
4 "characteristic": {
5 "emailAddress": "abc@salesforce.com",
6 "contactType": "Email"
7 },
8 "mediumType": "Email"
9 },
10 {
11 "characteristic": {
12 "phoneNumber": "(990) 099-7788",
13 "contactType": "Phone"
14 },
15 "mediumType": "Phone"
16 },
17 {
18 "characteristic": {
19 "faxNumber": "abc",
20 "contactType": "Fax"
21 },
22 "mediumType": "Fax"
23 }
24 ],
25 "quoteItem": [
26 {
27 "productOffering": [
28 {
29 "name": "TMF648 Product",
30 "id": "198fbc33-9cf4-ac60-e44d-f1682c741179",
31 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Product2/198fbc33-9cf4-ac60-e44d-f1682c741179",
32 "@type": "Product2"
33 }
34 ],
35 "quoteItemPrice": [
36 {
37 "price": {
38 "taxIncludedAmount": {
39 "value": 10,
40 "unit": "$"
41 }
42 },
43 "priceType": "Recurring"
44 },
45 {
46 "price": {
47 "taxIncludedAmount": {
48 "value": 20,
49 "unit": "$"
50 }
51 },
52 "priceType": "One-time"
53 }
54 ],
55 "relatedParty": [
56 {
57 "role": "Service Account",
58 "name": "Common Org Account",
59 "id": "001Do00000MfpkgIAB",
60 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/001Do00000MfpkgIAB",
61 "@referredType": "Account"
62 }
63 ],
64 "quantity": 1,
65 "id": "00000653",
66 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/QuoteLineItem/00000653",
67 "action": "Add"
68 }
69 ],
70 "quoteTotalPrice": [
71 {
72 "price": {
73 "taxIncludedAmount": {
74 "value": 1,
75 "unit": "$"
76 }
77 },
78 "priceType": "Recurring"
79 },
80 {
81 "price": {
82 "taxIncludedAmount": {
83 "value": 0,
84 "unit": "$"
85 }
86 },
87 "priceType": "One-time"
88 }
89 ],
90 "relatedParty": [
91 {
92 "role": "Account",
93 "name": "Common Org Account",
94 "id": "1234",
95 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/1234",
96 "@referredType": "Account"
97 },
98 {
99 "role": "Contact",
100 "name": "common",
101 "id": "003Do00000PSgbhIAD",
102 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contact/003Do00000PSgbhIAD",
103 "@referredType": "Contact"
104 }
105 ],
106 "version": "V1",
107 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/quote/00001204",
108 "billingAccount": [
109 {
110 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/CD123",
111 "name": "Acme",
112 "id": "CD123"
113 }
114 ],
115 "agreement": [
116 {
117 "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contract/00000945",
118 "id": "00000945"
119 }
120 ],
121 "state": "Draft",
122 "quoteDate": "2023-09-13T03:46:02.000+0000",
123 "id": "00001204",
124 "description": "TMF648 Quote",
125 "category": "Existing Customer - Upgrade"
126}