Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 object query api > get_transaction_information

get_transaction_information

Gets transactional details for all accounts matching specified query.

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.
query_string string 1000 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". 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".
username string 30 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 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.
limit long 12 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 The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.

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
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

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error
error_msg string Textual description of any error that occurred. "OK" if there was no error.
starting_record long This indicates the number of objects that were (or would be) skipped before beginning output.
total_records long This is the total number of objects that matched the provided criteria.
transaction_information hash
aria_event_no long The Aria assigned ID for the event.
transaction_date string
transaction_type string
transaction_type_no long
is_charge_type long   Allowable Values
type_specific_id long e.g. payment_id for electronic payments, invoice_no for invoices, etc
acct_no long The Aria assigned ID of the account.
user_id string The client defined user_id for the account.
client_acct_id string The client defined account ID for the account.
amount double
currency_cd string
aria_statement_no long Aria assigned ID of the statement related to this transaction
total_amount_applied double Total amount applied to any transactions. Does not apply to all transaction types.
related_amount_applied double Always null. Place holder for related_transaction objects below.
update_date string Date transaction was last updated.
void_date string Void date of any voided transaction associated with the specified event ID number. Example: Void date of an invoice.
fully_applied_date string Date transaction was fully offset by another transaction
master_plan_instance_no long The Master Plan Instance assigned to the account
related_transaction hash
aria_event_no long The Aria assigned ID for the event.
transaction_date string
transaction_type string
transaction_type_no long
is_charge_type long   Allowable Values
type_specific_id long e.g. payment_id for electronic payments, invoice_no for invoices, etc
acct_no long The Aria assigned ID of the account.
amount double
currency_cd string
aria_statement_no long Aria assigned ID of the statement related to this transaction
total_amount_applied double Total amount applied to any other transactions
related_amount_applied double Amount applied to this transaction
update_date string Date transaction was last updated.
void_date string Void date of related transactions associated with the specified event ID number. Example: Void date of a payment.
fully_applied_date string Date transaction was fully offset by another transaction
master_plan_instance_no long The Master Plan Instance assigned to the account
related_amount double Amount applied to this transaction. Duplicate of related_amount_applied.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.