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



 

Home > Aria Crescendo core api > get_payment_application_dtls_m

get_payment_application_dtls_m

Returns the list of invoices on which the payment has been applied. Also returns the invoice line item details related to the payment application.

For error message generated by this API, see get_payment_application_dtls_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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png transaction_id long 22 Payment transaction ID for which the application details are to be retrieved.
  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
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.
payment_application_details hash An Array of account payment application details.
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif invoice_date string Specifies Invoice Date. The date is in the format yyyy-mm-dd
brd_arrow.gif invoice_from_date string Specifies Invoice From Date. The date is in the format yyyy-mm-dd
brd_arrow.gif invoice_to_date string Specifies Invoice To Date. The date is in the format yyyy-mm-dd.
brd_arrow.gif invoice_pay_applied_amount double Specifies the payment amount applied on the invoice by this transaction.
brd_arrow.gif invoice_overall_paid_amount double Specifies the total payment amount applied on the invoice by all transactions.
brd_arrow.gif invoice_charge double Specifies the Invoice Charge Amount
brd_arrow.gif invoice_credit double Specifies the Invoice Credit Amount.
brd_arrow.gif invoice_bal_due double Specifies the Invoice Balance Amount.
brd_arrow.gif applied_transactions hash Array of specific invoice transactions that the payment was applied to.
brd_arrow.gif transaction_id long Id of the specific invoice transaction.
brd_arrow.gif original_amount double Original amount of the transaction.
brd_arrow.gif amount_applied double Amount of the payment applied to the transaction.
brd_arrow.gif date_applied string Payment application date.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.