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

 

Home > Aria Crescendo core api > get_unapplied_credits_payments_m

get_unapplied_credits_payments_m

Retrieves the payments and cash credits that are unapplied for a given account.

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.
acct_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.
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.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
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.
unapplied_payments hash
payment_transaction_id long Aria generated ID for the payment transaction
payment_amount double Total amount of the payment
unapplied_amount double Unapplied portion of the payment amount
cash_credit_transaction_id long Aria generated ID for the cash credit transaction
cash_credit_amount double Total amount of the cash credit
unapplied_cash_credit double Unapplied portion of the cash credit

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.