Returns detailed information about SOCRates

Version v0
download iconDownload spec

Endpoint

POST
https://coms.dev.att.com/contract-inventory/contract-soc-rate

Retrieve the details of the SOCRates

arrowRequest

Body Parameters

Responses

Successful operation

arrowBody

application/json

REQUEST

1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
     --url https://coms.dev.att.com/contract-inventory/contract-soc-rate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "offerName": "string",
  "productName": "string",
  "attContractId": "string"
}
'

RESPONSE

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
{
  "errorCode": "string",
  "errorMsg": "string",
  "socRatesOutput": {
    "attContractId": "string",
    "rateStabilityDate": "2026-01-26T09:00:05.082Z",
    "contractAuthorityLevel": "string",
    "contractTerm": 0,
    "accIndicator": "string",
    "discountTier": "string",
    "contractFlowType": "string",
    "featureOnOFF": [
      {
        "featureOnOffName": "string",
        "featureOnOffValue": "string"
      }
    ],
    "contacts": [
      {
        "contactType": "string",
        "endCustomerName": "string",
        "streetAddress": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string"
      }
    ],
    "subAccount": {
      "ucCustomerNumber": "string",
      "subAccountNumber": "string"
    },
    "pricing": [
      {
        "offerId": 0,
        "offerVersion": "string",
        "offerName": "string",
        "productId": 0,
        "productName": "string",
        "ratesPlan": [
          {
            "ratePlanIdInternal": "string",
            "ratePlanIdExternal": "string",
            "ratePlanId": "string",
            "ratePlanVersion": "string",
            "billingRatePlan": "string",
            "ratePlanName": "string",
            "ratePlanDescription": "string",
            "ratePlaneffectiveDate": "2026-01-26T09:00:05.082Z",
            "rates": [
              {
                "rateIdInternal": "string",
                "rateIdExternal": "string",
                "rateId": "string",
                "rateVersion": "string",
                "rateDescription": "string",
                "salesRateDescription": "string",
                "rateType": "string",
                "rateSubType": "string",
                "rateGroup": "string",
                "rateSubGroup": "string",
                "rate": "string",
                "attribute1": "string",
                "attribute2": "string",
                "attribute3": "string",
                "modelName": "string",
                "storage": "string",
                "rateChargeUnit": "string",
                "hsiaeBrassOfferCode": "string",
                "rateEffectiveDate": "2026-01-26T09:00:05.082Z",
                "rateEndDate": "2026-01-26T09:00:05.082Z",
                "ratePlanEffectiveDate": "2026-01-26T09:00:05.082Z",
                "rateEquipment": "string",
                "isoCountryCode": "string",
                "alpha3CountryCode": "string",
                "isoCurrencyCode": "string",
                "rateCode": "string",
                "rateGroupId": "string",
                "equipmentManufacturer": "string",
                "managementType": "string",
                "group": "string",
                "rateCategory": "string",
                "rateStatus": "string",
                "accessSpeed": "string",
                "portSpeed": "string",
                "associatedRates": "string",
                "serviceType": "string",
                "pbi": "string",
                "beid": "string",
                "ppcCode": "string",
                "biller": [
                  {
                    "billerCode": "string",
                    "billerName": "string",
                    "rateIdExternal": "string"
                  }
                ]
              }
            ]
          }
        ],
        "pricePlan": [
          {
            "pricePlanIdInternal": "string",
            "pricePlanIdExternal": "string",
            "pricePlanDescription": "string",
            "pricePlanId": "string",
            "pricePlanVersion": 0,
            "billingPricePlanId": "string",
            "pricePlanName": "string",
            "discounts": [
              {
                "discountIdInternal": "string",
                "discountIdExternal": "string",
                "discountId": "string",
                "discountVersion": "string",
                "parentDiscountIdInternal": "string",
                "parentDiscountIdExternal": "string",
                "parentDiscountId": "string",
                "parentDiscountVersion": "string",
                "discountDescription": "string",
                "discountDisplay": "string",
                "discountType": "string",
                "replicateDiscountId": "string",
                "discountPercentage": "string",
                "componentGroupCategory": "string",
                "compGrpCatDispSeq": "string",
                "discountTypeCode": "string",
                "discountCategory": "string",
                "discountGroup": "string",
                "displayDiscountCategory": "string",
                "displayDiscountCatSequence": "string",
                "displayDiscountSequence": "string",
                "ratePlanIdInternal": "string",
                "ratePlanIdExternal": "string",
                "ratePlanId": "string",
                "toCountryName": "string",
                "discountLevel": "string",
                "discountEffectiveDate": "2026-01-26T09:00:05.082Z",
                "discountEndDate": "2026-01-26T09:00:05.082Z",
                "isoCountryCode": "string",
                "isoCurrencyCode": "string",
                "promotionid": "string",
                "discountStatus": "string",
                "discountRange": [
                  {
                    "discountRangeID": "string",
                    "discountRangeName": "string",
                    "minAnnualRevCommitment": "string",
                    "maxAnnualRevCommitment": "string",
                    "term": 0,
                    "authorityLevel": "string",
                    "minAmount": 0,
                    "maxAmount": 0,
                    "defaultDiscountPercentage": 0,
                    "incrementDiscountPercentage": 0,
                    "contractedDiscountPercentage": 0,
                    "nod": "string",
                    "installOption": "string",
                    "minQuantity": 0,
                    "maxQuantity": 0
                  }
                ],
                "componentGroupCategoryDisplaySequence": "string"
              }
            ]
          }
        ],
        "pricePlan2RatePlan": [
          {
            "pricePlanIdInternal": "string",
            "pricePlanIdExternal": "string",
            "pricePlanId": "string",
            "ratePlanIdInternal": "string",
            "ratePlanIdExternal": "string",
            "ratePlanId": "string"
          }
        ],
        "discount2rateXrefs": [
          {
            "discountIdInternal": "string",
            "discountIdExternal": "string",
            "discountID": "string",
            "discountId": 0,
            "scheduleVariableName": "string",
            "rates": [
              {
                "rateIdInternal": 0,
                "rateIdExternal": "string",
                "rateId": {
                  "type": "object"
                }
              }
            ]
          }
        ]
      }
    ],
    "marc": {
      "typeofMarcCommitment": "string",
      "minAnnualRevCommitment": "string",
      "marcByYear": [
        {
          "commitmentYear": "string",
          "commitmentAmount": "string",
          "commitmentTerm": 0,
          "extENDTerm": 0,
          "coterminousTermDate": "2026-01-26T09:00:05.082Z"
        }
      ]
    },
    "esign": {
      "hasNonStandardContractLanguage": "string",
      "hasNonStandardPricing": "string"
    },
    "lanIpBillingInd": "string",
    "loaNumber": "string"
  }
}