Skip to main content
Aria Knowledge Central

get_family_trans_history_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_family_trans_history_m
Class account_services_m
Update Version 6.33

Description

This API can be used to return the transaction history of parent, and child accounts.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
parent_acct_no long 22 Yes

The parent account for this child account. Designating a parent account number implies the account holder is under a parent account umbrella.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: parent_acct_no
master_plan_instance_no long 22 No

Aria generated unique identifier for the master plan instance

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined unique identifier for the master plan instance

Alternative field: master_plan_instance_no
do_multi_level string 5 No

Allow multi-level account hierarchies.

Allowed values:

Value Description
True  
False  
trans_type long 8 No

Valid transaction type to use when searching family transaction history.

Allowed values:

Value 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
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
start_date string 10 No

Specifies start date. The date is in the format yyyy-mm-dd
end_date string 10 No

Specifies end date. The date is in the format yyyy-mm-dd
record_limit long 12 No

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 No

Allows whether or not to include void transactions.

Allowed values:

Value Description
True  
False  

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
fam_transactions object   No

See fields below

fam_transactions fields

Name Type Length Required Description
acct_no long   No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
master_plan_instance_no long 22 No

Aria generated unique identifier for the master plan instance.
client_master_plan_instance_id string 100 No

Client-defined unique identifier for the master plan instance.
transaction_id long   No

The unique identifier for this particular transaction
transaction_type long 3 No

A numeric code for which type of transaction this is

Allowed values:

Value 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
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
transaction_desc string   No

The long description of this transaction
transaction_amt double   No

The total amount of this transaction line
transaction_applied_amt double   No

The total amount of this transaction applied to the account
transaction_currency string   No

The currency this transaction was recorded in.
transaction_create_date string   No

The creation date of this transaction
transaction_void_date string   No

The date this transaction was voided
transaction_stmt_no long   No

The statement ID of the statement this transaction was printed on, if any
transaction_void_reason string   No

The reason code for why this transaction was voided, if it was voided
client_receipt_id string 50 No

The client-defined receipt ID for this transaction, provided in the API call which created this transaction
transaction_comments string   No

Client-defined comments on this transaction
transaction_source_id long   No

A code defining the originating source of the transaction, such as a write-off number, payment ID, etc.
transaction_ref_code string   No

External reference code for this transaction, such as a check number or an external system ID
credit_reason_code_description string   No

If this transaction is a credit, the description of the credit reason
csr_comments string   No

If a CSR initiated this transaction and they entered comments in the UI, they will be displayed here
transaction_seq_stmt_id string   No

The unique sequential statement number.
invoice_no long 22 No

The Aria-assigned unique identifier of a given invoice.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.