Financial Transactions Class Event Fields
This article lists the fields included in Financial Transactions Class Event payloads.
| Field Name | Description |
|---|---|
| account | Container for account identification information associated with the financial transactions. |
| acct_no | Aria-assigned numeric account identifier for the customer. |
| action | Indicates which action caused the provisioning request, where "A" means add and "M" means modify. |
| apf2doc | Root element containing the full Account Transactions event notification document payload. |
| applied_amount | Monetary amount applied from one transaction toward another. |
| applied_trans_id | Identifier of the transaction that receives the applied amount. |
| applied_trans_type_label | Text label describing the type of transaction receiving the applied amount. |
| applied_trans_type_no | Numeric transaction type code of the transaction receiving the applied amount. |
| auth_key | Client-specific authentication key used to validate the notification or request source. |
| billing_group_name | Descriptive name of the billing group. |
| billing_group_no | Aria-assigned numeric identifier for the billing group. |
| charge_event_no | Identifier of the specific charge event associated with a failed payment. |
| charge_trans_id (application) | Identifier of the charge transaction to which an amount is applied. |
| charge_trans_id (unapplication) | Identifier of the charge transaction from which an amount has been unapplied. |
| charge_trans_type_label | Text label describing the charge transaction type in the application record. |
| charge_trans_type_label (unapplication) | Text label describing the charge transaction type in the unapplication record. |
| charge_trans_type_no | Numeric transaction type code for the charge transaction in the application record. |
| charge_trans_type_no (unapplication) | Numeric transaction type code for the charge in the unapplication record. |
| class | Identifies the type of data being sent; for this schema only "T" (financial transaction) is allowed. |
| client_acct_id | Client-defined external account identifier associated with the Aria account. |
| client_billing_group_id | Client-defined identifier for the billing group. |
| client_installment_term_id | Client-defined identifier for the installment term used for the charge. |
| client_installment_term_id (failed payment) | Client-defined identifier for the installment term of a failed collection. |
| client_no | Aria-assigned numeric client identifier. |
| client_payment_plan_id | Client-defined identifier for the payment plan associated with the failed payment charge. |
| client_plan_instance_id | Client-defined identifier for the master plan instance. |
| client_receipt_id | Client-defined receipt identifier used to correlate Aria notifications with client-side records. |
| client_threshold_billing_rule_id | Client-defined identifier for the threshold billing rule. |
| currency_amount | Threshold currency amount used by the billing rule for this invoice. |
| event | Represents a single event entry associated with the notification. |
| event_data | Container for event codes and labels describing the type of financial transaction event. |
| event_id | Numeric identifier of the event type. |
| event_label | Text label describing the event type in human-readable form. |
| failed_payment_charge_data | Container for details of charges associated with failed payments. |
| failed_payment_charge_events | Repeating element listing individual failed payment charge events tied to the transaction. |
| financial_trans_amount | Monetary amount of the financial transaction. |
| financial_trans_application | Represents a single application of an amount from one transaction to another. |
| financial_trans_applied_amount | Portion of the transaction amount that has been applied to charges or invoices. |
| financial_trans_appln_data | Container for application details showing how the financial transaction amount was applied to other transactions. |
| financial_trans_client_notes | Client-entered notes or comments associated with the transaction. |
| financial_trans_date | Date on which the financial transaction occurred or was posted. |
| financial_trans_gl_type | Code representing the general ledger category or type for the transaction. |
| financial_trans_granular_id | Identifier of the granular financial transaction line or component. |
| financial_trans_id | Aria-assigned identifier for the summarized financial transaction (if applicable). |
| financial_trans_inv_type_cd | Code identifying the invoice type related to the transaction, when applicable. |
| financial_trans_status_desc | More detailed description of the financial transaction status. |
| financial_trans_status_label | Text label describing the current status of the financial transaction, such as pending or posted. |
| financial_trans_type_label | Text label describing the financial transaction type. |
| financial_trans_type_no | Numeric code identifying the type of financial transaction, such as charge, credit, or payment. |
| financial_trans_unapplication | Represents a single unapplication event where amounts are removed from previously applied charges. |
| financial_trans_unappln_data | Container for details of amounts that were unapplied from previous applications. |
| financial_transaction | Represents a single financial transaction or transaction component in the account. |
| financial_transaction_group | Represents a single group of financial transactions sharing the same billing group or object context. |
| financial_transaction_groups | Container for groups of related financial transactions, typically organized by billing group. |
| financial_transactions | Container for individual financial transaction records included in the event. |
| future_manual_allocation | Indicator or note that a remaining amount will be manually allocated in the future. |
| installment_no | Installment number for charges billed under an installment plan. |
| installment_no (failed payment) | Installment number for failed charges for an installment plan. |
| invoice | Container for summary invoice information related to the financial transactions in the event. |
| invoice_no | Aria-assigned numeric identifier of the invoice. |
| invoice_no (application) | Invoice number associated with the application of the transaction amount. |
| invoice_no (failed payment) | Invoice number linked to the failed payment charge event. |
| invoice_no (unapplication) | Invoice number associated with the unapplication event. |
| invoice_type_cd | Code indicating the type of invoice, such as standard bill or adjustment. |
| master_plan_instance_data | Repeating element containing details for a single master plan instance on the account. |
| master_plan_instances | Container for one or more master plan instances tied to the account. |
| object_no | Numeric identifier of the associated object (for example, account number or plan instance number). |
| object_type | Type of object associated with the financial transaction group, such as account or plan instance. |
| payment_plan_no | Aria-assigned identifier for the payment plan associated with the failed payment charge. |
| payment_trans_id | Identifier of the payment transaction providing the applied amount. |
| plan_instance_no | Aria-assigned identifier for the master plan instance. |
| posting_date | Date on which the transactions were posted. |
| posting_info | Container describing posting status and posting audit information for the transactions. |
| posting_status_cd | Code indicating the posting status of the transaction set, such as posted or unposted. |
| posting_user | User identifier of the person or process that posted the transactions. |
| request | Container for metadata about the provisioning request, including version, sender, transaction details, and authentication information. |
| resp_level_cd | Code indicating the responsibility level of the plan instance within an account hierarchy. |
| resp_plan_instance_no | Identifier of the plan instance that is financially responsible for this plan instance, when applicable. |
| sender | Identifies the sender of the provisioning request; valid values are "A" for Aria and "C" for Client, currently effectively fixed as "A" for outbound notifications. |
| senior_acct_no | Identifier of the parent or senior account when the account is part of a hierarchy. |
| sequential_statement_id (application) | Client-visible sequential statement identifier associated with the application. |
| sequential_statement_id (failed payment) | Client-facing sequential statement identifier for the failed payment event. |
| sequential_statement_id (unapplication) | Client-facing sequential statement ID associated with the unapplication. |
| statement_no | Statement number associated with the failed payment charge event. |
| threshold_billing_rule | Container describing the threshold billing rule applied to this invoice, if any. |
| threshold_billing_rule_no | Aria-assigned identifier of the threshold billing rule. |
| total_amount | Total monetary amount of all financial transactions in this group. |
| transaction_id | Aria-assigned unique provisioning request identifier. |
| unapplied_amount | Monetary amount that has been unapplied from a charge or invoice. |
| userid | User identifier associated with the account, typically a login or customer ID. |
| version | Aria-assigned version number of this provisioning request's document format; for this schema the value is fixed at 3.5. |