Home > Aria6 User Documentation > Aria6 core api > get_acct_trans_history
get_acct_trans_history
get_acct_trans_history
Returns a list of financial transactions associated with an account. You can filter the transactions using criteria such as transaction type, date range, or statement number.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
|
account_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts.. |
| transaction_type | long | 8 | Transaciton type to search account history for. Allowable Values | |
| start_date | string | 14 | Specifies start date. The date is in the format yyyy-mm-dd | |
| end_date | string | 14 | Specifies end date. The date is in the format yyyy-mm-dd | |
| record_limit | long | 12 | This is the maximum number of records to retrieve from the query. | |
| filter_statement_no | long | 22 | Statement number filter to use when querying for account transaction history. | |
| include_void_transactions | string | 5 | Allows whether or not to include void transactions. Allowable Values | |
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| history | hash | |
| transaction_id |
long | The globally-unique ID for this transaction across all transactions |
| transaction_type |
long | The numeric code for the type of transaction being returned. Allowable Values |
| transaction_desc |
string | The long description of this transaction |
| transaction_amount |
double | The amount of this transaction |
| transaction_applied_amount |
double | The amount of this transaction actually applied to the account balance, if different than above |
| transaction_currency |
string | The currency this transaction was recorded in |
| transaction_create_date |
string | The creation datetime of this transaction |
| transaction_void_date |
string | If this transaction was voided, the void datetime |
| statement_no |
long | The ID of the statement on which this transaction appears, if any |
| transaction_void_reason |
string | A human-readable reason for this transaction to be voided, if any |
| client_receipt_id |
string | Client-defined unique identifier used to track related system actions |
| transaction_comments |
string | Client-defined comments on this transaction |
| transaction_source_id |
long | A code defining the originating source of the transaction, such as a write-off number, payment ID, etc |
| transaction_ref_code |
string | External reference code for this transaction, such as a check number or external reference code |
| credit_reason_code_description |
string | The reason for the credit this transaction represents |
| csr_comments |
string | CSR-generated comments for this transaction line, if any |
| seq_statement_id |
string | The unique sequential statement number. |
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
- © Copyright 2021 Aria Developer Central