Skip to main content
Aria Knowledge Central

get_transaction_information_m

  1. Last updated
  2. Save as PDF

Description

Gets transactional details for all accounts matching specified query.

Inputs

Name Type Length Required Description
username string 30 No DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool.
password string 1000 No DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool.
client_no long 12 Yes Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
limit long 12 No The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
offset long 12 No The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.
query_string string 1000 Yes The criteria which all returned objects must match. Different objects have a different set of searchable criteria. Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".

Querystring Keys

Key Name Description
aria_event_no The Aria assigned ID for the event.
transaction_date  
transaction_type  
transaction_type_no  
is_charge_type

Allowed values:

Value Description
0 
1 
type_specific_id e.g. payment_id for electronic payments, invoice_no for invoices, etc
acct_no The Aria assigned ID of the account.
user_id The client defined user_id for the account.
amount  
aria_statement_no Aria assigned ID of the statement related to this transaction
update_date Date transaction was last updated.
fully_applied_date Date transaction was fully offset by another transaction
master_plan_instance_no The Master Plan Instance assigned to the account

Outputs

Name Type Length Required Description
error_code long   No Aria-assigned error identifier. 0 indicates no error
error_msg string   No Textual description of any error that occurred. "OK" if there was no error.
starting_record long   No This indicates the number of objects that were (or would be) skipped before beginning output.
total_records long   No This is the total number of objects that matched the provided criteria.
Start of transaction_information hash
transaction_information hash   No List of transaction_information associated with this method.
Name Type Length Required Description
▶aria_event_no long   No The Aria assigned ID for the event.
▶transaction_date string   No  
▶transaction_type string   No  
▶transaction_type_no long   No  
▶is_charge_type long   No

Allowed values:

Value Description
0 
1 
▶type_specific_id long   No e.g. payment_id for electronic payments, invoice_no for invoices, etc
▶acct_no long   No The Aria assigned ID of the account.
▶user_id string   No The client defined user_id for the account.
▶client_acct_id string   No The client defined account ID for the account.
▶amount double   No  
▶currency_cd string   No  
▶aria_statement_no long   No Aria assigned ID of the statement related to this transaction
▶total_amount_applied double   No Total amount applied to any transactions. Does not apply to all transaction types.
▶related_amount_applied double   No Always null. Place holder for related_transaction objects below.
▶update_date string   No Date transaction was last updated.
▶void_date string   No Void date of any voided transaction associated with the specified event ID number. Example: Void date of an invoice.
▶fully_applied_date string   No Date transaction was fully offset by another transaction
▶master_plan_instance_no long   No The Master Plan Instance assigned to the account
Start of related_transaction hash
▶related_transaction hash   No List of related_transaction associated with this method.
Name Type Length Required Description
▶▶aria_event_no long   No The Aria assigned ID for the event.
▶▶transaction_date string   No  
▶▶transaction_type string   No  
▶▶transaction_type_no long   No  
▶▶is_charge_type long   No

Allowed values:

Value Description
0 
1 
▶▶type_specific_id long   No e.g. payment_id for electronic payments, invoice_no for invoices, etc
▶▶acct_no long   No The Aria assigned ID of the account.
▶▶amount double   No  
▶▶currency_cd string   No  
▶▶aria_statement_no long   No Aria assigned ID of the statement related to this transaction
▶▶total_amount_applied double   No Total amount applied to any other transactions
▶▶related_amount_applied double   No Amount applied to this transaction
▶▶update_date string   No Date transaction was last updated.
▶▶void_date string   No Void date of related transactions associated with the specified event ID number. Example: Void date of a payment.
▶▶fully_applied_date string   No Date transaction was fully offset by another transaction
▶▶master_plan_instance_no long   No The Master Plan Instance assigned to the account
▶▶related_amount double   No Amount applied to this transaction. Duplicate of related_amount_applied.
End of related_transaction hash
End of transaction_information hash
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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