Home > Aria Crescendo Documentation > Aria Crescendo core api > get_payment_application_dtls_m

get_payment_application_dtls_m

Table of contents

Input Arguments
Output Arguments

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

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.
invoice_no	long	The Aria-assigned unique identifier of a given invoice.
invoice_date	string	Specifies Invoice Date. The date is in the format yyyy-mm-dd
invoice_from_date	string	Specifies Invoice From Date. The date is in the format yyyy-mm-dd
invoice_to_date	string	Specifies Invoice To Date. The date is in the format yyyy-mm-dd.
invoice_pay_applied_amount	double	Specifies the payment amount applied on the invoice by this transaction.
invoice_overall_paid_amount	double	Specifies the total payment amount applied on the invoice by all transactions.
invoice_charge	double	Specifies the Invoice Charge Amount
invoice_credit	double	Specifies the Invoice Credit Amount.
invoice_bal_due	double	Specifies the Invoice Balance Amount.
applied_transactions	hash	Array of specific invoice transactions that the payment was applied to.
transaction_id	long	Id of the specific invoice transaction.
original_amount	double	Original amount of the transaction.
amount_applied	double	Amount of the payment applied to the transaction.
date_applied	string	Payment application date.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.

© Copyright 2023 Aria Developer Central

Powered by CXone Expert ®