Home > Aria Crescendo Documentation > Aria Crescendo core api > 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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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      
required-icon.png 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 for do_multi_level:

Values Description
true true
false false (default)
  trans_type long 12 Valid transaction type to use when searching family transaction history.  

Allowable values for trans_type:

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
  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 for include_void_transactions:

Values Description
true true
false false
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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  
brd_arrow.gif acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif master_plan_instance_no long Aria generated unique identifier for the master plan instance.
brd_arrow.gif client_master_plan_instance_id string Client-defined unique identifier for the master plan instance.
brd_arrow.gif transaction_id long The unique identifier for this particular transaction
brd_arrow.gif transaction_type long A numeric code for which type of transaction this is  

Allowable values for transaction_type:

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
brd_arrow.gif transaction_desc string The long description of this transaction
brd_arrow.gif transaction_amt double The total amount of this transaction line
brd_arrow.gif transaction_applied_amt double The total amount of this transaction applied to the account
brd_arrow.gif transaction_currency string The currency this transaction was recorded in.
brd_arrow.gif transaction_create_date string The creation date of this transaction
brd_arrow.gif transaction_void_date string The date this transaction was voided
brd_arrow.gif transaction_stmt_no long The statement ID of the statement this transaction was printed on, if any
brd_arrow.gif transaction_void_reason string The reason code for why this transaction was voided, if it was voided
brd_arrow.gif client_receipt_id string The client-defined receipt ID for this transaction, provided in the API call which created this transaction
brd_arrow.gif transaction_comments string Client-defined comments on this transaction
brd_arrow.gif transaction_source_id long A code defining the originating source of the transaction, such as a write-off number, payment ID, etc.
brd_arrow.gif transaction_ref_code 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:

  • External payment's reference code
  • Outgoing payment's reference code
  • External refund check number
brd_arrow.gif credit_reason_code_description string If this transaction is a credit, the description of the credit reason
brd_arrow.gif csr_comments string If a CSR initiated this transaction and they entered comments in the UI, they will be displayed here
brd_arrow.gif transaction_seq_stmt_id string The unique sequential statement number.
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®