Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_trans_history_m

get_acct_trans_history_m

Returns a list of financial transactions associated with an account. You can filter the transactions using criteria such as master plan instance, transaction type, date range, or statement number.

For information on error messages generated by this API, see get_acct_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 account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The unique identifier for the master plan instance. A unique identifier for the master plan instance entered in this field will retrieve transaction history for the account specific to the master plan instance identifier entered. A null value in this field will retrieve ALL transaction history for the account.
  OR      
  client_master_plan_instance_id string 100 The unique client-defined identifier for the master plan instance. A unique client-defined identifier for the master plan instance entered in this field will retrieve transaction history for the account specific to the client-defined master plan instance identifier entered. A null value in this field will retrieve ALL transaction history for the account.
  transaction_type long 8 Transaction type to search account history for.  

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
  start_date string 10 Specifies a start date for transactions to be retrieved. A null value in this field retrieves ALL transactions to a specified end_date. The date is in the format yyyy-mm-dd.
  end_date string 10 Specifies an end date for transactions to be retrieved. A null value in this field retrieves ALL transactions from the specified start_date. The date is in the format yyyy-mm-dd.
  record_limit long 3

Restricts the number of records returned  to a minimum of 1 and a maximum of 999.

The records will be returned in descending order by <transaction_id>.

Example: You have an account that has 4 transactions with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only transactions 456 and 567 will be returned.

If you don't pass a value into this field, then it will default to 99.
  filter_statement_no long 22

Statement number filter to use when querying for account transaction history.

The outputs will include the transactions and invoice number associated with the specified <filter_statement_no>.
  filter_seq_statement_id string 22

Statement sequence identifier filter to use when querying for account transaction history.

The outputs will include the transactions and invoice number associated with the specified <filter_seq_statement_id>.
  include_void_transactions string   Allows whether or not to include void transactions.  

Allowable values for include_void_transactions

Values Description
true true
false false
  offset long 30

Specifies the number of records to skip in the customer’s transaction history.

The records will be skipped in descending order by <transaction_id>.

Example: You have an account that has 4 transactions with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only transactions 123 and 234 will be returned.

If you don't pass a value into this field, then it will default to 0.
  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
history hash  
brd_arrow.gif transaction_id long The globally-unique ID for this transaction across all transactions
brd_arrow.gif transaction_type long The numeric code for the type of transaction being returned.  

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 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_desc string The long description of this transaction
brd_arrow.gif transaction_amount double The amount of this transaction
brd_arrow.gif transaction_applied_amount double The amount of this transaction actually applied to the account balance, if different than above
brd_arrow.gif transaction_currency string The currency this transaction was recorded in
brd_arrow.gif transaction_create_date string The creation datetime of this transaction
brd_arrow.gif transaction_void_date string If this transaction was voided, the void datetime
brd_arrow.gif statement_no long The ID of the statement on which this transaction appears, if any
brd_arrow.gif transaction_void_reason string A human-readable reason for this transaction to be voided, if any
brd_arrow.gif client_receipt_id string Client-defined unique identifier used to track related system actions
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 The reason for the credit this transaction represents
brd_arrow.gif csr_comments string CSR-generated comments for this transaction line, if any
brd_arrow.gif seq_statement_id string The unique sequential statement number.

brd_arrow.gif invoice_no

 long The Aria-assigned unique identifier of a given invoice.
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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®