Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_transaction_information_m

get_transaction_information_m

Gets transactional details for all accounts matching specified query.

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 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". 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".
  username string 30 Deprecated The 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 Deprecated The 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 Date on which a transaction took place.
transaction_type_no

Aria-assigned identifier for this type of transaction

Allowable values for transaction_type_no:

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 Out-of-band Electronic Credit
-7 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 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
24 Credit memo line
-24 Voided credit memo line
transaction_type

Description of the transaction type.

You can obtain the list of of transaction types by calling the list_transaction_types_m API.
is_charge_type

The type of financial transaction

Allowable values for is_charge_type:

Values Description
0 credit
1 charge
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 The monetary value that applies to the transaction.
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 Detailed transaction information for any accounts matching the query
brd_arrow.gif aria_event_no long The Aria assigned ID for the event.
brd_arrow.gif transaction_date string Date on which a transaction took place.
brd_arrow.gif transaction_type_no string

Aria-assigned identifier for this type of transaction

Allowable values for transaction_type_no:

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 Out-of-band Electronic Credit
-7 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_type long

Description of the transaction type

You can obtain the list of of transaction types by calling the list_transaction_types_m API.
brd_arrow.gif is_charge_type long

The type of financial transaction

Allowable values for is_charge_type:

Values Description
0 credit
1 charge
brd_arrow.gif type_specific_id long e.g. payment_id for electronic payments, invoice_no for invoices, etc
brd_arrow.gif acct_no long The Aria assigned ID of the account.
brd_arrow.gif user_id string The client defined user_id for the account.
brd_arrow.gif client_acct_id string The client defined account ID for the account.
brd_arrow.gif amount double The monetary value that applies to a transaction.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code for monetary values involved in a transaction
brd_arrow.gif aria_statement_no long Aria assigned ID of the statement related to this transaction
brd_arrow.gif total_amount_applied double Total amount applied to any transactions. Does not apply to all transaction types.
brd_arrow.gif related_amount_applied double Always null. Place holder for related_transaction objects below.
brd_arrow.gif update_date string Date transaction was last updated.
brd_arrow.gif void_date string Void date of any voided transaction associated with the specified event ID number. Example: Void date of an invoice.
brd_arrow.gif fully_applied_date string Date transaction was fully offset by another transaction
brd_arrow.gif master_plan_instance_no long The Master Plan Instance assigned to the account
brd_arrow.gif related_transaction hash

List of the activities or items that apply to a transaction. 

Examples: payments or credits that paid off an invoice transaction or invoices settled by a payment transaction.
brd_arrow.gif aria_event_no long The Aria assigned ID for the event.
brd_arrow.gif transaction_date string Date on which a transaction took place.
brd_arrow.gif transaction_type_no string

Aria-assigned identifier for this type of transaction

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 Out-of-band Electronic Credit
-7 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 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
24 Credit memo line
-24 Voided credit memo line
brd_arrow.gif transaction_type long

Description of the transaction type.

You can obtain the list of of transaction types by calling the list_transaction_types_m API.
brd_arrow.gif is_charge_type long

The type of financial transaction

Allowable values for is_charge_type:

Values Description
0 credit
1 charge
brd_arrow.gif type_specific_id long e.g. payment_id for electronic payments, invoice_no for invoices, etc
brd_arrow.gif acct_no long The Aria assigned ID of the account.
brd_arrow.gif amount double The monetary value that applies to a transaction.
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code for monetary values involved in a transaction
brd_arrow.gif aria_statement_no long Aria assigned ID of the statement related to this transaction
brd_arrow.gif total_amount_applied double Total amount applied to any other transactions
brd_arrow.gif related_amount_applied double Amount applied to this transaction
brd_arrow.gif update_date string Date transaction was last updated.
brd_arrow.gif void_date string Void date of related transactions associated with the specified event ID number. Example: Void date of a payment.
brd_arrow.gif fully_applied_date string Date transaction was fully offset by another transaction
brd_arrow.gif master_plan_instance_no long The master plan instance assigned to the account
brd_arrow.gif related_amount double Amount applied to this transaction. Duplicate of related_amount_applied.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®