This page provides the list of events and associated payloads for the Accounts microservice.
Page Contents
List of Events
SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
---|---|---|---|---|---|---|
1 | Account Created | This event is triggered when an account is created. | Topic: ecomm | accounts.createaccount | false | CreateOrUpdateAccount |
2 | Account Updated | This event is triggered when an account is updated. | Topic: ecomm | accounts.updateccount | false | CreateOrUpdateAccount |
3 | Account Buyer Created | This event is triggered when an account buyer is created. | Topic: ecomm | accounts.createaccountbuyer | false | CreateOrUpdateAccountBuyer |
4 | Account Buyer Updated | This event is triggered when an account buyer is updated. | Topic: ecomm | accounts.updateaccountbuyer | false | CreateOrUpdateAccountBuyer |
5 | Account Seller Created | This event is triggered when an account seller is created. | Topic: ecomm | accounts.createaccountseller | false | CreateOrUpdateAccountSeller |
6 | Account Seller Updated | This event is triggered when an account seller is updated. | Topic: ecomm | accounts.updateaccountseller | false | CreateOrUpdateAccountSeller |
7 | Contract Created | This event is triggered when a contract is created. | Topic: ecomm | accounts.createcontract | false | CreateOrUpdateContract |
8 | Contract Updated | This event is triggered when a contract is updated. | Topic: ecomm | accounts.updatecontract | false | CreateOrUpdateContract |
Payload Models
Below are the payloads for the Accounts microservice events:
CreateOrUpdateAccount
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
id | long | Indicates the unique ID of the account. | 1 |
collectionId | long | Indicates the unique ID of the collection. | 1 |
name | String | Indicates the name of the account. | Account_1 |
size | String | Refers to the count of the employees in the account. | 100 |
typeId | long | Indicates the unique ID of the account type. | 1 |
accountType | String | Indicates the name of the account type. | testaccounttype |
status | long | Refers to the status of the account. | active |
parentAccountId | long | Refers to the ID of the parent account under which this account is associated. | 1 |
createdTime | Date | Indicates the timestamp of the created account. | 1543923953856 |
updatedTime | Date | Indicates the timestamp of the updated account. | 1543923953856 |
properties[].id | long | Indicates the unique ID of the property. | 1 |
properties[].name | String | Indicates the name of the property. | accountProperty |
properties[].value | String | Refers to the value of an account property, which is associated with a particular name of the account property. | value |
properties[].accountId | long | Indicates the unique ID of the account. | 1 |
CreateOrUpdateAccountBuyer
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
teamId | String | Indicates the unique ID of the team. | 1 |
userId | long | Indicates the unique ID of the buyer user. | 1 |
CreateOrUpdateAccountSeller
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
accountId | String | Indicates the unique ID of the existing account, which is to be associated with the account seller. | 1 |
userId | long | Indicates the unique ID of the seller user. | 1 |
CreateOrUpdateContract
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
catalogId | String | Indicates the ID of the catalog, which is associated with this contract. | 10011 |
creditLimit | double | Refers to the maximum credit limit of amount, which is allocated for an account. | 10000 |
endTime | long | Refers to the end period of the contract. | 144256 |
name | String | Indicates the name of the contract. | Contract1 |
paymentMethod | String | Indicates the method of payment. | creditcard |
paymentTermId | long | Indicates the valid ID of the existing payment term. | 1 |
priceListId | String | Indicates the ID of the price list, which is a collection ID of pricing. | 1001 |
startTime | long | Refers to the start time of the contract. | 134256 |
status | String | Refers to the status of the contract. | ACTIVE |
Revision History
2019-05-16 | AN – Updated to a new table tool.
2019-04-11 | MA – Updated content and format.
2019-01-18 | PLK – Content uploaded.