Accounts and Master Plan Instances Event Fields
This article lists the fields included in Account and Master Plan Instance event payloads.
This article lists the fields included in Accounts and Master Plan Instances event payloads.
| Field Name | Definition |
|---|---|
| acct_no | Aria-assigned account identifier |
| action | Identifies which action caused the event notification request. "A"=add, "M"=modify, "D"=delete |
| address1 | Contact address line 1 |
| address2 | Contact address line 2 |
| address3 | Contact address line 3 |
| auth_key | Client-specific authentication key |
| bank_acct_suffix | Bank account suffix |
| bank_branch_cd | Bank branch code |
| bank_country_cd | Bank country code |
| bank_id_cd | Bank ID code |
| bank_routing_no | Bank routing number |
| bank_swift_cd | Bank SWIFT code |
| bban_suffix | BBAN suffix |
| bill_agreement_id | Billing agreement ID (e.g., PayPal) |
| bill_day | Billing day of month |
| billing_group_name | Billing group name |
| billing_group_no | Aria-assigned billing group number |
| bkup_payment_method_no | Backup payment method number |
| cc_exp_mm | Credit card expiration month |
| cc_exp_yyyy | Credit card expiration year |
| cc_suffix | Credit card suffix (last 4 digits) |
| cell_phone | Contact cell phone |
| charge_list | List of charges in payment plan |
| city | Contact city |
| class_name | Identifies the type of data being sent. "A"=account and MPI, "O"=order, "T"=financial transaction, "N"=account and MPI notification, "U"=usage monitoring. |
| client_acct_id | Client-defined account identifier |
| client_billing_group_id | Client-defined billing group identifier |
| client_bkup_pymt_method_id | Client-defined backup payment method ID |
| client_dunning_group_id | Client-defined dunning group ID |
| client_installment_term_id | Client-defined installment term ID |
| client_master_plan_instance_id | Client-defined master plan instance ID |
| client_no | Aria-assigned client identifier |
| client_payment_method_id | Client-defined payment method ID |
| client_payment_plan_id | Client-defined payment plan ID |
| client_payment_term_id | Client-defined payment term ID |
| client_plan_id | Client-defined plan ID |
| client_plan_instance_id | Client-defined supplemental plan instance ID |
| client_plan_unit_inst_id | Client-defined plan unit instance ID |
| client_primary_pymt_method_id | Client-defined primary payment method ID |
| client_receipt_id | Client receipt identifier (optional) |
| client_service_id | Client-defined service ID |
| client_threshold_billing_rule_id | Client-defined threshold billing rule ID |
| company_name | Contact company name |
| contract_duration_length | Contract duration length |
| contract_duration_type | Contract duration type |
| contract_end_date | Contract end date |
| contract_no | Contract number |
| contract_renewal_duration_length | Contract renewal duration length |
| contract_renewal_duration_type | Contract renewal duration type |
| contract_renewal_end_date | Contract renewal end date |
| contract_start_date | Contract start date |
| contract_status | Contract status code |
| contract_type | Contract type code |
| country | Contact country |
| coupon_assignment_level | Coupon assignment level |
| coupon_assignment_no | Coupon assignment number |
| coupon_cd | Coupon code |
| created_date | Plan instance creation date |
| currency | Account currency |
| currency_amount | Threshold billing currency amount |
| dunning_group_name | Dunning group name |
| dunning_group_no | Dunning group number |
| dunning_state | Current dunning state |
| dunning_step | Current dunning step |
| dunning_step_description | Description of current dunning step |
| ean_gln_number | EAN/GLN number |
| ean_gln_requisition_number | EAN/GLN requisition number |
| Contact email address | |
| event_id | ID of the event that triggered this notification |
| event_label | Label/description of the triggering event |
| fax | Contact fax number |
| field_name | Supplemental field name (used in acct, mpi, spi, unit instance supplemental fields) |
| field_value | Supplemental field value |
| first_name | Contact first name (appears in acct_contact, statement_contact, billing_contact) |
| first_payment_plan_due_date | First payment plan due date |
| fulfillment_date | Service fulfillment date |
| fulfillment_status | Service fulfillment status |
| iban_suffix | IBAN suffix |
| installment_no | Installment number |
| installment_status | Installment status |
| invoice_list | List of invoices in payment plan |
| invoice_no | Associated invoice number for installment |
| last_acct_comment | Last comment recorded on the account, includes both user generated and system generated comments |
| last_bill_date | Last billing date |
| last_name | Contact last name |
| locality | Contact locality |
| mandate_id | SEPA mandate ID |
| master_plan_instance_no | Aria-assigned master plan instance number |
| middle_initial | Contact middle initial |
| mpi_bill_lag_days | Bill lag days for the master plan instance |
| mpi_list | List of master plan instances in payment plan |
| mpi_port_queue_id | MPI porting queue ID |
| next_bill_date | Next scheduled billing date |
| next_dunning_date | Next scheduled dunning date |
| notify_method | Notification method code |
| notify_tmplt_group_assign_lvl | Notification template group assignment level |
| notify_tmplt_group_id | Notification template group identifier |
| notify_tmplt_group_label | Notification template group label |
| password | Account password |
| pay_method | Payment method type code |
| payment_method_no | Payment method number |
| payment_plan_bg_no | Associated billing group number for payment plan |
| payment_plan_interval | Payment plan interval |
| payment_plan_length | Payment plan length |
| payment_plan_no | Payment plan number |
| payment_plan_period_type | Payment plan period type |
| payment_plan_status | Payment plan status |
| payment_plan_status_change_date | Payment plan status change date |
| payment_terms_desc | Payment terms description |
| payment_terms_name | Payment terms name |
| payment_terms_no | Payment terms number |
| phone | Contact phone number |
| phone_ext | Contact phone extension |
| pin | Account PIN |
| plan_activation_date | Plan activation date |
| plan_date | Plan assignment date |
| plan_instance_no | Supplemental plan instance number |
| plan_name | Plan name |
| plan_no | Plan number (master or supplemental) |
| plan_queue_type | Type of queued plan change |
| plan_termination_date | Plan termination date |
| plan_unit_inst_no | Plan unit instance number |
| plan_unit_inst_status | Plan unit instance status |
| plan_units | Number of plan units |
| postal_code | Contact postal/ZIP code |
| primary_payment_method_no | Primary payment method number for the billing group |
| promo_cd | Promotion/coupon code |
| prov_reason_cd | Provisioning reason code |
| queued_status_cd | Queued status code for future plan changes |
| queued_status_change_date | Date when queued status change takes effect |
| queued_units | Queued number of plan units |
| recurring_bill_thru_date | Recurring billing through date |
| recurring_payment_amount | Recurring payment amount |
| resp_level_cd | Responsibility level code |
| resp_plan_instance_no | Responsible plan instance number |
| secret_answer | Secret answer for account recovery |
| secret_question | Secret question for account recovery |
| sender | Identifies the sender of the event notification request. Valid values are "A"=Aria or "C"=Client. Currently only outbound requests from Aria-to-clients are supported, so the value of this field is effectively currently fixed as "A". |
| senior_acct_no | Parent (senior) account number for child accounts |
| service_name | Service name |
| service_no | Service number |
| source_acct_no | Source account number for MPI porting |
| source_client_master_plan_instance_id | Source client master plan instance ID for porting |
| source_master_plan_instance_no | Source master plan instance number for porting |
| state_prov | Contact state or province |
| status_cd | Account status code |
| status_cd | Plan instance status code (also used for account) |
| status_change_date | Installment status change date |
| status_date | Status change date |
| test_acct | Identifies whether or not this is a test account. "Y"=yes/true, "N"=no/false |
| threshold_billing_rule_no | Threshold billing rule number |
| transaction_id | Aria-assigned event notification request ID. |
| transistion_from_plan | Plan number transitioning from |
| transistion_to_plan | Plan number transitioning to |
| units_change_date | Date when unit count changes |
| usage_bill_thru_date | Usage billing through date |
| userid | Account user ID |
| version | Aria-assigned version number of this event notification request's document format. Value in this version of the XML document is fixed at "4.0". Note that as of version 3.0, the data typed changed from "int" to "decimal". |
| work_phone | Contact work phone |
| work_phone_ext | Contact work phone extension |