Home > Aria Crescendo Documentation > Aria Crescendo core api > get_family_trans_history_m
get_family_trans_history_m
get_family_trans_history_m
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.
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. |
|
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. | ||
 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 |
|---|---|---|
| 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 | |
| acct_no |
long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| master_plan_instance_no |
long | Aria generated unique identifier for the master plan instance. |
| client_master_plan_instance_id |
string | Client-defined unique identifier for the master plan instance. |
| transaction_id |
long | The unique identifier for this particular transaction |
| transaction_type |
long | A numeric code for which type of transaction this is Allowable Values |
| transaction_desc |
string | The long description of this transaction |
| transaction_amt |
double | The total amount of this transaction line |
| transaction_applied_amt |
double | The total amount of this transaction applied to the account |
| transaction_currency |
string | The currency this transaction was recorded in. |
| transaction_create_date |
string | The creation date of this transaction |
| transaction_void_date |
string | The date this transaction was voided |
| transaction_stmt_no |
long | The statement ID of the statement this transaction was printed on, if any |
| transaction_void_reason |
string | The reason code for why this transaction was voided, if it was voided |
| client_receipt_id |
string | The client-defined receipt ID for this transaction, provided in the API call which created this transaction |
| 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 an external system ID |
| credit_reason_code_description |
string | If this transaction is a credit, the description of the credit reason |
| csr_comments |
string | If a CSR initiated this transaction and they entered comments in the UI, they will be displayed here |
| transaction_seq_stmt_id |
string | The unique sequential statement number. |
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. |
- © Copyright 2021 Aria Developer Central