Skip to main content
Aria Knowledge Central

get_acct_trans_history_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_trans_history_m
Class account_services_m
Update Version 33

Description

Retrieves the financial transaction history for a specified account, including all charges, payments, credits, adjustments, write-offs, and voids. Results can be filtered by master plan instance, transaction type (e.g., invoice charges, payments, service credits), date range, or statement number. Returns transaction IDs, amounts, dates, types, and descriptions. Use this for account ledger displays, financial reconciliation, or audit trail review.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
account_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: account_no
master_plan_instance_no long 22 No

The unique identifier for the master plan instance. A unique identifier for the master plan instance entered in this field will retrieve transaction history for the account specific to the master plan instance identifier entered. A null value in this field will retrieve ALL transaction history for the account.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

The unique client defined identifier for the master plan instance. A unique client defined identifier for the master plan instance entered in this field will retrieve transaction history for the account specific to the client defined master plan instance identifier entered. A null value in this field will retrieve ALL transaction history for the account.

Alternative field: master_plan_instance_no
transaction_type long 3 No

Transaction type to search account history for.

Allowed values:

Value Description
1 Invoice
-1 Voided Invoice
2 check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursementt
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 reinstated Charge transaction
-16 voided reinstated Charge transaction
17 reinstated Payment transaction
-17 voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 voided 3rd party payment
20 3rd party payment refund
-20 voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
start_date string 10 No

Specifies a start date for transactions to be retrieved. A null value in this field retrieves ALL transactions to a specified end date. The date is in the format yyyy-mm-dd.
end_date string 10 No

Specifies an end date for transactions to be retrieved. A null value in this field retrieves ALL transactions from the specified start_date. The date is in the format yyyy-mm-dd.
record_limit long 12 No

Limits the number of records returned by the API. When not specified, the default limit is 99
filter_statement_no long 22 No

Statement number filter to use when querying for account transaction history.
include_void_transactions string 5 No

Allows whether or not to include void transactions.

Allowed values:

Value Description
True  
False  
filter_seq_statement_id string 22 No

Statement sequence id filter to use when querying for account transaction history.
offset long 10 No

The number of records to skip. Min of 0. If no value specified the default is 0.

Outputs

Name Type Length Required Description
history object   No

See fields below
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.

history fields

Name Type Length Required Description
transaction_id long   No

The globally-unique ID for this transaction across all transactions
transaction_type long 3 No

The numeric code for the type of transaction being returned.

Allowed values:

Value Description
1 Invoice
-1 Voided Invoice
2 check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursementt
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 reinstated Charge transaction
-16 voided reinstated Charge transaction
17 reinstated Payment transaction
-17 voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 voided 3rd party payment
20 3rd party payment refund
-20 voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
transaction_desc string   No

The long description of this transaction
transaction_amount double   No

The amount of this transaction
transaction_applied_amount double   No

The amount of this transaction actually applied to the account balance, if different than above
transaction_currency string   No

The currency this transaction was recorded in
transaction_create_date string   No

The creation datetime of this transaction
transaction_void_date string   No

If this transaction was voided, the void datetime
statement_no long   No

The ID of the statement on which this transaction appears, if any
transaction_void_reason string   No

A human-readable reason for this transaction to be voided, if any
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions
transaction_comments string   No

Client-defined comments on this transaction
transaction_source_id long   No

A code defining the originating source of the transaction, such as a write-off number, payment ID, etc.
transaction_ref_code string   No

External reference code for this transaction, such as a check number or external reference code
credit_reason_code_description string   No

The reason for the credit this transaction represents
csr_comments string   No

CSR-generated comments for this transaction line, if any
seq_statement_id string   No

The unique sequential statement number.
invoice_no long 22 No

The Aria-assigned unique identifier of a given invoice.
transaction_remaining_amount double   No

The remaining unapplied amount of the transaction (transaction amount minus applied amount).
client_payment_plan_id string   No

The client-defined identifier of the payment plan associated with this transaction, if any.
payment_plan_no long   No

The Aria-assigned payment plan number associated with this transaction, if any.
payment_plan_status string   No

Specifies the status of payment plan (active, completed, or cancelled).
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.