1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Account Management
  4. Notification Listeners

Update an Account from a PartyAccountAttributeValueChangeEvent Notification

post

/listener/partyAccountAttributeValueChangeEvent

Updates an account's attributes based on PartyAccountAttributeValueChangeEvent notification.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : Party Account Attribute Value Change Event
Type: object
Title: Party Account Attribute Value Change Event
An event for changing a party account's attribute.
Show Source
Nested Schema : Party Account Attribute Value Change Event Payload
Type: object
Title: Party Account Attribute Value Change Event Payload
The payload for PartyAccountAttributeValueChangeEvent.
Show Source
Nested Schema : Party Account
Type: object
Title: Party Account
An organization or individual's account used for billing or for settlement purposes.
Show Source
Nested Schema : accountBalance
Type: array
The account's balances.
Show Source
Nested Schema : accountRelationship
Type: array
The account's relationships.
Show Source
Nested Schema : Bill Structure
Type: object
Title: Bill Structure
The structure of a bill, for associating billing cycle specifications, formats, and presentation media.
Show Source
Nested Schema : contact
Type: array
The account's contacts.
Show Source
Nested Schema : Money
Type: object
Title: Money
An amount of money.
Show Source
Nested Schema : Payment Method Ref
Type: object
Title: Payment Method Ref
A payment method reference.
Show Source
Nested Schema : Financial Account Ref
Type: object
Title: Financial Account Ref
A financial account reference.
Show Source
Nested Schema : paymentPlan
Type: array
The account's payment plans.
Show Source
Nested Schema : relatedParty
Type: array
Minimum Number of Items: 1
The account's related parties.
Show Source
Nested Schema : taxExemption
Type: array
The account's tax exemptions.
Show Source
Nested Schema : Account Balance
Type: object
Title: Account Balance
A balance associated with an account.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source
Nested Schema : Account Relationship
Type: object
Title: Account Relationship
The relationship between accounts.
Show Source
Nested Schema : Account Ref
Type: object
Title: Account Ref
An account's reference.
Show Source
Nested Schema : Billing Cycle Specification Ref Or Value
Type: object
Title: Billing Cycle Specification Ref Or Value
A link to a billing cycle specification or billing cycle specification reference.
Show Source
  • Title: Base Type
    The object's superclass.
  • Title: Referred Type
    The object's type in the target system, if baseType and type need further disambiguation.
  • Title: Schema Location
    A URI to a JSON schema file that defines additional attributes and relationships.
  • Title: Type
    The object's subclass.
  • Title: Billing Date Shift
    The number of days from the start of the billing period by which to offset the billing date.
  • Title: Billing Period
    The length of the billing period. For example, week, month, quarter, year.
  • Title: Charge Date Offset
    The number of days from the start of the billing period by which to offset the charges that appear on a bill.
  • Title: Credit Date Offset
    The number of days from the start of the billing period by which to offset the credits that appear on a bill.
  • Title: Billing Cycle Specification Description
    The billing cycle specification's description.
  • Title: Frequency
    The billing frequency. For example, monthly.
  • Title: Billing Cycle Specification Href
    The billing cycle specification's href.
  • Title: Billing Cycle Specification ID
    The billing cycle specification's ID.
  • Title: Is Billing Cycle Specification Ref
    Default Value: true
    Whether the billing cycle specification is a reference (true) or a value (false).
  • Title: Mailing Date Offset
    The number of days from the start of the billing period by which to offset the date the bill is mailed.
  • Title: Billing Cycle Specification Name
    The billing cycle specification's name.
  • Title: Payment Due Date Offset
    The number of days from the start of the billing period by which to offset the payment's due date.
  • Time Period
    Title: Time Period
    A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Nested Schema : Bill Format Ref Or Value
Type: object
Title: Bill Format Ref Or Value
A link to a bill format or a bill format reference.
Show Source
Nested Schema : presentationMedia
Type: array
The bill presentation media associated with the bill structure.
Show Source
Nested Schema : Bill Presentation Media Ref Or Value
Type: object
Title: Bill Presentation Media Ref Or Value
A link to a bill presentation media or bill presentation media reference.
Show Source
Nested Schema : Contact
Type: object
Title: Contact
An individual or an organization used as a contact point for an account.
Show Source
Nested Schema : contactMedium
Type: array
The ways to reach the contact.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : Contact Medium
Type: object
Title: Contact Medium
The way to reach a contact.
Show Source
Nested Schema : Medium Characteristic
Type: object
Title: Medium Characteristic
The characteristics that define a contact medium.
Show Source
Nested Schema : Payment Plan
Type: object
Title: Payment Plan
A payment plan, where a party spreads an overall payment into multiple smaller payments.
Show Source
Nested Schema : Account Tax Exemption
Type: object
Title: Account Tax Exemption
The account's proof of exemption from a tax.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Notified

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Title: Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
Back to Top

Examples

The following example shows how to update an account based on a PartyAccountAttributeValueChangeEvent notification by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/accountManagement/version/listener/PartyAccountAttributeValueChangeEvent' -d @updateEvent.json

Example of Request Body

The following is an example of the contents of the updateEvent.json file sent as the request body. 

{
    "eventId": "570a209b-5169-48fc-8439-2a6447162f30",
    "eventTime": "2025-04-19T12:23:14.330Z",
    "eventType": "PartyAccountAttributeValueChangeEvent",
    "correlationId": "15678900",
    "domain": null,
    "title": null,
    "description": null,
    "priority": null,
    "timeOcurred": null,
    "event": {
        "partyAccount": {
            "@type": "PartyAccountOracle",
            "id": "account-1",
            "href": "http://host:port/cx/industry/buying/tmf-api/accountManagement/v4/account/88-20ULWI",
            "accountType": "residential",
            "name": "Sam Malone",
            "state": "inactive",
            "accountRelationship": [
                {
                    "relationshipType": "Customer",
                    "account": {
                        "id": "88-20ULU0",
                        "href": "http://host:port/cx/industry/buying/tmf-api/customerManagement/v4/customer/88-20ULU0",
                        "@referredType": "Customer"
                    }
                }
            ],
            "billStructure": {
                "cycleSpecification": {
                    "id": "billinfo-1",
                    "frequency": "yearly",
                    "billingDateShift": "10",
                    "isRef": true,
                    "name": "Monthly billing"
                },
                "format": {
                    "isRef": true,
                    "name": "detail"
                },
                "presentationMedia": [
                    {
                        "isRef": true,
                        "name": "paper"
                    }
                ]
            },
            "contact": [
                {
                    "@type": "ContactOracle",
                    "contactName": "Sam Malone",
                    "contactType": "primary",
                    "contactMedium": [                     
                        {
                            "@type": "ContactMediumOracle",
                            "mediumType": "postalAddress",
                            "city": "Burlington",
                                "contactType": "billingAddress",
                                "country": "USA",
                                "phoneNumber": "",
                                "postCode": "01803",
                                "stateOrProvince": "MA",
                                "street1": "10 Van de Graaff Drive",
                                "street2": ""
                            },
                            "id": "88-1WZOD0"
                        },
                        {
                            "@type": "ContactMedium",
                            "mediumType": "emailAddress",
                            "characteristic": {
                                "contactType": "homeEmailAddress",
                                "emailAddress": "samwise@example.com"
                            }
                        }
                    ]
                },
                {
                    "@type": "ContactOracle",
                    "contactType": "secondary",
                    "contactMedium": [                     
                        {
                            "@type": "ContactMediumOracle",
                            "mediumType": "postalAddress",
                            "characteristic": {
                                "city": "Burlington",
                                "contactType": "shippingAddress",
                                "country": "USA",
                                "phoneNumber": "",
                                "postCode": "01803",
                                "stateOrProvince": "MA",
                                "street1": "95 Network Drive",
                                "street2": ""
                            }
                        },
                        {
                            "@type": "ContactMedium",
                            "mediumType": "emailAddress",
                            "characteristic": {
                                "contactType": "homeEmailAddress",
                                "emailAddress": "samwise@example.com"
                            }
                        }
                    ]
                }
            ],
            "relatedParty": [
                {
                    "id": "88-20ULRN",
                    "href": "http://host:port/cx/industry/buying/tmf-api/party/v4/individual/88-20ULRN",
                    "@referredType": "Individual"
                }
            ],
            "@baseType": "PartyAccount",
            "accountNumber": "1618814528362",
            "username": "sam_malone1"
        }
    }
}

When the account is updated successfully, the only response is a 201 status code.

Back to Top