AT&T DevEx

Common Contracts

Version v0 (latest)

Retrieves the customer contract from inventory

Version v0
download iconDownload spec

Endpoint

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

Retrieves the contact from inventory service

arrowRequest

Body Parameters

Responses

Successful operation

arrowBody

application/json

REQUEST

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
curl --request POST \
     --url https://coms.dev.att.com/contract-inventory/contract-cdr \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "offerId": 0,
  "strata": "string",
  "statusType": [
    {
      "status": "string"
    }
  ],
  "typeofRequest": 0,
  "sortBy": 0,
  "sortOn": "string",
  "mustHaveDiscounts": "string",
  "searchCriteria": {
    "searchKey": "string",
    "searchValue": "string",
    "include": [
      {
        "filterName": "string",
        "filterValue": "string"
      }
    ],
    "exclude": [
      {
        "filterName": "string",
        "filterValue": "string"
      }
    ],
    "isExactSearch": "string"
  },
  "view": 0,
  "filterCriteria": {
    "include": [
      {
        "filterName": "string",
        "filterValue": "string"
      }
    ],
    "exclude": [
      {
        "filterName": "string",
        "filterValue": "string"
      }
    ]
  },
  "customerSignedDateRange": {
    "startDate": "string",
    "endDate": "string"
  },
  "sellersATTUID": "string",
  "perPageSize": "string",
  "pageIndex": "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
{
  "countOfContract": 0,
  "cdrContractInfo": [
    {
      "customerName": "string",
      "contractStartDate": "2026-01-26T09:00:05.087Z",
      "contractEffectiveDate": "2026-01-26T09:00:05.087Z",
      "contractEndDate": "2026-01-26T09:00:05.087Z",
      "contractNumber": "string",
      "contractStatus": "string",
      "contractSubType": "string",
      "contractTerm": 0,
      "contractType": "string",
      "contractActivityType": "string",
      "dunsNumber": "string",
      "contractSource": "string",
      "isCustomContract": "string",
      "contractedBusinessPhone": "string",
      "customerType": "string",
      "contractID": "string",
      "l3AccountId": "string",
      "oldL3AccountId": "string",
      "svid": "string",
      "subAccountId": "string",
      "accountName": "string",
      "masterAgreementNumber": "string",
      "billerCode": "string",
      "opportunityId": "string",
      "opportunityName": "string",
      "mobilityShadowAgreementIndicator": "string",
      "mobilityShadowAgreementNumber": "string",
      "invoiceType": "string",
      "coterminousExpirationDate": "2026-01-26T09:00:05.087Z",
      "coterminousIndicator": "string",
      "discountAuthorityLevel": 0,
      "contractTermExtension": "string",
      "pmoServiceType": "string",
      "contractSubOffer": "string",
      "fmoInd": "string",
      "accIndicator": "string",
      "serviceLocationCountry": "string",
      "ebmIndicator": "string",
      "annualValue": 0,
      "customerSignedDate": "2026-01-26T09:00:05.087Z",
      "attSignedDate": "2026-01-26T09:00:05.087Z",
      "customerAddress": "string",
      "customerAddress1": "string",
      "customerAddress2": "string",
      "customerCity": "string",
      "customerState": "string",
      "customerZip": "string",
      "customerCountry": "string",
      "docViewerId": 0,
      "docViewerUrl": "string",
      "gcoNumber": "string",
      "strata": "string",
      "orderableStatus": "string",
      "isbIndicator": "string",
      "bundledMarcFlag": "string",
      "bundledServiceName": "string",
      "ccid": "string",
      "pcsHomerNumber": "string",
      "solutionType": "string",
      "federalBillerCode": "string",
      "bvoipIpt": "string",
      "hasCid": "string",
      "contractGroupSignedDate": "2026-01-26T09:00:05.099Z",
      "hasCustomPricing": "string",
      "coaContractNumber": "string",
      "coaCounterSignedDate": "2026-01-26T09:00:05.099Z",
      "billingSystem": "string",
      "promotionName": "string",
      "contractServiceType": "string",
      "contractCustomerName": "string",
      "dayAfterExpiration": "string",
      "totalContractTerm": 0,
      "contractSolutionNumber": "string",
      "resellerFlag": "string",
      "contractAlias": "string",
      "statusId": "string",
      "productOffer": [
        {
          "productId": 0,
          "productName": "string",
          "offerId": 0,
          "offerName": "string",
          "ratePlanId": 0
        }
      ],
      "listOfServices": [
        {
          "productName": "string"
        }
      ],
      "originalContract": [
        {
          "contractNumber": "string"
        }
      ],
      "contact": [
        {
          "contactType": "string",
          "firstName": "string",
          "lastName": "string",
          "title": "string",
          "phone": "string",
          "email": "string",
          "fax": "string",
          "telephoneNumber": "string",
          "address1": "string",
          "streetAddress": "string",
          "address2": "string",
          "city": "string",
          "stateProvince": "string",
          "state": "string",
          "postalCode": "string",
          "zip": "string",
          "country": "string",
          "attUid": "string",
          "positionName": "string",
          "primaryIndicator": "string",
          "lata": "string",
          "cilli": "string"
        }
      ],
      "avpnContractDetails": [
        {
          "ethernetAccessIndicator": "string",
          "lspLocations": "string",
          "customSla": "string",
          "customTerms": "string",
          "csfInd": "string"
        }
      ],
      "usAccessDetails": [
        {
          "integratedContractIndicator": "string",
          "dealID": "string",
          "serviceBillingName": "string",
          "serviceMCN": "string",
          "serviceGRC": "string",
          "serviceSOC": "string",
          "serviceBillerCode": "string",
          "enumber": "string"
        }
      ],
      "replacedContract": [
        {
          "oldContractNumber": "string",
          "oldContractTerm": "string",
          "oldContractStartDate": "2026-01-26T09:00:05.099Z",
          "oldContractExpiryDate": "2026-01-26T09:00:05.099Z"
        }
      ],
      "rateInstances": [
        {
          "rate": "string",
          "rateId": "string",
          "siteId": "string",
          "usoc": "string",
          "rateType": "string",
          "serviceComponentDescription": "string",
          "jurisdiction": "string",
          "quantity": "string"
        }
      ],
      "installSiteList": [
        {
          "siteId": "string",
          "state": "string"
        }
      ],
      "subcontractList": [
        {
          "state": "string",
          "contractID": "string"
        }
      ],
      "invoiceInfo": [
        {
          "multipleInvoiceInd": "string",
          "invoiceAccountNo": "string"
        }
      ],
      "masterContractNumber": "string",
      "masterContractInd": "string",
      "contractFlowType": "string",
      "iciFlagValue": "string",
      "customContractNumber": "string",
      "regionalInd": "string",
      "narrative": "string",
      "erate": "string",
      "esignContractDocId": "string",
      "esignDocId": "string",
      "erateBenNumber": "string",
      "erate470Number": "string",
      "eratePricingVenue": "string",
      "ecatsFileNumber": "string"
    }
  ],
  "errorCode": "string",
  "errorMsg": "string"
}