Updates contracting events
Version 1.0
Endpoint
POST
https://abr-api.it.att.com/abr-contract-event
Copy
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.
http
scheme:bearer
bearerFormat:JWT
Body Parameters
- objectRequired
- idint64Unique identifier of the recordExample: 12345
- abrHeaderIdint64The ABR header idExample: 1001
- nodeTypeCodeIdint64The node type code identifierExample: -1
- nodeAliasstringThe alias of the nodeExample: NodeA
- parentNodeAliasstringThe alias of the parent nodeExample: ParentNode
- nodeIdstringThe node identifierExample: Node123
- cadmBillNodeValuestringThe CADM bill node valueExample: BillNodeValue
- parentIdint64The parent node idExample: 1000
- typeOfSegmentstringThe type of segmentExample: SegmentType
- childIdsarrayList of child node identifiers
- abrRequestIdstringThe ABR request identifierExample: REQ12345
- productNamestringThe product nameExample: ProductX
- typeOfContractActivitystringThe type of contract activityExample: CONTRACTING
- typeOfAddendumstringThe type of addendumExample: ADDENDUM1
- customerLegalNamestringThe customer legal nameExample: Customer XYZ LLC
- attContractNumberstringThe AT&T contract numberExample: ATT0987654321
- solutionIdstringThe solution identifierExample: SOL-1001
- attContractSolutionNumberstringThe AT&T contract solution numberExample: SOLATT123
- contractGroupIdstringThe contract group identifierExample: GRP100
- contractGroupStatusstringThe status of the contract groupExample: ACTIVE
- contractStatusstringThe contract statusExample: SIGNED
- contractTermThe term of the contractExample: 36
- contractedBusinessNamestringThe contracted business nameExample: Contracted Business Ltd
- counterSignedDatestringThe counter signed dateExample: 2025-08-21T16:35:57.221+00:00
- contractSubTypestringThe contract sub typeExample: SUB-TYPE1
- offerIdarray of stringsThe offer identifiersExample: ["OFF1","OFF2"]
- custMainTelephonestringThe customer main telephoneExample: +1234567890
- ecrmOpportunityIdstringThe ECRM opportunity identifierExample: ECRM90123
- custMarketSegTransstringThe customer market segment transactionExample: SEG001
- customerSignedDatestringThe customer signed dateExample: 2025-08-20T16:35:57.221+00:00
- customerTypestringThe customer typeExample: ENTERPRISE
- docViewerLinkstringThe document viewer linkExample: http://docviewer.example.com/123
- docViewerIdstringThe document viewer identifierExample: DOCV123
- documentIdstringThe document identifierExample: DOC12345
- multiHierarchyIndstringIndicator for multiple hierarchiesExample: Y
- originalContractNumberstringThe original contract numberExample: ORIG987654
- partnerTypestringThe partner typeExample: RESELLER
- sourceSystemIdstringThe source system identifierExample: SYS001
- typeOfContractstringThe type of contractExample: NEW
- contractTypestringThe contract typeExample: STANDARD
- hasIntegratedAccessstringThe contract typeExample: STANDARD
- specialBidIndicatorstringThe special bid indicatorExample: SPC001
- fmoPmoIndicatorstringThe FMO PMO indicatorExample: FMO
- maNumberstringThe MA numberExample: MA56789
- marketStratastringThe market strataExample: STRATA1
- isContractImpactstringIndicator of contract impactExample: false
- addressesobject
- submittedByUserIdstringThe user identifier who submitted the contractExample: user123
- productsarray of objects
Responses
Successful operation
Body
application/json
- objectRequired
- abrIdstringThe unique identifier for the ABR contract event.Example: ABR12345
- statusstringThe status of the contract event.Example: Success
- messageIdstringThe message ID associated with the contract event.Example: MSG12345
- errorsstringDetails of any errors encountered.Example: Invalid input data
- errorCodestringThe code representing the error.Example: ERR001
- errorDescstringA description of the error.Example: Invalid ABR ID
- errorDescExtstringAn extended description of the error.Example: The provided ABR ID does not exist in the system.