This API can be used to return the transaction history of parent and child accounts.
For information on error messages generated by this API, see get_family_trans_history_m Error Messages.
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. |
![]() |
parent_acct_no | long | 22 | The parent account for this child account. Designating a parent account number implies the account holder is a under a parent account umbrella. |
OR | ||||
![]() |
client_acct_id | string | 50 | Client-defined account identifier. |
master_plan_instance_no | long | 22 | Aria generated unique identifier for the master plan instance | |
OR | ||||
client_master_plan_instance_id | string | 100 | Client-defined unique identifier for the master plan instance | |
do_multi_level | string | 5 | Allow multi-level account hierarchies. Allowable Values | |
trans_type | long | 12 | Valid transaction type to use when searching family transaction history. Allowable Values | |
start_date | string | 10 | Specifies start date. The date is in the format yyyy-mm-dd | |
end_date | string | 10 | 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. When not specified, the default limit is 99. | |
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. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description |
---|---|---|
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. |
fam_transactions | hash | |
![]() |
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
![]() |
long | Aria generated unique identifier for the master plan instance. |
![]() |
string | Client-defined unique identifier for the master plan instance. |
![]() |
long | The unique identifier for this particular transaction |
![]() |
long | A numeric code for which type of transaction this is Allowable Values |
![]() |
string | The long description of this transaction |
![]() |
double | The total amount of this transaction line |
![]() |
double | The total amount of this transaction applied to the account |
![]() |
string | The currency this transaction was recorded in. |
![]() |
string | The creation date of this transaction |
![]() |
string | The date this transaction was voided |
![]() |
long | The statement ID of the statement this transaction was printed on, if any |
![]() |
string | The reason code for why this transaction was voided, if it was voided |
![]() |
string | The client-defined receipt ID for this transaction, provided in the API call which created this transaction |
![]() |
string | Client-defined comments on this transaction |
![]() |
long | A code defining the originating source of the transaction, such as a write-off number, payment ID, etc. |
![]() |
string |
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:
|
![]() |
string | If this transaction is a credit, the description of the credit reason |
![]() |
string | If a CSR initiated this transaction and they entered comments in the UI, they will be displayed here |
![]() |
string | The unique sequential statement number. |
![]() |
long | The Aria-assigned unique identifier of a given invoice. |