Skip to main content
Aria Knowledge Central

get_acct_trans_history_m Guide

Returns a list of financial transactions associated with an account. You can filter the transactions using criteria such as master plan instance, transaction type, date range, or statement number.

API Specification: get_acct_trans_history_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <account_no> or <client_acct_id>

Additional Guidance

Input Fields
Field Name: Notes:
<record_limit>

Restricts the number of records returned to a minimum of 1 and a maximum of 999.

The records will be returned in descending order by <transaction_id>.

Example: You have an account that has 4 transactions with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only transactions 456 and 567 will be returned.

If you don't pass a value into this field, then it will default to 99.

<offset>

The records will be skipped in descending order by <transaction_id>.

Example: You have an account that has 4 transactions with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only transactions 123 and 234 will be returned.

If you don't pass a value into this field, then it will default to 0.

<transaction_type>
Allowable values
Values 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
7 (Deprecated) Out-of-band Electronic Credit
-7 (Deprecated) Voided Out-of-band Electronic Credit
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 Disbursement
-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
24 Credit memo line
-24 Voided credit memo line
<include_void_transactions>
Allowable values
Values Description
true true
false false

Output Fields

Field Name: Notes:
<transaction_ref_code>

The check number or external reference code. This also displays the reference code/check number for an outgoing payment/external refund for an account (for transaction type 13 ("Check Refund Disbursement/Voided Check Refund Disbursement").

The following three values can be provided for transaction type 13:

  • External payment's reference code
  • Outgoing payment's reference code
  • External refund check number
<transaction_type>
Allowable values
Values 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
7 (Deprecated) Out-of-band Electronic Credit
-7 (Deprecated) Voided Out-of-band Electronic Credit
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
24 Credit memo line
-24 Voided credit memo line

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error

 

1004: authentication error

<auth_key>, <client_no>

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

<account_no>, <client_acct_id>

14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".

Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.

<master_plan_instance_id>

14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".

<client_master_plan_instance_id>

1033:  a parameter that represents a true or false value contains invalid input

<include_void_transactions>

5067: limit must be between 1 and 999.

<record_limit>

5068: offset must be greater than or equal to zero.

<offset>

18003: statement could not be found

 
  • Was this article helpful?