AT&T DevEx

A&BR

Version 1.0 (latest)

Fetches existing customer hierarchy for MACD orders

Version 1.0
download iconDownload spec

Endpoint

POST
https://abr-api.it.att.com/customer-hierarchy

This API is invoked by BC and SalesExpress to retrieve the existing customer hierarchy. It includes the CADM Node value, which is used for MACD orders.

arrowSecurity

http

scheme:bearer
bearerFormat:JWT
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
curl --request POST \
     --url https://abr-api.it.att.com/customer-hierarchy \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "l3SaartId": "L3SAART12345",
  "mcn": "MCN987654",
  "grc": "GRC123",
  "soc": "SOC456",
  "invoiceNumber": "INV789012",
  "attContractNumber": "ATT123456",
  "customerCadmNodeValue": "CADMNode001",
  "sourceSystemId": "SourceSystem123"
}
'

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
{
  "errorCode": "ERR001",
  "errorMessage": "Invalid customer ID.",
  "customerInfo": [
    {
      "customerName": "John Doe Inc.",
      "customerNodeNumber": "CUST12345",
      "salesSegmentCode": "SEG001",
      "addressInfo": {
        "addressType": "Billing",
        "address1": "123 Main St",
        "address2": "Suite 100",
        "address3": "Building A",
        "address4": "Floor 2",
        "city": "New York",
        "state": "NY",
        "province": "Ontario",
        "postalCode": "10001",
        "buildingName": "Empire State Building",
        "houseNumber": "123",
        "county": "null",
        "country": "US"
      },
      "cadmBillNodeValue": "CADM456"
    }
  ],
  "hierarchyNodes": [
    {
      "hierarchyNodeNumber": "HIER12345",
      "parentId": "PARENT456",
      "socCountryCode": "US",
      "attLegalEntityCode": "LEC001",
      "attLegalEntityCountryCode": "US",
      "regionalBiller": "Biller001",
      "ccfDate": "2023-01-01T12:00:00Z",
      "billCycle": "Monthly",
      "countryCode": "US",
      "countryLegalName": "United States"
    }
  ],
  "baNodes": [
    {
      "baNodeNumber": "BAN12345",
      "parentId": "PARENT123",
      "customerLegalName": "John Doe Inc.",
      "ratingCurrency": "USD",
      "pcsTrackingNumber": "PCS12345",
      "contracts": [
        {
          "contractNumber": "CON123456"
        }
      ],
      "addresses": [
        {
          "addressType": "Billing",
          "address1": "123 Main St",
          "address2": "Suite 100",
          "address3": "Building A",
          "address4": "Floor 2",
          "city": "New York",
          "state": "NY",
          "province": "Ontario",
          "postalCode": "10001",
          "buildingName": "Empire State Building",
          "houseNumber": "123",
          "county": "null",
          "country": "US"
        }
      ],
      "taxInfos": [
        {
          "createdUserId": "user123",
          "createdDate": "2023-01-01T12:00:00Z",
          "modUserId": "user456",
          "modDate": "2023-02-01T12:00:00Z",
          "statusId": 1,
          "id": 1001,
          "abrBillAccountId": 2001,
          "certificationNumber": "CERT12345",
          "creditMemoVatInd": "Y",
          "customerCityTaxId": "CITY123",
          "customerProfession": "Engineer",
          "customerStateTaxId": "STATE123",
          "customerTaxId": "TAX12345",
          "taxAlias": "SalesTax",
          "taxCode": "TX123",
          "taxExemptCertNumber": "EXEMPT123",
          "taxExemptEndDate": "2023-12-31T23:59:59Z",
          "taxExemptIndicator": "Y",
          "taxExemptReason": "Non-profit organization",
          "taxExemptStartDate": "2023-01-01T00:00:00Z",
          "taxId": "TAXID123",
          "taxOffice": "New York Tax Office",
          "taxRegistrationCode": "REG12345",
          "type": "Sales",
          "taxPayerId": "PAYER123",
          "taxTypeMask": "MASK123"
        }
      ]
    }
  ],
  "invoiceNodes": [
    {
      "invoiceNodeNumber": "INV12345",
      "parentId": "PARENT789",
      "billingName": "John Doe Billing",
      "invoiceDescription": "Monthly billing invoice.",
      "purchaseOrderNumber": "PO12345",
      "vendorCode": "VEND001",
      "cadmSeiLeadAccountNumber": "SEI12345",
      "invoiceCurrency": "USD",
      "invoiceLanguage": "English",
      "contacts": [
        {
          "createdUserId": "user123",
          "createdDate": "2023-10-01T12:00:00Z",
          "modUserId": "user456",
          "modDate": "2023-10-02T15:30:00Z",
          "statusId": 1,
          "id": 1001,
          "typeOfContact": "primary",
          "contactTypeCodeId": 2002,
          "email": "example@domain.com",
          "extension": "1234",
          "fax": "123-456-7890",
          "faxAreaCode": "123",
          "faxCountryCode": "1",
          "faxExtension": "5678",
          "firstName": "John",
          "jobTitle": "Manager",
          "lastName": "Doe",
          "phone": "987-654-3210",
          "phoneAreaCode": "987",
          "phoneCountryCode": "1",
          "salutation": "null",
          "addresses": [
            {
              "createdUserId": "user123",
              "createdDate": "2023-10-01T12:00:00Z",
              "modUserId": "user456",
              "modDate": "2023-10-02T15:30:00Z",
              "statusId": 1,
              "id": 1001,
              "addressTypeCodeId": 2002,
              "address1": "123 Main St",
              "address2": "Suite 400",
              "address3": "Building A",
              "address4": "Floor 5",
              "attention": "null",
              "buildingName": "Corporate Plaza",
              "city": "New York",
              "country": "USA",
              "countryId": 840,
              "county": "null",
              "houseNumber": "456",
              "postalCode": "10001",
              "province": "Ontario",
              "state": "NY",
              "stateId": 36,
              "validated": "true"
            }
          ],
          "position": "null",
          "salesRep": "Jane Smith",
          "attuid": "att12345",
          "contactType": "business"
        }
      ],
      "addresses": [
        {
          "addressType": "Billing",
          "address1": "123 Main St",
          "address2": "Suite 100",
          "address3": "Building A",
          "address4": "Floor 2",
          "city": "New York",
          "state": "NY",
          "province": "Ontario",
          "postalCode": "10001",
          "buildingName": "Empire State Building",
          "houseNumber": "123",
          "county": "null",
          "country": "US"
        }
      ]
    }
  ],
  "cdgNodes": [
    {
      "cdgNodeNumber": "CDG12345",
      "parentId": "PARENT123",
      "cdgDescription": "CDG node for billing.",
      "cadmBillNodeValue": "CADM123"
    }
  ],
  "subAccountsNodes": [
    {
      "subAccountNumber": "SA12345",
      "parentId": "PARENT123",
      "mcn": "MCN12345",
      "so": "SO12345",
      "bg": "BG123",
      "serviceType": "Internet",
      "typeofTriplet": "TripletType1",
      "saDescription": "Sub-account description"
    }
  ]
}