A&BR

Version 1.0 (latest)

Updates contracting events

Version 1.0
download iconDownload spec

Endpoint

POST
https://abr-api.it.att.com/abr-contract-event

This API is invoked by COMS, SSDF, SalesExpress, and ROME to provide updates for contracting events. It receives and stores the details for contracting updates, such as signed by the customer, executed, and docviewer-URL-loaded updates.

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
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
curl --request POST \
     --url https://abr-api.it.att.com/abr-contract-event \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "id": 12345,
  "abrHeaderId": 1001,
  "nodeTypeCodeId": -1,
  "nodeAlias": "NodeA",
  "parentNodeAlias": "ParentNode",
  "nodeId": "Node123",
  "cadmBillNodeValue": "BillNodeValue",
  "parentId": 1000,
  "typeOfSegment": "SegmentType",
  "abrRequestId": "REQ12345",
  "productName": "ProductX",
  "typeOfContractActivity": "CONTRACTING",
  "typeOfAddendum": "ADDENDUM1",
  "customerLegalName": "Customer XYZ LLC",
  "attContractNumber": "ATT0987654321",
  "solutionId": "SOL-1001",
  "attContractSolutionNumber": "SOLATT123",
  "contractGroupId": "GRP100",
  "contractGroupStatus": "ACTIVE",
  "contractStatus": "SIGNED",
  "contractTerm": 36,
  "contractedBusinessName": "Contracted Business Ltd",
  "counterSignedDate": "2025-08-21T16:35:57.221+00:00",
  "contractSubType": "SUB-TYPE1",
  "offerId": [
    "[\"OFF1\",\"OFF2\"]"
  ],
  "custMainTelephone": "+1234567890",
  "ecrmOpportunityId": "ECRM90123",
  "custMarketSegTrans": "SEG001",
  "customerSignedDate": "2025-08-20T16:35:57.221+00:00",
  "customerType": "ENTERPRISE",
  "docViewerLink": "http://docviewer.example.com/123",
  "docViewerId": "DOCV123",
  "documentId": "DOC12345",
  "multiHierarchyInd": "Y",
  "originalContractNumber": "ORIG987654",
  "partnerType": "RESELLER",
  "sourceSystemId": "SYS001",
  "typeOfContract": "NEW",
  "contractType": "STANDARD",
  "hasIntegratedAccess": "STANDARD",
  "specialBidIndicator": "SPC001",
  "fmoPmoIndicator": "FMO",
  "maNumber": "MA56789",
  "marketStrata": "STRATA1",
  "isContractImpact": "false",
  "addresses": {
    "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",
    "countryCode": "US",
    "countryId": 840,
    "county": "null",
    "houseNumber": "456",
    "postalCode": "10001",
    "province": "Ontario",
    "state": "NY",
    "stateId": 36,
    "validated": "true",
    "addressType": "billing"
  },
  "submittedByUserId": "user123",
  "products": [
    {
      "id": 1001,
      "enddate": "2023-12-31T23:59:59Z",
      "mecId": "MEC123",
      "productAcronym": "PROD",
      "productCode": "P12345",
      "productDescription": "This is a sample product.",
      "productGroupId": 1,
      "productIdExternal": "EXT12345",
      "productName": "Sample Product",
      "productdisplayname": "Sample Product",
      "producteffdate": "2023-01-01T00:00:00Z",
      "productenddate": "2023-12-31T23:59:59Z",
      "productfamily": "Product Family A",
      "producthelplink": "http://example.com/help",
      "productorderableflag": "true",
      "productstatus": "Active",
      "productversion": "1.0",
      "productxmlschema": "<schema>...</schema>",
      "productxpath": "/product/path",
      "releaseCodeId": 2001,
      "sortOrder": 1,
      "billingServiceName": "Billing Service A"
    }
  ]
}
'

RESPONSE

1
2
3
4
5
6
7
8
9
{
  "abrId": "ABR12345",
  "status": "Success",
  "messageId": "MSG12345",
  "errors": "Invalid input data",
  "errorCode": "ERR001",
  "errorDesc": "Invalid ABR ID",
  "errorDescExt": "The provided ABR ID does not exist in the system."
}