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

Create an Account from a PartyAccountCreateEvent Notification

post

/listener/partyAccountCreateEvent

Creates an account based on a PartyAccountCreateEvent notification.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : Party Account Create Event
Type: object
Title: Party Account Create Event
An event for creating a party account with given attributes.
Show Source
Nested Schema : Party Account Create Event Payload
Type: object
Title: Party Account Create Event Payload
The payload for PartyAccountCreateEvent.
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
A base / value business entity used to represent money.
Show Source
Nested Schema : Payment Method Ref
Type: object
Title: Payment Method Ref
A reference to a payment method.
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 : TimePeriod
Type: object
A period of time.
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
A reference to an account.
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
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 : accountBalance
Type: array
The account's balances.
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
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to create an account based on a PartyAccountCreateEvent 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/partyAccountCreateEvent' -d @createEvent.json

Example of Request Body

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

{
    "eventId": "570a209b-5169-48fc-8439-2a6447162f30",
    "eventTime": "2021-04-19T12:23:14.330Z",
    "eventType": "PartyAccountCreateEvent",
    "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": "active",
            "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": "monthly",
                    "billingDateShift": "1",
                    "isRef": true,
                    "name": "Monthly billing"
                },
                "format": {
                    "isRef": true,
                    "name": "detail"
                },
                "presentationMedia": [
                    {
                        "isRef": true,
                        "name": "electronic"
                    },
                    {
                        "isRef": true,
                        "name": "paper"
                    }
                ]
            },
            "contact": [
                {
                    "@type": "ContactOracle",
                    "contactName": "Sam Malone",
                    "contactType": "primary",
                    "contactMedium": [
                        {
                            "@type": "ContactMediumOracle",
                            "mediumType": "postalAddress",
                            "characteristic": {
                                "city": "Burlington",
                                "contactType": "shippingAddress",
                                "country": "USA",
                                "phoneNumber": "",
                                "postCode": "01803",
                                "stateOrProvince": "MA",
                                "street1": "95 Network Drive",
                                "street2": ""
                            },
                        },
                        {
                            "@type": "ContactMediumOracle",
                            "mediumType": "postalAddress",
                            "characteristic": {
                                "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": "sam@example.com"
                            }
                        },
                         {
                            "@type": "ContactMedium",
                            "mediumType": "phoneNumber",
                            "characteristic": {
                                "phoneNumber": "781 555 0100"
                            }
                        }
                    ]
                }
            ],
            "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 created successfully, the only response is a 201 status code.

Back to Top