AT&T DevEx

A&BR

Version 1.0 (latest)

Provides A&BR hierarchy data for billing creation

Version 1.0
download iconDownload spec

Endpoint

GET
https://abr-api.it.att.com/cif-full-data

This API is invoked by BCAI to consume the A&BR hierarchy data required for billing hierarchy creation in the target flow. It contains customerNode details, contract details and hierarchyNode(invoiceNode, subAccountNode, CDGNode) details.

arrowSecurity

http

scheme:bearer
bearerFormat:JWT
arrowRequest

Query Parameters

        Body Parameters

        Responses

        Successful operation

        arrowBody

        application/json

        REQUEST

        1
2
3
        curl --request GET \
     --url 'https://abr-api.it.att.com/cif-full-data?contractSolutionNumber=string&transactionId=string&abrId=integer' \
     --header 'accept: application/json'

        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
        {
  "abrId": 12345,
  "transactionId": "TXN789012",
  "contractSubType": "MNSMRS",
  "contractEffectiveDate": "2023-10-01T12:00:00Z",
  "attContractNumber": "ATT123456",
  "attContractSolutionNumber": "CSN123456",
  "submittedByUserId": "user123",
  "hierarchyOnlySolutionNumber": "HOSN789012",
  "contacts": [
    {
      "id": 1001,
      "typeOfContact": "Primary",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "555-1234",
      "emailAddress": "john.doe@example.com",
      "attuid": "JD12345"
    }
  ],
  "contract": {
    "id": 2001,
    "attContractNumber": "CON12345",
    "attContractSolutionNumber": "SOL12345",
    "contractSubType": "Master Agreement",
    "counterSignedDate": "2023-01-15T10:00:00Z",
    "customerSignedDate": "2023-01-10T10:00:00Z",
    "docViewerId": "DOC12345",
    "docViewerLink": "http://example.com/docviewer",
    "maNumber": "MA12345",
    "originalContractNumber": "ORIG12345",
    "typeOfContractActivity": "Renewal"
  },
  "customerNode": {
    "id": 3001,
    "nodeAlias": "CustomerNode1",
    "nodeType": "Customer",
    "childIds": [
      {}
    ],
    "cadmBillNodeValue": "CADMNode123",
    "customerName": "John Doe Inc.",
    "creditCheckAuthorizationNum": "AUTH12345",
    "salesSegmentCode": "SEG123",
    "marketStrata": "Enterprise",
    "addresses": [
      {
        "id": 1001,
        "addressType": "Billing",
        "address1": "123 Main St",
        "address2": "Suite 100",
        "address3": "Building A",
        "address4": "Floor 2",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "countryCode": "US"
      }
    ]
  },
  "hierarchyNodes": [
    {
      "id": 4001,
      "nodeType": "HierarchyNode",
      "parentId": 3001,
      "childIds": [
        {}
      ],
      "cadmBillNodeValue": "CADMNode456",
      "activityType": "Creation",
      "typeOfChange": "Update",
      "hierarchyCreationStatus": "Completed",
      "countryCode": "US",
      "legalEntityCode": "LE123",
      "billCycle": "Monthly"
    }
  ],
  "baNodes": [
    {
      "id": 2001,
      "nodeType": "BillingAccountNode",
      "nodeAlias": "NodeAlias1",
      "parentId": 1001,
      "childIds": [
        {}
      ],
      "cadmBillNodeValue": "CADMNode123",
      "ratingCurrency": "USD",
      "customerLegalName": "John Doe Inc.",
      "addresses": [
        {
          "addressType": "Billing",
          "address1": "123 Main St",
          "address2": "Suite 100",
          "address3": "Building A",
          "address4": "Floor 2",
          "city": "New York",
          "state": "NY",
          "postalCode": "10001",
          "countryCode": "US",
          "attention": "null",
          "id": 1001
        }
      ]
    }
  ],
  "invoiceNodes": [
    {
      "id": 1001,
      "nodeType": "InvoiceNode",
      "parentId": 2001,
      "cadmBillNodeValue": "CADMNode123",
      "childIds": [
        {}
      ],
      "billingName": "John Doe Billing",
      "invoiceDescription": "Monthly billing invoice",
      "invoiceCurrency": "USD",
      "invoiceLanguage": "English",
      "billMedia": "Electronic",
      "purchaseOrderNumber": "PO12345",
      "advanceArrearsIndicator": "Advance",
      "vendorCode": "VENDOR123",
      "addresses": [
        {
          "addressType": "Billing",
          "address1": "123 Main St",
          "address2": "Suite 100",
          "address3": "Building A",
          "address4": "Floor 2",
          "city": "New York",
          "state": "NY",
          "postalCode": "10001",
          "countryCode": "US",
          "attention": "null",
          "id": 1001
        }
      ],
      "contacts": [
        {
          "id": 1001,
          "typeOfContact": "Primary",
          "firstName": "John",
          "lastName": "Doe",
          "phoneCountryCode": "+1",
          "phoneAreaCode": "212",
          "phone": "5551234",
          "extension": "123",
          "email": "john.doe@example.com",
          "salutation": "null",
          "jobTitle": "Software Engineer",
          "address1": "123 Main St",
          "address2": "Suite 100",
          "address3": "Building A",
          "address4": "Floor 2",
          "city": "New York",
          "state": "NY",
          "postalCode": "10001",
          "countryCode": "US"
        }
      ]
    }
  ],
  "cdgNodes": [
    {
      "id": 3001,
      "nodeType": "CDGNode",
      "parentId": 2001,
      "childIds": [
        {}
      ],
      "cadmBillNodeValue": "CADMNode456",
      "cdgDescription": "This is a CDG node."
    }
  ],
  "subAccountNodes": [
    {
      "id": 3001,
      "nodeType": "SubAccountNode",
      "parentId": 2001,
      "subAccountDescription": "Sub-account for billing",
      "cadmBillNodeValue": "CADMNode456",
      "serviceType": "Internet",
      "mcn": "MCN12345",
      "soc": "SOC123",
      "billGroup": "Group1",
      "typeOfTriplet": "TripletType1",
      "usagePlan": "Unlimited"
    }
  ]
}